chore: rename violates-rule-1 to no-positional-arg-support

I feel this is clearer than `violates-rule-1`.

Signed-off-by: Brian McGee <brian@bmcgee.ie>

Author: brianmcgee

cmd/root_test.go

@@ -2502,19 +2502,19 @@ func TestConcurrentInvocation(t *testing.T) {
 	as.NoError(eg.Wait())
 }
 
-func TestViolatesRule1(t *testing.T) {
+func TestNoPositionalArgSupport(t *testing.T) {
 	tempDir := test.TempExamples(t)
 	configPath := filepath.Join(tempDir, "/treefmt.toml")
 
 	test.ChangeWorkDir(t, tempDir)
 
-	violatesRule1 := true
+	noPositionalArgSupport := true
 	cfg := &config.Config{
 		FormatterConfigs: map[string]*config.Formatter{
 			"echo": {
-				Command:       "test-fmt-only-one-file-at-a-time",
-				Includes:      []string{"*"},
-				ViolatesRule1: &violatesRule1,
+				Command:                "test-fmt-only-one-file-at-a-time",
+				Includes:               []string{"*"},
+				NoPositionalArgSupport: &noPositionalArgSupport,
 			},
 		},
 	}

config/config.go

@@ -64,7 +64,7 @@ type Formatter struct {
 	Priority int `mapstructure:"priority,omitempty" toml:"priority,omitempty"`
 	// Does this formatter violate [rule 1] of the formatter spec?
 	// [rule 1]: https://treefmt.com/latest/reference/formatter-spec/#1-files-passed-as-arguments
-	ViolatesRule1 *bool `mapstructure:"violates-rule-1" toml:"violates-rule-1"`
+	NoPositionalArgSupport *bool `mapstructure:"no-positional-arg-support" toml:"no-positional-arg-support"`
 }
 
 // SetFlags appends our flags to the provided flag set.

docs/site/getting-started/configure.md

@@ -472,7 +472,7 @@ An optional list of [glob patterns](#glob-patterns-format) used to exclude certa
 
 Influences the order of execution. Greater precedence is given to lower numbers, with the default being `0`.
 
-### `violates-rule-1`
+### `no-positional-arg-support`
 
 If `true`, `treefmt` will invoke the formatter with no more than 1 file at a time.
 

format/formatter.go

@@ -27,7 +27,10 @@ const (
 var (
 	ErrInvalidName = errors.New("formatter name must only contain alphanumeric characters, `_` or `-`")
 	// ErrCommandNotFound is returned when the Command for a Formatter is not available.
-	ErrCommandNotFound = errors.New("formatter command not found in PATH")
+	ErrCommandNotFound        = errors.New("formatter command not found in PATH")
+	ErrNoPositionalArgSupport = errors.New(
+		"formatter cannot format multiple files at once (it violates rule 1 of the formatter specification)",
+	)
 
 	nameRegex = regexp.MustCompile("^[a-zA-Z0-9_-]+$")
 )
@@ -50,12 +53,12 @@ func (f *Formatter) Name() string {
 	return f.name
 }
 
-func (f *Formatter) ViolatesRule1() bool {
-	if f.config.ViolatesRule1 == nil {
+func (f *Formatter) HasNoPositionalArgSupport() bool {
+	if f.config.NoPositionalArgSupport == nil {
 		return false
 	}
 
-	return *f.config.ViolatesRule1
+	return *f.config.NoPositionalArgSupport
 }
 
 func (f *Formatter) Priority() int {
@@ -90,10 +93,8 @@ func (f *Formatter) Hash(h hash.Hash) error {
 }
 
 func (f *Formatter) Apply(ctx context.Context, files []*walk.File) error {
-	if len(files) > 1 && f.ViolatesRule1() {
-		return fmt.Errorf(
-			"formatter cannot format %d files at once (it violates rule 1 of the formatter specification)", len(files),
-		)
+	if len(files) > 1 && f.HasNoPositionalArgSupport() {
+		return ErrNoPositionalArgSupport
 	}
 
 	start := time.Now()

format/scheduler.go

@@ -146,7 +146,7 @@ func (s *scheduler) schedule(ctx context.Context, key batchKey, batch []*walk.Fi
 			formatter := s.formatters[name]
 
 			maxBatchSize := len(batch)
-			if formatter.ViolatesRule1() {
+			if formatter.HasNoPositionalArgSupport() {
 				maxBatchSize = 1
 			}