refactor: switch Globber/GitIgnore to use fs.FS

alecthomas · alecthomas · commit 4a20bb7fc291 · 2023-10-03T13:35:26.000+08:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,8 +15,8 @@ jobs:
         uses: cashapp/activate-hermit@v1
       - name: Test
         run: go test ./...
-  lint:
-    name: Lint
+  sum-types:
+    name: Check Exhaustive Type Switch
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -25,3 +25,13 @@ jobs:
         uses: cashapp/activate-hermit@v1
       - name: golangci-lint
         run: golangci-lint run
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Init Hermit
+        uses: cashapp/activate-hermit@v1
+      - name: go-check-sumtype
+        run: go-check-sumtype ./...
diff --git a/engine/engine.go b/engine/engine.go
@@ -88,7 +88,7 @@ func Compile(logger *logging.Logger, bitfile *parser.Bitfile) (*Engine, error) {
 			"CWD": {Pos: bitfile.Pos, Body: cwd},
 		},
 	}
-	engine.globber, err = internal.NewGlobber(cwd, engine.Outputs)
+	engine.globber, err = internal.NewGlobber(os.DirFS(cwd), engine.Outputs)
 	if err != nil {
 		return nil, err
 	}
diff --git a/engine/internal/gitignore.go b/engine/internal/gitignore.go
@@ -2,18 +2,17 @@ package internal
 
 import (
 	"bufio"
-	"os"
+	"io/fs"
 	"path"
-	"path/filepath"
 	"strings"
 )
 
-func LoadGitIgnore(dir string) []string {
+func LoadGitIgnore(root fs.FS, dir string) []string {
 	ignore := []string{
 		"**/.*",
 		"**/.*/**",
 	}
-	r, err := os.Open(filepath.Join(dir, ".gitignore"))
+	r, err := root.Open(path.Join(dir, ".gitignore"))
 	if err != nil {
 		return nil
 	}
diff --git a/engine/internal/glob.go b/engine/internal/glob.go
@@ -11,35 +11,36 @@ import (
 
 // Globber is a file globber that respects .gitingore files.
 type Globber struct {
-	dir    string
 	ignore []string
 	files  []string
 	// Doesn't cache outputs
 	cache   map[string][]string
 	outputs func() []string
 }
 
-// NewGlobber creates a new Globber for the given directory.
+// NewGlobber creates a new Globber for the given fs.FS.
 //
 // The "outputs" function is called to provide additional files to be
 // considered when globbing. This is used for files output by the
 // build process.
-func NewGlobber(root string, outputs func() []string) (*Globber, error) {
-	ignore := LoadGitIgnore(root)
+func NewGlobber(root fs.FS, outputs func() []string) (*Globber, error) {
+	ignores := LoadGitIgnore(root, ".")
 	var files []string
-	err := filepath.WalkDir(root, func(path string, d fs.DirEntry, err error) error {
-		if path == root {
+	err := fs.WalkDir(root, ".", func(path string, d fs.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+		if path == "." {
 			return nil
 		}
-		if d.IsDir() && path != root {
-			extraIgnores := LoadGitIgnore(path)
+		if d.IsDir() && path != "." {
+			extraIgnores := LoadGitIgnore(root, path)
 			for _, extraIgnore := range extraIgnores {
-				extraIgnore = strings.TrimPrefix(strings.TrimPrefix(filepath.Join(path, extraIgnore), root), "/")
-				ignore = append(ignore, extraIgnore)
+				extraIgnore = filepath.Join(path, extraIgnore)
+				ignores = append(ignores, extraIgnore)
 			}
 		}
-		path = strings.TrimPrefix(path, root+"/")
-		for _, ignore := range ignore {
+		for _, ignore := range ignores {
 			if ok, err := doublestar.Match(ignore, path); ok || err != nil {
 				if d.IsDir() {
 					return filepath.SkipDir
@@ -55,8 +56,7 @@ func NewGlobber(root string, outputs func() []string) (*Globber, error) {
 	}
 	sort.Strings(files)
 	return &Globber{
-		dir:     root,
-		ignore:  ignore,
+		ignore:  ignores,
 		files:   files,
 		outputs: outputs,
 		cache:   map[string][]string{},

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ func Compile(logger logging.Logger, bitfile parser.Bitfile) (*Engine, error) {`
`88`	`88`	`"CWD": {Pos: bitfile.Pos, Body: cwd},`
`89`	`89`	`},`
`90`	`90`	`}`
`91`		`- engine.globber, err = internal.NewGlobber(cwd, engine.Outputs)`
	`91`	`+ engine.globber, err = internal.NewGlobber(os.DirFS(cwd), engine.Outputs)`
`92`	`92`	`if err != nil {`
`93`	`93`	`return nil, err`
`94`	`94`	`}`