-
-
Notifications
You must be signed in to change notification settings - Fork 841
feat: add use_gitignore option to exclude ignored files from sources/generates #2773
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vmaerten
wants to merge
8
commits into
main
Choose a base branch
from
git-ignore
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
fe542d5
feat: add gitignore option to exclude ignored files from sources/gene…
vmaerten ae3627c
refactor: replace go-git with sabhiram/go-gitignore for lighter depen…
vmaerten 13ef1b2
wip
vmaerten 7cea8e3
refactor: remove rootDir param, auto-detect .git as boundary
vmaerten 7705f92
rename: gitignore -> use_gitignore for clarity
vmaerten de99487
style: fix formatting
vmaerten 70fe293
refactor: replace sabhiram/go-gitignore with vendored go-git matcher
vmaerten 7d92de8
Apply suggestions from code review
vmaerten File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| package fingerprint | ||
|
|
||
| import ( | ||
| "bufio" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "github.com/go-task/task/v3/internal/gitignore" | ||
| ) | ||
|
|
||
| type gitignoreRule struct { | ||
| dir string | ||
| matcher gitignore.Matcher | ||
| } | ||
|
|
||
| // loadGitignoreRules walks up from dir collecting .gitignore files. | ||
| // Stops at the first .git (file or directory) found. | ||
| // Returns nil if no .git is found (not in a git repo). | ||
| func loadGitignoreRules(dir string) []gitignoreRule { | ||
| dir, _ = filepath.Abs(dir) | ||
|
|
||
| var rules []gitignoreRule | ||
| foundGit := false | ||
| current := dir | ||
|
|
||
| for { | ||
| lines := readGitignoreLines(filepath.Join(current, ".gitignore")) | ||
| if len(lines) > 0 { | ||
| patterns := make([]gitignore.Pattern, 0, len(lines)) | ||
| for _, line := range lines { | ||
| patterns = append(patterns, gitignore.ParsePattern(line, nil)) | ||
| } | ||
| rules = append(rules, gitignoreRule{ | ||
| dir: current, | ||
| matcher: gitignore.NewMatcher(patterns), | ||
| }) | ||
| } | ||
| if _, err := os.Stat(filepath.Join(current, ".git")); err == nil { | ||
| foundGit = true | ||
| break | ||
| } | ||
| parent := filepath.Dir(current) | ||
| if parent == current { | ||
| break | ||
| } | ||
| current = parent | ||
| } | ||
|
|
||
| if !foundGit { | ||
| return nil | ||
| } | ||
|
|
||
| return rules | ||
| } | ||
|
|
||
| func readGitignoreLines(path string) []string { | ||
| f, err := os.Open(path) | ||
| if err != nil { | ||
| return nil | ||
| } | ||
| defer f.Close() | ||
|
|
||
| var lines []string | ||
| scanner := bufio.NewScanner(f) | ||
| for scanner.Scan() { | ||
| line := strings.TrimRight(scanner.Text(), "\r") | ||
| if line != "" && !strings.HasPrefix(line, "#") { | ||
| lines = append(lines, line) | ||
| } | ||
| } | ||
| if err := scanner.Err(); err != nil { | ||
| return nil | ||
| } | ||
| return lines | ||
| } | ||
|
|
||
| // filterGitignored removes entries from the file map that match gitignore rules. | ||
| func filterGitignored(files map[string]bool, dir string) map[string]bool { | ||
| rules := loadGitignoreRules(dir) | ||
| if len(rules) == 0 { | ||
| return files | ||
| } | ||
|
|
||
| for path := range files { | ||
| for _, rule := range rules { | ||
| relPath, err := filepath.Rel(rule.dir, path) | ||
| if err != nil || strings.HasPrefix(relPath, "..") { | ||
| continue | ||
| } | ||
| // Sources are files, not directories; pass isDir=false. Per the | ||
| // gitignore spec this still matches files under an ignored dir | ||
| // (e.g. "build/" matches build/out.txt). | ||
| if rule.matcher.Match(strings.Split(filepath.ToSlash(relPath), "/"), false) { | ||
| files[path] = false | ||
| break | ||
| } | ||
| } | ||
|
Comment on lines
+85
to
+98
|
||
| } | ||
|
|
||
| return files | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| package fingerprint | ||
|
|
||
| import ( | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/go-task/task/v3/taskfile/ast" | ||
| ) | ||
|
|
||
| func initGitRepo(t *testing.T, dir string) { | ||
| t.Helper() | ||
| require.NoError(t, os.MkdirAll(filepath.Join(dir, ".git"), 0o755)) | ||
| } | ||
|
|
||
| func TestGlobsWithGitignore(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| dir := t.TempDir() | ||
| initGitRepo(t, dir) | ||
|
|
||
| require.NoError(t, os.WriteFile(filepath.Join(dir, "included.txt"), []byte("included"), 0o644)) | ||
| require.NoError(t, os.WriteFile(filepath.Join(dir, "ignored.log"), []byte("ignored"), 0o644)) | ||
| require.NoError(t, os.WriteFile(filepath.Join(dir, "also-included.txt"), []byte("also included"), 0o644)) | ||
| require.NoError(t, os.WriteFile(filepath.Join(dir, ".gitignore"), []byte("*.log\n"), 0o644)) | ||
|
|
||
| globs := []*ast.Glob{ | ||
| {Glob: "./*"}, | ||
| } | ||
|
|
||
| filesWithout, err := Globs(dir, globs, false) | ||
| require.NoError(t, err) | ||
|
|
||
| filesWith, err := Globs(dir, globs, true) | ||
| require.NoError(t, err) | ||
|
|
||
| hasLog := false | ||
| for _, f := range filesWithout { | ||
| if filepath.Base(f) == "ignored.log" { | ||
| hasLog = true | ||
| break | ||
| } | ||
| } | ||
| assert.True(t, hasLog, "ignored.log should be present without gitignore filter") | ||
|
|
||
| hasLog = false | ||
| for _, f := range filesWith { | ||
| if filepath.Base(f) == "ignored.log" { | ||
| hasLog = true | ||
| break | ||
| } | ||
| } | ||
| assert.False(t, hasLog, "ignored.log should be excluded with gitignore filter") | ||
|
|
||
| txtCount := 0 | ||
| for _, f := range filesWith { | ||
| if filepath.Ext(f) == ".txt" { | ||
| txtCount++ | ||
| } | ||
| } | ||
| assert.Equal(t, 2, txtCount, "both .txt files should remain") | ||
| } | ||
|
|
||
| func TestGlobsWithGitignoreNested(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| dir := t.TempDir() | ||
| initGitRepo(t, dir) | ||
|
|
||
| subDir := filepath.Join(dir, "sub") | ||
| require.NoError(t, os.MkdirAll(subDir, 0o755)) | ||
|
|
||
| require.NoError(t, os.WriteFile(filepath.Join(subDir, "keep.txt"), []byte("keep"), 0o644)) | ||
| require.NoError(t, os.WriteFile(filepath.Join(subDir, "build.out"), []byte("build"), 0o644)) | ||
|
|
||
| require.NoError(t, os.WriteFile(filepath.Join(dir, ".gitignore"), []byte("*.log\n"), 0o644)) | ||
| require.NoError(t, os.WriteFile(filepath.Join(subDir, ".gitignore"), []byte("*.out\n"), 0o644)) | ||
|
|
||
| globs := []*ast.Glob{ | ||
| {Glob: "./*"}, | ||
| } | ||
|
|
||
| files, err := Globs(subDir, globs, true) | ||
| require.NoError(t, err) | ||
|
|
||
| for _, f := range files { | ||
| assert.NotEqual(t, "build.out", filepath.Base(f), "build.out should be excluded by nested .gitignore") | ||
| } | ||
| } | ||
|
|
||
| func TestGlobsWithGitignoreNoRepo(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| // Cannot use t.TempDir() here because it creates a dir inside the | ||
| // go-task repo which has a .git parent, defeating the "no repo" test. | ||
| dir, err := os.MkdirTemp("", "task-gitignore-norepo-*") //nolint:usetesting | ||
| require.NoError(t, err) | ||
| t.Cleanup(func() { os.RemoveAll(dir) }) | ||
|
|
||
| require.NoError(t, os.WriteFile(filepath.Join(dir, "file.txt"), []byte("content"), 0o644)) | ||
|
|
||
| globs := []*ast.Glob{ | ||
| {Glob: "./*"}, | ||
| } | ||
|
|
||
| files, err := Globs(dir, globs, true) | ||
| require.NoError(t, err) | ||
| assert.Len(t, files, 1) | ||
| } |
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
filterGitignoredloads.gitignorerules only based on the task/basedir(vialoadGitignoreRules(dir)), so glob matches that live in subdirectories won't respect.gitignorefiles inside those subdirectories (e.g. sources like./**/*). To match Git behavior, rule discovery needs to be based on each matched file’s directory (and its parents up to the repo root), ideally with caching to avoid repeated filesystem walks.