feat: recursive config search (#2166)

* refactor: experiments flags

* refactor: args.Parse

* feat: recursive search for taskrc files

* feat: consolidate some code into new fsext package

* feat: add tests for search and default dir

* fix: linting issues

Author: pd93

.taskrc.yml

@@ -0,0 +1,4 @@
+experiments:
+  GENTLE_FORCE: 0
+  REMOTE_TASKFILES: 0
+  ENV_PRECEDENCE: 0

args/args.go

@@ -3,10 +3,36 @@ package args
 import (
 	"strings"
 
+	"github.com/spf13/pflag"
+	"mvdan.cc/sh/v3/syntax"
+
 	"github.com/go-task/task/v3"
 	"github.com/go-task/task/v3/taskfile/ast"
 )
 
+// Get fetches the remaining arguments after CLI parsing and splits them into
+// two groups: the arguments before the double dash (--) and the arguments after
+// the double dash.
+func Get() ([]string, []string, error) {
+	args := pflag.Args()
+	doubleDashPos := pflag.CommandLine.ArgsLenAtDash()
+
+	if doubleDashPos == -1 {
+		return args, nil, nil
+	}
+
+	var quotedCliArgs []string
+	for _, arg := range args[doubleDashPos:] {
+		quotedCliArg, err := syntax.Quote(arg, syntax.LangBash)
+		if err != nil {
+			return nil, nil, err
+		}
+		quotedCliArgs = append(quotedCliArgs, quotedCliArg)
+	}
+
+	return args[:doubleDashPos], quotedCliArgs, nil
+}
+
 // Parse parses command line argument: tasks and global variables
 func Parse(args ...string) ([]*task.Call, *ast.Vars) {
 	calls := []*task.Call{}

cmd/task/task.go

@@ -5,10 +5,8 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
-	"strings"
 
 	"github.com/spf13/pflag"
-	"mvdan.cc/sh/v3/syntax"
 
 	"github.com/go-task/task/v3"
 	"github.com/go-task/task/v3/args"
@@ -78,7 +76,7 @@ func run() error {
 		if err != nil {
 			return err
 		}
-		args, _, err := getArgs()
+		_, args, err := args.Get()
 		if err != nil {
 			return err
 		}
@@ -145,17 +143,12 @@ func run() error {
 		return nil
 	}
 
-	var (
-		calls   []*task.Call
-		globals *ast.Vars
-	)
-
-	tasksAndVars, cliArgs, err := getArgs()
+	// Parse the remaining arguments
+	argv, cliArgs, err := args.Get()
 	if err != nil {
 		return err
 	}
-
-	calls, globals = args.Parse(tasksAndVars...)
+	calls, globals := args.Parse(argv...)
 
 	// If there are no calls, run the default task instead
 	if len(calls) == 0 {
@@ -181,24 +174,3 @@ func run() error {
 
 	return e.Run(ctx, calls...)
 }
-
-func getArgs() ([]string, string, error) {
-	var (
-		args          = pflag.Args()
-		doubleDashPos = pflag.CommandLine.ArgsLenAtDash()
-	)
-
-	if doubleDashPos == -1 {
-		return args, "", nil
-	}
-
-	var quotedCliArgs []string
-	for _, arg := range args[doubleDashPos:] {
-		quotedCliArg, err := syntax.Quote(arg, syntax.LangBash)
-		if err != nil {
-			return nil, "", err
-		}
-		quotedCliArgs = append(quotedCliArgs, quotedCliArg)
-	}
-	return args[:doubleDashPos], strings.Join(quotedCliArgs, " "), nil
-}

errors/errors.go

@@ -8,6 +8,11 @@ const (
 	CodeUnknown            // Used when no other exit code is appropriate
 )
 
+// TaskRC related exit codes
+const (
+	CodeTaskRCNotFoundError int = iota + 50
+)
+
 // Taskfile related exit codes
 const (
 	CodeTaskfileNotFound int = iota + 100

errors/errors_taskrc.go

@@ -0,0 +1,20 @@
+package errors
+
+import "fmt"
+
+type TaskRCNotFoundError struct {
+	URI  string
+	Walk bool
+}
+
+func (err TaskRCNotFoundError) Error() string {
+	var walkText string
+	if err.Walk {
+		walkText = " (or any of the parent directories)"
+	}
+	return fmt.Sprintf(`task: No Task config file found at %q%s`, err.URI, walkText)
+}
+
+func (err TaskRCNotFoundError) Code() int {
+	return CodeTaskRCNotFoundError
+}

internal/experiments/experiment.go

@@ -4,6 +4,8 @@ import (
 	"fmt"
 	"slices"
 	"strconv"
+
+	"github.com/go-task/task/v3/taskrc/ast"
 )
 
 type Experiment struct {
@@ -14,8 +16,11 @@ type Experiment struct {
 
 // New creates a new experiment with the given name and sets the values that can
 // enable it.
-func New(xName string, allowedValues ...int) Experiment {
-	value := experimentConfig.Experiments[xName]
+func New(xName string, config *ast.TaskRC, allowedValues ...int) Experiment {
+	var value int
+	if config != nil {
+		value = config.Experiments[xName]
+	}
 
 	if value == 0 {
 		value, _ = strconv.Atoi(getEnv(xName))

internal/experiments/experiment_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/stretchr/testify/assert"
 
 	"github.com/go-task/task/v3/internal/experiments"
+	"github.com/go-task/task/v3/taskrc/ast"
 )
 
 func TestNew(t *testing.T) {
@@ -16,60 +17,124 @@ func TestNew(t *testing.T) {
 	)
 	tests := []struct {
 		name          string
+		config        *ast.TaskRC
 		allowedValues []int
-		value         int
+		env           int
 		wantEnabled   bool
 		wantActive    bool
 		wantValid     error
+		wantValue     int
 	}{
 		{
-			name:        `[] allowed, value=""`,
+			name:        `[] allowed, env=""`,
 			wantEnabled: false,
 			wantActive:  false,
 		},
 		{
-			name:        `[] allowed, value="1"`,
-			value:       1,
+			name:        `[] allowed, env="1"`,
+			env:         1,
 			wantEnabled: false,
 			wantActive:  false,
 			wantValid: &experiments.InactiveError{
 				Name: exampleExperiment,
 			},
+			wantValue: 1,
 		},
 		{
-			name:          `[1] allowed, value=""`,
+			name:          `[1] allowed, env=""`,
 			allowedValues: []int{1},
 			wantEnabled:   false,
 			wantActive:    true,
 		},
 		{
-			name:          `[1] allowed, value="1"`,
+			name:          `[1] allowed, env="1"`,
 			allowedValues: []int{1},
-			value:         1,
+			env:           1,
 			wantEnabled:   true,
 			wantActive:    true,
+			wantValue:     1,
 		},
 		{
-			name:          `[1] allowed, value="2"`,
+			name:          `[1] allowed, env="2"`,
 			allowedValues: []int{1},
-			value:         2,
+			env:           2,
 			wantEnabled:   false,
 			wantActive:    true,
 			wantValid: &experiments.InvalidValueError{
 				Name:          exampleExperiment,
 				AllowedValues: []int{1},
 				Value:         2,
 			},
+			wantValue: 2,
+		},
+		{
+			name:          `[1, 2] allowed, env="1"`,
+			allowedValues: []int{1, 2},
+			env:           1,
+			wantEnabled:   true,
+			wantActive:    true,
+			wantValue:     1,
+		},
+		{
+			name:          `[1, 2] allowed, env="1"`,
+			allowedValues: []int{1, 2},
+			env:           2,
+			wantEnabled:   true,
+			wantActive:    true,
+			wantValue:     2,
+		},
+		{
+			name: `[1] allowed, config="1"`,
+			config: &ast.TaskRC{
+				Experiments: map[string]int{
+					exampleExperiment: 1,
+				},
+			},
+			allowedValues: []int{1},
+			wantEnabled:   true,
+			wantActive:    true,
+			wantValue:     1,
+		},
+		{
+			name: `[1] allowed, config="2"`,
+			config: &ast.TaskRC{
+				Experiments: map[string]int{
+					exampleExperiment: 2,
+				},
+			},
+			allowedValues: []int{1},
+			wantEnabled:   false,
+			wantActive:    true,
+			wantValid: &experiments.InvalidValueError{
+				Name:          exampleExperiment,
+				AllowedValues: []int{1},
+				Value:         2,
+			},
+			wantValue: 2,
+		},
+		{
+			name: `[1, 2] allowed, env="1", config="2"`,
+			config: &ast.TaskRC{
+				Experiments: map[string]int{
+					exampleExperiment: 2,
+				},
+			},
+			allowedValues: []int{1, 2},
+			env:           1,
+			wantEnabled:   true,
+			wantActive:    true,
+			wantValue:     2,
 		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			t.Setenv(exampleExperimentEnv, strconv.Itoa(tt.value))
-			x := experiments.New(exampleExperiment, tt.allowedValues...)
+			t.Setenv(exampleExperimentEnv, strconv.Itoa(tt.env))
+			x := experiments.New(exampleExperiment, tt.config, tt.allowedValues...)
 			assert.Equal(t, exampleExperiment, x.Name)
 			assert.Equal(t, tt.wantEnabled, x.Enabled())
 			assert.Equal(t, tt.wantActive, x.Active())
 			assert.Equal(t, tt.wantValid, x.Valid())
+			assert.Equal(t, tt.wantValue, x.Value)
 		})
 	}
 }