Merge pull request #624 from numtide/feat/tmp-path

brianmcgee · web-flow · commit c24e1f1b4fc3 · 2025-09-15T10:25:04.000+01:00
Introduce tmp path to better handle stdin
diff --git a/cmd/root_test.go b/cmd/root_test.go
diff --git a/format/formatter.go b/format/formatter.go
@@ -90,7 +90,11 @@ func (f *Formatter) Apply(ctx context.Context, files []*walk.File) error {
 
 	// append paths to the args
 	for _, file := range files {
-		args = append(args, file.RelPath)
+		if file.TmpPath != "" {
+			args = append(args, file.TmpPath)
+		} else {
+			args = append(args, file.RelPath)
+		}
 	}
 
 	// execute the command
diff --git a/nix/devshells/default.nix b/nix/devshells/default.nix
@@ -15,6 +15,7 @@ pkgs.mkShellNoCC {
       graphviz
       cobra-cli
       enumer
+      jujutsu
     ])
     ++ # include formatters for development and testing
     (import ../packages/treefmt/formatters.nix pkgs);
diff --git a/nix/packages/treefmt/formatters.nix b/nix/packages/treefmt/formatters.nix
@@ -17,6 +17,7 @@ with pkgs; [
   shfmt
   statix
   deadnix
+  just
   opentofu
   dos2unix
   yamlfmt
diff --git a/test/examples/just/justfile b/test/examples/just/justfile
@@ -0,0 +1,7 @@
+# print this message
+help:
+        just --list --list-submodules --unsorted
+
+# interactive recipes launcher
+choose:
+    just --choose --unsorted
diff --git a/test/examples/treefmt.toml b/test/examples/treefmt.toml
@@ -89,3 +89,8 @@ includes = ["*.yaml"]
 
 [formatter.foo-fmt]
 command = "foo-fmt"
+
+[formatter.just]
+command = "just"
+options = ["--fmt", "--unstable", "--justfile"]
+includes = ["**/justfile"]
diff --git a/walk/cached.go b/walk/cached.go
@@ -106,7 +106,7 @@ func (c *CachedReader) Read(ctx context.Context, files []*File) (n int, err erro
 
 			// set a release function which inserts this file into the update channel
 			file.AddReleaseFunc(func(ctx context.Context) error {
-				if !GetNoCache(ctx) {
+				if !GetNoCache(ctx) && file.TmpPath == "" {
 					c.updateCh <- file
 				}
 
diff --git a/walk/filesystem_test.go b/walk/filesystem_test.go
@@ -33,6 +33,7 @@ var examplesPaths = []string{
 	"html/index.html",
 	"html/scripts/.gitkeep",
 	"javascript/source/hello.js",
+	"just/justfile",
 	"nix/sources.nix",
 	"nixpkgs.toml",
 	"python/main.py",
@@ -78,8 +79,8 @@ func TestFilesystemReader(t *testing.T) {
 		}
 	}
 
-	as.Equal(32, count)
-	as.Equal(32, statz.Value(stats.Traversed))
+	as.Equal(33, count)
+	as.Equal(33, statz.Value(stats.Traversed))
 	as.Equal(0, statz.Value(stats.Matched))
 	as.Equal(0, statz.Value(stats.Formatted))
 	as.Equal(0, statz.Value(stats.Changed))
diff --git a/walk/git_test.go b/walk/git_test.go
@@ -29,12 +29,12 @@ func TestGitReader(t *testing.T) {
 	reader, err := walk.NewGitReader(tempDir, "", &statz)
 	as.NoError(err)
 
-	files := make([]*walk.File, 33)
+	files := make([]*walk.File, 34)
 	ctx, cancel := context.WithTimeout(t.Context(), 100*time.Millisecond)
 	n, err := reader.Read(ctx, files)
 
 	cancel()
-	as.Equal(32, n)
+	as.Equal(33, n)
 	as.ErrorIs(err, io.EOF)
 
 	// add everything to the git index
@@ -63,8 +63,8 @@ func TestGitReader(t *testing.T) {
 		}
 	}
 
-	as.Equal(32, count)
-	as.Equal(32, statz.Value(stats.Traversed))
+	as.Equal(33, count)
+	as.Equal(33, statz.Value(stats.Traversed))
 	as.Equal(0, statz.Value(stats.Matched))
 	as.Equal(0, statz.Value(stats.Formatted))
 	as.Equal(0, statz.Value(stats.Changed))
diff --git a/walk/jujutsu_test.go b/walk/jujutsu_test.go
@@ -67,8 +67,8 @@ func TestJujutsuReader(t *testing.T) {
 		}
 	}
 
-	as.Equal(32, count)
-	as.Equal(32, statz.Value(stats.Traversed))
+	as.Equal(33, count)
+	as.Equal(33, statz.Value(stats.Traversed))
 	as.Equal(0, statz.Value(stats.Matched))
 	as.Equal(0, statz.Value(stats.Formatted))
 	as.Equal(0, statz.Value(stats.Changed))
diff --git a/walk/stdin.go b/walk/stdin.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"path"
 	"path/filepath"
 
 	"github.com/numtide/treefmt/v2/stats"
@@ -25,10 +26,11 @@ func (s StdinReader) Read(_ context.Context, files []*File) (n int, err error) {
 		return 0, io.EOF
 	}
 
-	// read stdin into a temporary file with the same file extension
-	pattern := "*" + filepath.Ext(s.path)
+	// we attempt to preserve any file extensions as some formatters will not behave correctly without it
+	pattern := "treefmt-stdin-*" + filepath.Ext(s.path)
 
-	file, err := os.CreateTemp(s.root, pattern)
+	// create a temporary file to dump stdin into
+	file, err := os.CreateTemp("", pattern)
 	if err != nil {
 		return 0, fmt.Errorf("failed to create a temporary file for processing stdin: %w", err)
 	}
@@ -43,14 +45,10 @@ func (s StdinReader) Read(_ context.Context, files []*File) (n int, err error) {
 		return 0, fmt.Errorf("failed to get file info for temporary file: %w", err)
 	}
 
-	relPath, err := filepath.Rel(s.root, file.Name())
-	if err != nil {
-		return 0, fmt.Errorf("failed to get relative path for temporary file: %w", err)
-	}
-
 	files[0] = &File{
-		Path:    file.Name(),
-		RelPath: relPath,
+		Path:    path.Join(s.root, s.path),
+		RelPath: s.path,
+		TmpPath: file.Name(),
 		Info:    info,
 	}
 
diff --git a/walk/walk.go b/walk/walk.go
@@ -36,6 +36,7 @@ type ReleaseFunc func(ctx context.Context) error
 type File struct {
 	Path    string
 	RelPath string
+	TmpPath string
 	Info    fs.FileInfo
 
 	// FormattedInfo is the result of os.stat after formatting the file.
@@ -111,8 +112,13 @@ func (f *File) AddReleaseFunc(fn ReleaseFunc) {
 // Stat checks if the file has changed by comparing its current state (size, mod time) to when it was first read.
 // It returns a boolean indicating if the file has changed, the current file info, and an error if any.
 func (f *File) Stat() (changed bool, info fs.FileInfo, err error) {
+	p := f.Path
+	if f.TmpPath != "" {
+		p = f.TmpPath
+	}
+
 	// Get the file's current state
-	current, err := os.Stat(f.Path)
+	current, err := os.Stat(p)
 	if err != nil {
 		return false, nil, fmt.Errorf("failed to stat %s: %w", f.Path, err)
 	}

Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ func (c CachedReader) Read(ctx context.Context, files []File) (n int, err erro`
`106`	`106`
`107`	`107`	`// set a release function which inserts this file into the update channel`
`108`	`108`	`file.AddReleaseFunc(func(ctx context.Context) error {`
`109`		`- if !GetNoCache(ctx) {`
	`109`	`+ if !GetNoCache(ctx) && file.TmpPath == "" {`
`110`	`110`	`c.updateCh <- file`
`111`	`111`	`}`
`112`	`112`
Original file line number	Diff line number	Diff line change
`@@ -67,8 +67,8 @@ func TestJujutsuReader(t *testing.T) {`
`67`	`67`	`}`
`68`	`68`	`}`
`69`	`69`
`70`		`- as.Equal(32, count)`
`71`		`- as.Equal(32, statz.Value(stats.Traversed))`
	`70`	`+ as.Equal(33, count)`
	`71`	`+ as.Equal(33, statz.Value(stats.Traversed))`
`72`	`72`	`as.Equal(0, statz.Value(stats.Matched))`
`73`	`73`	`as.Equal(0, statz.Value(stats.Formatted))`
`74`	`74`	`as.Equal(0, statz.Value(stats.Changed))`