refactor: result of discussion in #1101

Author: a-h

.version

@@ -1 +1 @@
-0.3.847
+0.3.850

cmd/templ/fmtcmd/main.go

@@ -2,6 +2,7 @@ package fmtcmd
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"io"
 	"log/slog"
@@ -66,6 +67,7 @@ func NewFormatter(log *slog.Logger, dir string, process func(fileName string) (e
 }
 
 func (f *Formatter) Run() (err error) {
+	var errs []error
 	changesMade := 0
 	start := time.Now()
 	results := make(chan processor.Result)
@@ -79,6 +81,7 @@ func (f *Formatter) Run() (err error) {
 		if r.Error != nil {
 			f.Log.Error(r.FileName, slog.Any("error", r.Error))
 			errorCount++
+			errs = append(errs, r.Error)
 			continue
 		}
 		f.Log.Debug(r.FileName, slog.Duration("duration", r.Duration))
@@ -92,11 +95,11 @@ func (f *Formatter) Run() (err error) {
 
 	f.Log.Info("Format Complete", slog.Int("count", successCount+errorCount), slog.Int("errors", errorCount), slog.Int("changed", changesMade), slog.Duration("duration", time.Since(start)))
 
-	if errorCount > 0 {
-		return fmt.Errorf("formatting failed")
+	if err = errors.Join(errs...); err != nil {
+		return fmt.Errorf("formatting failed: %w", err)
 	}
 
-	return
+	return nil
 }
 
 type reader func() (fileName, src string, err error)

cmd/templ/generatecmd/watcher/watch.go

@@ -4,13 +4,12 @@ import (
 	"context"
 	"io/fs"
 	"os"
-	"path"
 	"path/filepath"
 	"regexp"
-	"strings"
 	"sync"
 	"time"
 
+	"github.com/a-h/templ/internal/skipdir"
 	"github.com/fsnotify/fsnotify"
 )
 
@@ -54,7 +53,7 @@ func WalkFiles(ctx context.Context, path string, watchPattern *regexp.Regexp, ou
 		if err != nil {
 			return nil
 		}
-		if info.IsDir() && shouldSkipDir(absPath) {
+		if info.IsDir() && skipdir.ShouldSkip(absPath) {
 			return filepath.SkipDir
 		}
 		if !watchPattern.MatchString(absPath) {
@@ -143,24 +142,9 @@ func (w *RecursiveWatcher) Add(dir string) error {
 		if !info.IsDir() {
 			return nil
 		}
-		if shouldSkipDir(dir) {
+		if skipdir.ShouldSkip(dir) {
 			return filepath.SkipDir
 		}
 		return w.w.Add(dir)
 	})
 }
-
-func shouldSkipDir(dir string) bool {
-	if dir == "." {
-		return false
-	}
-	if dir == "vendor" || dir == "node_modules" {
-		return true
-	}
-	_, name := path.Split(dir)
-	// These directories are ignored by the Go tool.
-	if strings.HasPrefix(name, ".") || strings.HasPrefix(name, "_") {
-		return true
-	}
-	return false
-}

cmd/templ/processor/processor.go

@@ -2,11 +2,12 @@ package processor
 
 import (
 	"io/fs"
-	"path"
 	"path/filepath"
 	"strings"
 	"sync"
 	"time"
+
+	"github.com/a-h/templ/internal/skipdir"
 )
 
 type Result struct {
@@ -27,27 +28,12 @@ func Process(dir string, f func(fileName string) (error, bool), workerCount int,
 	ProcessChannel(templates, dir, f, workerCount, results)
 }
 
-func shouldSkipDir(dir string) bool {
-	if dir == "." {
-		return false
-	}
-	if dir == "vendor" || dir == "node_modules" {
-		return true
-	}
-	_, name := path.Split(dir)
-	// These directories are ignored by the Go tool.
-	if strings.HasPrefix(name, ".") || strings.HasPrefix(name, "_") {
-		return true
-	}
-	return false
-}
-
 func FindTemplates(srcPath string, output chan<- string) (err error) {
 	return filepath.WalkDir(srcPath, func(currentPath string, info fs.DirEntry, err error) error {
 		if err != nil {
 			return err
 		}
-		if info.IsDir() && shouldSkipDir(currentPath) {
+		if info.IsDir() && skipdir.ShouldSkip(currentPath) {
 			return filepath.SkipDir
 		}
 		if !info.IsDir() && strings.HasSuffix(currentPath, ".templ") {

examples/counter/go.mod

@@ -1,8 +1,8 @@
 module github.com/a-h/templ/examples/counter
 
-go 1.23
+go 1.23.0
 
-toolchain go1.23.3
+toolchain go1.23.6
 
 require (
 	github.com/a-h/templ v0.2.234-0.20230427112944-80f0dc03a8a8
@@ -46,7 +46,7 @@ require (
 	golang.org/x/lint v0.0.0-20210508222113-6edffad5e616 // indirect
 	golang.org/x/mod v0.20.0 // indirect
 	golang.org/x/sync v0.10.0 // indirect
-	golang.org/x/sys v0.28.0 // indirect
+	golang.org/x/sys v0.31.0 // indirect
 	golang.org/x/tools v0.24.0 // indirect
 )
 

examples/counter/go.sum

@@ -95,8 +95,8 @@ golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5h
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA=
-golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
+golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
 golang.org/x/tools v0.24.0 h1:J1shsA93PJUEVaUSaay7UXAyE8aimq3GW0pjlolpa24=

internal/skipdir/skipdir.go

@@ -0,0 +1,20 @@
+package skipdir
+
+import (
+	"path/filepath"
+	"strings"
+)
+
+func ShouldSkip(path string) (skip bool) {
+	if path == "." {
+		return false
+	}
+	_, name := filepath.Split(path)
+	if name == "vendor" || name == "node_modules" {
+		return true
+	}
+	if strings.HasPrefix(name, ".") || strings.HasPrefix(name, "_") {
+		return true
+	}
+	return false
+}

internal/skipdir/skipdir_test.go

@@ -0,0 +1,60 @@
+package skipdir
+
+import "testing"
+
+func TestSkipDir(t *testing.T) {
+	tests := []struct {
+		name     string
+		dir      string
+		expected bool
+	}{
+		{
+			name:     "current directory is not skipped",
+			dir:      ".",
+			expected: false,
+		},
+		{
+			name:     "standard paths are not skipped",
+			dir:      "/home/user/adrian/github.com/a-h/templ/examples",
+			expected: false,
+		},
+		{
+			name:     "vendor directories are skipped",
+			dir:      "/home/user/adrian/github.com/a-h/templ/examples/vendor",
+			expected: true,
+		},
+		{
+			name:     "node_modules directories are skipped",
+			dir:      "/home/user/adrian/github.com/a-h/templ/examples/node_modules",
+			expected: true,
+		},
+		{
+			name:     "dot directories are skipped",
+			dir:      "/home/user/adrian/github.com/a-h/templ/examples/.git",
+			expected: true,
+		},
+		{
+			name:     "underscore directories are skipped",
+			dir:      "/home/user/adrian/github.com/a-h/templ/examples/_build",
+			expected: true,
+		},
+		{
+			name:     "relative paths are normalised",
+			dir:      "examples",
+			expected: false,
+		},
+		{
+			name:     "relative paths are normalised",
+			dir:      "examples/vendor",
+			expected: true,
+		},
+	}
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			actual := ShouldSkip(test.dir)
+			if test.expected != actual {
+				t.Errorf("expected %v, got %v", test.expected, actual)
+			}
+		})
+	}
+}