Add GitIgnore utility for gitignored-and-untracked checks#7215
Merged
Add GitIgnore utility for gitignored-and-untracked checks#7215
Conversation
Add a shared utility in rewrite-core that checks whether a file is matched by .gitignore rules AND is not tracked in the git index. This addresses the fact that three separate codebases (rewrite-polyglot, rewrite-gradle-plugin, rewrite-maven-plugin) each had their own implementation of this check, with varying degrees of correctness. The utility uses JGit's TreeWalk with both FileTreeIterator and DirCacheIterator to match git's own behavior: .gitignore has no effect on files that are already tracked.
timtebeek
approved these changes
Mar 31, 2026
github-project-automation
bot
moved this from In Progress
to Ready to Review
in OpenRewrite
sambsnyd
approved these changes
Mar 31, 2026
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
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.
Adds
org.openrewrite.internal.GitIgnorewith a staticisIgnoredAndUntracked(Repository, String)method that checks whether a file matches.gitignorerules AND is not tracked in the git index.Both rewrite-gradle-plugin and rewrite-maven-plugin had their own inline implementations of this check with identical bugs. This shared utility provides a single correct implementation using JGit's
DirCacheIteratorto consult the index, matching git's own behavior:.gitignorehas no effect on tracked files.