Add flag to disable nested ignores #257
Open
Conversation
This file contains 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
|
Running the ignore benchmark with nested ignores enabled vs. disabled (with an increased scale for emphasis) gave me the following comparison: |
Codecov Report
@@ Coverage Diff @@
## main #257 +/- ##
==========================================
- Coverage 93.76% 93.45% -0.32%
==========================================
Files 23 23
Lines 818 840 +22
==========================================
+ Hits 767 785 +18
- Misses 30 33 +3
- Partials 21 22 +1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
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.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Feature
What is the current behavior?
Nested ignores are currently enabled by default, which has the potential to cause performance issues in very large repositories (even when they have no nested ignores). See issue #239 for more on this.
What is the new behavior (if this is a feature change)?
As this is related to an already released feature, the safest bet is to add the following flag to opt-out:
--disable-nested-ignores. This should match the original behavior of only checking for top-level ignore-files (i.e. nested ignore-files should no longer be considered when using this flag).Does this PR introduce a breaking change? (What changes might users need to make due to this PR?)
No
Other information:
Another PR should follow this one, attempting to address the performance issues with nested ignores turned on.
Let me know your thoughts on this!