Skip to content

Commit 950bdf7

Browse files
authored
Merge pull request #349 from suyashdb/readme_configfile
Readme config file example for ignoredFiles
2 parents c82f006 + 71800c8 commit 950bdf7

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,21 @@ The basic configuration format is outlined below. All configuration is optional.
5757
"ignoredFiles": []
5858
}
5959

60-
`ignoredFiles` takes a list of file paths or glob patterns you'd like to ignore.
60+
`ignoredFiles` takes a list of file paths or glob patterns you'd like to ignore. Lets say we want to ignore all files and sub-directory under `/derivatives/`.
61+
62+
{
63+
"ignoredFiles": ["/derivatives/**"]
64+
}
65+
66+
Note that adding two stars `**` in path makes validator recognize all files and sub-dir to be ignored.
6167

6268
`ignore`, `warn`, and `error` take lists of issue codes or issue keys and change the severity of those issues so they are either ignored or reported as warnings or errors. You can find a list of all available issues at [utils/issues/list](https://github.com/INCF/bids-validator/tree/master/utils/issues/list.js).
6369

6470
Some issues may be ignored by default, but can be elevated to warnings or errors. These provide a way to check for common things that are more specific than BIDS compatibility. An example is a check for the presence of a T1w modality. The following would raise an error if no T1W image was found in a dataset.
6571

66-
{
67-
"error": ["NO_T1W"]
68-
}
72+
{
73+
"error": ["NO_T1W"]
74+
}
6975

7076
In addition to issue codes and keys these lists can also contain objects with and "and" or "or" properties set to arrays of codes or keys. These allow some level of conditional logic when configuring issues. For example:
7177

0 commit comments

Comments
 (0)