fix: ignore gitignore patterns with unmatched trailing backslashes - #143
Open
SergiPantoja wants to merge 1 commit into
Open
fix: ignore gitignore patterns with unmatched trailing backslashes#143SergiPantoja wants to merge 1 commit into
SergiPantoja wants to merge 1 commit 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.
While using pathspec in a downstream project, I noticed that patterns ending in an unmatched trailing backslash behave differently from Git.
Git documents that a backslash at the end of a gitignore pattern is invalid and never matches:
https://git-scm.com/docs/gitignore#_pattern_format
In testing with Git 2.55.0, Git also continues processing subsequent valid rules after encountering such a pattern.
Currently, both
GitIgnoreSpec.from_lines()andPathSpec.from_lines("gitignore", ...)raiseGitIgnorePatternErrorwhile compiling an unmatched trailing backslash. Because the pattern list is compiled together, this also prevents later valid patterns from being used.For example, given these .gitignore bytes:
b"fileA\\\n*.log\n"Git 2.55.0 treats the first rule as non-matching and still applies the second:
Before this change, both Specs instead fail immediately:
Fix:
GitIgnoreBasicPatternandGitIgnoreSpecPattern.Tests:
Ran the test suite locally:
Ran 219 tests in 0.045s OK (skipped=372)The behavior was also compared directly against
git check-ignoreusing Git 2.55.0.