docs: state that .gitignore is not consulted, with the ignore key as the exclusion list - #326
Open
MaximeGaudin wants to merge 2 commits into
Open
MaximeGaudin wants to merge 2 commits into
MaximeGaudin wants to merge 2 commits into
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
.gitignorewas never consulted, so a git-ignored build/output directory was linted by default, and nothing said why.ignorecrate (a new dependency tree the repo does not currently carry), or document the tradeoff. This PR takes the documented-tradeoff option the issue names: the README and the config docs now state that.gitignoreis not read and that theignorekey is the exclusion list, with a**/build-output/**example..gitignore(for example by adopting theignorecrate) cannot land silently; the test and the docs must be updated together.Fixes #37
Test plan
./scripts/check.sh, JS included)