From da82b80f29beb85b0beeeeedcb1fdace2c2857d3 Mon Sep 17 00:00:00 2001 From: Brian McGee Date: Thu, 15 Feb 2024 10:37:33 +0000 Subject: [PATCH] feat: support --no-cache Signed-off-by: Brian McGee diff --git a/cli/cli.go b/cli/cli.go index 8b23262..b370ee7 100644 --- a/cli/cli.go +++ b/cli/cli.go @@ -11,6 +11,7 @@ var Cli = Format{} type Format struct { AllowMissingFormatter bool `default:"false" help:"Do not exit with error if a configured formatter is missing"` WorkingDirectory kong.ChangeDirFlag `default:"." short:"C" help:"Run as if treefmt was started in the specified working directory instead of the current working directory"` + NoCache bool `help:"Ignore the evaluation cache entirely. Useful for CI"` ClearCache bool `short:"c" help:"Reset the evaluation cache. Use in case the cache is not precise enough"` ConfigFile string `type:"existingfile" default:"./treefmt.toml"` FailOnChange bool `help:"Exit with error if any changes were made. Useful for CI."` diff --git a/cli/format.go b/cli/format.go index 6c46096..14ac16c 100644 --- a/cli/format.go +++ b/cli/format.go @@ -5,6 +5,7 @@ import ( "context" "errors" "fmt" + "io/fs" "os" "os/signal" "strings" @@ -168,6 +169,20 @@ func (f *Format) Run() error { var changes int + processBatch := func() error { + if Cli.NoCache { + changes += len(batch) + } else { + count, err := cache.Update(batch) + if err != nil { + return err + } + changes += count + } + batch = batch[:0] + return nil + } + LOOP: for { select { @@ -179,22 +194,17 @@ func (f *Format) Run() error { } batch = append(batch, path) if len(batch) == batchSize { - count, err := cache.Update(batch) - if err != nil { + if err = processBatch(); err != nil { return err } - changes += count - batch = batch[:0] } } } // final flush - count, err := cache.Update(batch) - if err != nil { + if err = processBatch(); err != nil { return err } - changes += count if Cli.FailOnChange && changes != 0 { return ErrFailOnChange @@ -251,6 +261,22 @@ func (f *Format) Run() error { } defer close(pathsCh) + + if Cli.NoCache { + return walker.Walk(ctx, func(path string, info fs.FileInfo, err error) error { + select { + case <-ctx.Done(): + return ctx.Err() + default: + // ignore symlinks and directories + if !(info.IsDir() || info.Mode()&os.ModeSymlink == os.ModeSymlink) { + pathsCh <- path + } + return nil + } + }) + } + return cache.ChangeSet(ctx, walker, pathsCh) }) diff --git a/cli/format_test.go b/cli/format_test.go index fb389fe..2349767 100644 --- a/cli/format_test.go +++ b/cli/format_test.go @@ -216,6 +216,15 @@ func TestCache(t *testing.T) { as.NoError(err) as.Contains(string(out), "0 files changed") + // clear cache + out, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir, "-c") + as.NoError(err) + as.Contains(string(out), fmt.Sprintf("%d files changed", 29)) + + out, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir) + as.NoError(err) + as.Contains(string(out), "0 files changed") + // no cache out, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir, "--no-cache") as.NoError(err) diff --git a/nix/packages.nix b/nix/packages.nix index 127eb08..e0f8604 100644 --- a/nix/packages.nix +++ b/nix/packages.nix @@ -13,7 +13,7 @@ packages = rec { treefmt = inputs'.gomod2nix.legacyPackages.buildGoApplication rec { pname = "treefmt"; - version = "0.0.1+dev"; + version = "2.0.0+dev"; # ensure we are using the same version of go to build with inherit (pkgs) go; diff --git a/cli/cli.go b/cli/cli.go index 8b23262..b370ee7 100644 --- a/cli/cli.go +++ b/cli/cli.go @@ -11,6 +11,7 @@ var Cli = Format{} type Format struct { AllowMissingFormatter bool `default:"false" help:"Do not exit with error if a configured formatter is missing"` WorkingDirectory kong.ChangeDirFlag `default:"." short:"C" help:"Run as if treefmt was started in the specified working directory instead of the current working directory"` + NoCache bool `help:"Ignore the evaluation cache entirely. Useful for CI"` ClearCache bool `short:"c" help:"Reset the evaluation cache. Use in case the cache is not precise enough"` ConfigFile string `type:"existingfile" default:"./treefmt.toml"` FailOnChange bool `help:"Exit with error if any changes were made. Useful for CI."` diff --git a/cli/format.go b/cli/format.go index 6c46096..14ac16c 100644 --- a/cli/format.go +++ b/cli/format.go @@ -5,6 +5,7 @@ import ( "context" "errors" "fmt" + "io/fs" "os" "os/signal" "strings" @@ -168,6 +169,20 @@ func (f *Format) Run() error { var changes int + processBatch := func() error { + if Cli.NoCache { + changes += len(batch) + } else { + count, err := cache.Update(batch) + if err != nil { + return err + } + changes += count + } + batch = batch[:0] + return nil + } + LOOP: for { select { @@ -179,22 +194,17 @@ func (f *Format) Run() error { } batch = append(batch, path) if len(batch) == batchSize { - count, err := cache.Update(batch) - if err != nil { + if err = processBatch(); err != nil { return err } - changes += count - batch = batch[:0] } } } // final flush - count, err := cache.Update(batch) - if err != nil { + if err = processBatch(); err != nil { return err } - changes += count if Cli.FailOnChange && changes != 0 { return ErrFailOnChange @@ -251,6 +261,22 @@ func (f *Format) Run() error { } defer close(pathsCh) + + if Cli.NoCache { + return walker.Walk(ctx, func(path string, info fs.FileInfo, err error) error { + select { + case <-ctx.Done(): + return ctx.Err() + default: + // ignore symlinks and directories + if !(info.IsDir() || info.Mode()&os.ModeSymlink == os.ModeSymlink) { + pathsCh <- path + } + return nil + } + }) + } + return cache.ChangeSet(ctx, walker, pathsCh) }) diff --git a/nix/packages.nix b/nix/packages.nix index 127eb08..e0f8604 100644 --- a/nix/packages.nix +++ b/nix/packages.nix @@ -13,7 +13,7 @@ packages = rec { treefmt = inputs'.gomod2nix.legacyPackages.buildGoApplication rec { pname = "treefmt"; - version = "0.0.1+dev"; + version = "2.0.0+dev"; # ensure we are using the same version of go to build with inherit (pkgs) go; --- cli/cli.go | 1 + cli/format.go | 40 +++++++++++++++++++++++++++++++++------- nix/packages.nix | 2 +- 3 files changed, 35 insertions(+), 8 deletions(-) diff --git a/cli/cli.go b/cli/cli.go index 8b23262..b370ee7 100644 --- a/cli/cli.go +++ b/cli/cli.go @@ -11,6 +11,7 @@ var Cli = Format{} type Format struct { AllowMissingFormatter bool `default:"false" help:"Do not exit with error if a configured formatter is missing"` WorkingDirectory kong.ChangeDirFlag `default:"." short:"C" help:"Run as if treefmt was started in the specified working directory instead of the current working directory"` + NoCache bool `help:"Ignore the evaluation cache entirely. Useful for CI"` ClearCache bool `short:"c" help:"Reset the evaluation cache. Use in case the cache is not precise enough"` ConfigFile string `type:"existingfile" default:"./treefmt.toml"` FailOnChange bool `help:"Exit with error if any changes were made. Useful for CI."` diff --git a/cli/format.go b/cli/format.go index 6c46096..14ac16c 100644 --- a/cli/format.go +++ b/cli/format.go @@ -5,6 +5,7 @@ import ( "context" "errors" "fmt" + "io/fs" "os" "os/signal" "strings" @@ -168,6 +169,20 @@ func (f *Format) Run() error { var changes int + processBatch := func() error { + if Cli.NoCache { + changes += len(batch) + } else { + count, err := cache.Update(batch) + if err != nil { + return err + } + changes += count + } + batch = batch[:0] + return nil + } + LOOP: for { select { @@ -179,22 +194,17 @@ func (f *Format) Run() error { } batch = append(batch, path) if len(batch) == batchSize { - count, err := cache.Update(batch) - if err != nil { + if err = processBatch(); err != nil { return err } - changes += count - batch = batch[:0] } } } // final flush - count, err := cache.Update(batch) - if err != nil { + if err = processBatch(); err != nil { return err } - changes += count if Cli.FailOnChange && changes != 0 { return ErrFailOnChange @@ -251,6 +261,22 @@ func (f *Format) Run() error { } defer close(pathsCh) + + if Cli.NoCache { + return walker.Walk(ctx, func(path string, info fs.FileInfo, err error) error { + select { + case <-ctx.Done(): + return ctx.Err() + default: + // ignore symlinks and directories + if !(info.IsDir() || info.Mode()&os.ModeSymlink == os.ModeSymlink) { + pathsCh <- path + } + return nil + } + }) + } + return cache.ChangeSet(ctx, walker, pathsCh) }) diff --git a/nix/packages.nix b/nix/packages.nix index 127eb08..e0f8604 100644 --- a/nix/packages.nix +++ b/nix/packages.nix @@ -13,7 +13,7 @@ packages = rec { treefmt = inputs'.gomod2nix.legacyPackages.buildGoApplication rec { pname = "treefmt"; - version = "0.0.1+dev"; + version = "2.0.0+dev"; # ensure we are using the same version of go to build with inherit (pkgs) go;