[ENH] Do explicitly "allow" for having dotfiles and explicitly ignore them #1992
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Up to this point it was up for a validator to "code" that up. E.g. current new deno based validator in https://github.com/bids-standard/bids-validator/blob/main/src/files/ignore.ts has const defaultIgnores = [ '.git**', '.*', 'sourcedata/', ... thus ignores all dotfiles from validation. But this is inconsistent e.g. with shipped in bids-specification schematools treatment, where files in a dotdirectory were reported as "invalid": ❯ cat /tmp/input.txt | python -m bidsschematools pre-receive-hook .datalad/config .gitattributes sub-01/anat/sub-01_unknown.nii.gz And as demonstrated above there could be legit "system" dotfiles (VCS related etc) which are part of the folder containing BIDS dataset, I think we should **explicitly** describe position of BIDS in relation to the dotfiles. As it is pretty much "ignore", that is what this PR is intended to state. In this PR I also adjusted `pre_receive_hook` to ignore dotfiles. The `find_files` was already ignoring them.
yarikoptic
requested review from
DimitriPapadopoulos and
erdalkaraca
as code owners
effigies
approved these changes
Dec 17, 2024
Collaborator
effigies
left a comment
effigies
left a comment
There was a problem hiding this comment.
I think this is reasonable.
Remi-Gau
approved these changes
Dec 18, 2024
Collaborator
|
Do we want to consider a schema addition, or leave it as an instruction to implementations? |
Collaborator
|
Merging. Can consider schema later. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Up to this point it was up for a validator to "code" that up. E.g. current new deno based validator in
https://github.com/bids-standard/bids-validator/blob/main/src/files/ignore.ts has
thus ignores all dotfiles from validation. But this is inconsistent e.g. with shipped in bids-specification schematools treatment, where files in a dotdirectory were reported as "invalid":
And as demonstrated above there could be legit "system" dotfiles (VCS related etc) which are part of the folder containing BIDS dataset, I think we should explicitly describe position of BIDS in relation to the dotfiles. As it is pretty much "ignore", that is what this PR is intended to state.
In this PR I also adjusted
pre_receive_hookto ignore dotfiles. Thefind_fileswas already ignoring them.