Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

schema: add check for duplicate READMEs #1952

Merged
merged 3 commits into from
Oct 11, 2024
Merged

schema: add check for duplicate READMEs #1952

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0eb5aa7
schema: add check for duplicate READMEs
sappelhoff Oct 11, 2024
5b10c00
Update src/schema/rules/checks/general.yaml
effigies Oct 11, 2024
1455398
Update src/schema/rules/checks/general.yaml
effigies Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion src/schema/rules/checks/general.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,18 @@ ReadmeFileSmall:
Please consider expanding it with additional information about the dataset.
level: warning
selectors:
- match(path, '^/README')
- match(path, '^/README.*')
effigies marked this conversation as resolved.
Show resolved Hide resolved
checks:
- size > 150

DuplicateReadmes:
issues:
effigies marked this conversation as resolved.
Show resolved Hide resolved
code: MULTIPLE_README_FILES
message: |
There are multiple '/README' files (with different extensions) in this BIDS
dataset. Only one '/README' file should exist.
level: error
selectors:
- match(path, '^/README.*')
checks:
- exists(["README", "README.md", "README.rst", "README.txt"], "dataset") == 1
Loading