feat: improve formatter/config change detection

Busts the path cache if any of the following occurs:

* global excludes changes
* formatter added / removed
* formatter command changes, including checking the modtime and size of the executable it points to
* formatter includes/excludes changes
* formatter priority changes

Change detection is based on a sha256 hash of the above, which is stored in the db and compared before formatting.

Closes #455

Signed-off-by: Brian McGee <[email protected]>

cmd/root_test.go

@@ -56,7 +56,7 @@ func TestOnUnmatched(t *testing.T) {
 
 	checkOutput := func(level string, output []byte) {
 		for _, p := range paths {
-			as.Contains(string(output), fmt.Sprintf("%s format: no formatter for path: %s", level, p))
+			as.Contains(string(output), fmt.Sprintf("%s composite-formatter: no formatter for path: %s", level, p))
 		}
 	}
 
@@ -605,15 +605,15 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
 	configPath := tempDir + "/touch.toml"
 
 	// symlink some formatters into temp dir, so we can mess with their mod times
-	binPath := tempDir + "/bin"
+	binPath := filepath.Join(tempDir, "bin")
 	as.NoError(os.Mkdir(binPath, 0o755))
 
 	binaries := []string{"black", "elm-format", "gofmt"}
 
 	for _, name := range binaries {
 		src, err := exec.LookPath(name)
 		as.NoError(err)
-		as.NoError(os.Symlink(src, binPath+"/"+name))
+		as.NoError(os.Symlink(src, filepath.Join(binPath, name)))
 	}
 
 	// prepend our test bin directory to PATH
@@ -647,7 +647,8 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
 	})
 
 	// tweak mod time of elm formatter
-	as.NoError(test.RecreateSymlink(t, binPath+"/"+"elm-format"))
+	newTime := time.Now().Add(-time.Minute)
+	as.NoError(test.Lutimes(t, filepath.Join(binPath, "elm-format"), newTime, newTime))
 
 	_, statz, err = treefmt(t, args...)
 	as.NoError(err)
@@ -671,7 +672,7 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
 	})
 
 	// tweak mod time of python formatter
-	as.NoError(test.RecreateSymlink(t, binPath+"/"+"black"))
+	as.NoError(test.Lutimes(t, filepath.Join(binPath, "black"), newTime, newTime))
 
 	_, statz, err = treefmt(t, args...)
 	as.NoError(err)
@@ -695,11 +696,12 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
 	})
 
 	// add go formatter
-	cfg.FormatterConfigs["go"] = &config.Formatter{
+	goFormatter := &config.Formatter{
 		Command:  "gofmt",
 		Options:  []string{"-w"},
 		Includes: []string{"*.go"},
 	}
+	cfg.FormatterConfigs["go"] = goFormatter
 	test.WriteConfig(t, configPath, cfg)
 
 	_, statz, err = treefmt(t, args...)
@@ -723,6 +725,66 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
 		stats.Changed:   0,
 	})
 
+	// tweak go formatter options
+	goFormatter.Options = []string{"-w", "-s"}
+
+	test.WriteConfig(t, configPath, cfg)
+
+	_, statz, err = treefmt(t, args...)
+	as.NoError(err)
+
+	assertStats(t, as, statz, map[stats.Type]int{
+		stats.Traversed: 32,
+		stats.Matched:   4,
+		stats.Formatted: 4,
+		stats.Changed:   0,
+	})
+
+	// tweak go formatter includes
+	goFormatter.Includes = []string{"foo/*"}
+
+	test.WriteConfig(t, configPath, cfg)
+
+	_, statz, err = treefmt(t, args...)
+	as.NoError(err)
+
+	assertStats(t, as, statz, map[stats.Type]int{
+		stats.Traversed: 32,
+		stats.Matched:   3,
+		stats.Formatted: 3,
+		stats.Changed:   0,
+	})
+
+	// tweak go formatter excludes
+	goFormatter.Includes = []string{"*.go"}
+	goFormatter.Excludes = []string{"foo/*"}
+
+	test.WriteConfig(t, configPath, cfg)
+
+	_, statz, err = treefmt(t, args...)
+	as.NoError(err)
+
+	assertStats(t, as, statz, map[stats.Type]int{
+		stats.Traversed: 32,
+		stats.Matched:   4,
+		stats.Formatted: 4,
+		stats.Changed:   0,
+	})
+
+	// add a priority
+	cfg.FormatterConfigs["go"].Priority = 3
+	test.WriteConfig(t, configPath, cfg)
+
+	_, statz, err = treefmt(t, args...)
+	as.NoError(err)
+
+	assertStats(t, as, statz, map[stats.Type]int{
+		stats.Traversed: 32,
+		stats.Matched:   4,
+		stats.Formatted: 4,
+		stats.Changed:   0,
+	})
+
 	// remove python formatter
 	delete(cfg.FormatterConfigs, "python")
 	test.WriteConfig(t, configPath, cfg)
@@ -772,6 +834,35 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
 		stats.Formatted: 0,
 		stats.Changed:   0,
 	})
+
+	// change global excludes
+	cfg.Excludes = []string{"touch.toml"}
+	test.WriteConfig(t, configPath, cfg)
+
+	_, statz, err = treefmt(t, args...)
+	as.NoError(err)
+
+	assertStats(t, as, statz, map[stats.Type]int{
+		stats.Traversed: 32,
+		stats.Matched:   1,
+		stats.Formatted: 1,
+		stats.Changed:   0,
+	})
+
+	cfg.Excludes = nil
+	cfg.Global.Excludes = []string{"touch.toml", "yaml/test.yaml"}
+
+	test.WriteConfig(t, configPath, cfg)
+
+	_, statz, err = treefmt(t, args...)
+	as.NoError(err)
+
+	assertStats(t, as, statz, map[stats.Type]int{
+		stats.Traversed: 32,
+		stats.Matched:   1,
+		stats.Formatted: 1,
+		stats.Changed:   0,
+	})
 }
 
 func TestGit(t *testing.T) {