refactor: optimize fuzzy matching with lazy initialization (#2523)

Author: vmaerten

CHANGELOG.md

@@ -17,6 +17,9 @@
   @vmaerten).
 - Improved shell completion scripts (Zsh, Fish, PowerShell) by adding missing
   flags and dynamic experimental feature detection (#2532 by @vmaerten).
+- Improved performance of fuzzy task name matching by implementing lazy
+  initialization. Added `--disable-fuzzy` flag and `disable-fuzzy` taskrc option
+  to allow disabling fuzzy matching entirely (#2521, #2523 by @vmaerten).
 - Added LLM-optimized documentation via VitePress plugin, generating `llms.txt`
   and `llms-full.txt` for AI-powered development tools (#2513 by @vmaerten).
 - Fixed Zsh and Fish completions to stop suggesting task names after `--`

completion/fish/task.fish

@@ -71,6 +71,7 @@ complete -c $GO_TASK_PROGNAME -s c -l color                     -d 'colored outp
 complete -c $GO_TASK_PROGNAME -s C -l concurrency               -d 'limit number of concurrent tasks'
 complete -c $GO_TASK_PROGNAME      -l completion                -d 'generate shell completion script' -xa "bash zsh fish powershell"
 complete -c $GO_TASK_PROGNAME -s d -l dir                       -d 'set directory of execution'
+complete -c $GO_TASK_PROGNAME      -l disable-fuzzy             -d 'disable fuzzy matching for task names'
 complete -c $GO_TASK_PROGNAME -s n -l dry                       -d 'compile and print tasks without executing'
 complete -c $GO_TASK_PROGNAME -s x -l exit-code                 -d 'pass-through exit code of task command'
 complete -c $GO_TASK_PROGNAME      -l experiments               -d 'list available experiments'

completion/ps/task.ps1

@@ -15,6 +15,7 @@ Register-ArgumentCompleter -CommandName task -ScriptBlock {
 			[CompletionResult]::new('--completion', '--completion', [CompletionResultType]::ParameterName, 'generate shell completion'),
 			[CompletionResult]::new('-d', '-d', [CompletionResultType]::ParameterName, 'set directory'),
 			[CompletionResult]::new('--dir', '--dir', [CompletionResultType]::ParameterName, 'set directory'),
+			[CompletionResult]::new('--disable-fuzzy', '--disable-fuzzy', [CompletionResultType]::ParameterName, 'disable fuzzy matching'),
 			[CompletionResult]::new('-n', '-n', [CompletionResultType]::ParameterName, 'dry run'),
 			[CompletionResult]::new('--dry', '--dry', [CompletionResultType]::ParameterName, 'dry run'),
 			[CompletionResult]::new('-x', '-x', [CompletionResultType]::ParameterName, 'pass-through exit code'),

completion/zsh/_task

@@ -60,6 +60,7 @@ _task() {
         '(-c --color)'{-c,--color}'[colored output]'
         '(--completion)--completion[generate shell completion script]:shell:(bash zsh fish powershell)'
         '(-d --dir)'{-d,--dir}'[dir to run in]:execution dir:_dirs'
+        '(--disable-fuzzy)--disable-fuzzy[disable fuzzy matching for task names]'
         '(-n --dry)'{-n,--dry}'[compiles and prints tasks without executing]'
         '(--dry)--dry[dry-run mode, compile and print tasks only]'
         '(-x --exit-code)'{-x,--exit-code}'[pass-through exit code of task command]'

executor.go

@@ -40,6 +40,7 @@ type (
 		Watch               bool
 		Verbose             bool
 		Silent              bool
+		DisableFuzzy        bool
 		AssumeYes           bool
 		AssumeTerm          bool // Used for testing
 		Dry                 bool
@@ -65,7 +66,8 @@ type (
 		UserWorkingDir     string
 		EnableVersionCheck bool
 
-		fuzzyModel *fuzzy.Model
+		fuzzyModel     *fuzzy.Model
+		fuzzyModelOnce sync.Once
 
 		concurrencySemaphore chan struct{}
 		taskCallCount        map[string]*int32
@@ -312,6 +314,19 @@ func (o *silentOption) ApplyToExecutor(e *Executor) {
 	e.Silent = o.silent
 }
 
+// WithDisableFuzzy tells the [Executor] to disable fuzzy matching for task names.
+func WithDisableFuzzy(disableFuzzy bool) ExecutorOption {
+	return &disableFuzzyOption{disableFuzzy}
+}
+
+type disableFuzzyOption struct {
+	disableFuzzy bool
+}
+
+func (o *disableFuzzyOption) ApplyToExecutor(e *Executor) {
+	e.DisableFuzzy = o.disableFuzzy
+}
+
 // WithAssumeYes tells the [Executor] to assume "yes" for all prompts.
 func WithAssumeYes(assumeYes bool) ExecutorOption {
 	return &assumeYesOption{assumeYes}

internal/flags/flags.go

@@ -58,6 +58,7 @@ var (
 	Watch               bool
 	Verbose             bool
 	Silent              bool
+	DisableFuzzy        bool
 	AssumeYes           bool
 	Dry                 bool
 	Summary             bool
@@ -125,6 +126,7 @@ func init() {
 	pflag.BoolVarP(&Watch, "watch", "w", false, "Enables watch of the given task.")
 	pflag.BoolVarP(&Verbose, "verbose", "v", getConfig(config, func() *bool { return config.Verbose }, false), "Enables verbose mode.")
 	pflag.BoolVarP(&Silent, "silent", "s", false, "Disables echoing.")
+	pflag.BoolVar(&DisableFuzzy, "disable-fuzzy", getConfig(config, func() *bool { return config.DisableFuzzy }, false), "Disables fuzzy matching for task names.")
 	pflag.BoolVarP(&AssumeYes, "yes", "y", false, "Assume \"yes\" as answer to all prompts.")
 	pflag.BoolVarP(&Parallel, "parallel", "p", false, "Executes tasks provided on command line in parallel.")
 	pflag.BoolVarP(&Dry, "dry", "n", false, "Compiles and prints tasks in the order that they would be run, without executing them.")
@@ -248,6 +250,7 @@ func (o *flagsOption) ApplyToExecutor(e *task.Executor) {
 		task.WithWatch(Watch),
 		task.WithVerbose(Verbose),
 		task.WithSilent(Silent),
+		task.WithDisableFuzzy(DisableFuzzy),
 		task.WithAssumeYes(AssumeYes),
 		task.WithDry(Dry || Status),
 		task.WithSummary(Summary),

setup.go

@@ -36,7 +36,6 @@ func (e *Executor) Setup() error {
 	if err := e.readTaskfile(node); err != nil {
 		return err
 	}
-	e.setupFuzzyModel()
 	e.setupStdFiles()
 	if err := e.setupOutput(); err != nil {
 		return err

task.go

@@ -456,8 +456,11 @@ func (e *Executor) GetTask(call *Call) (*ast.Task, error) {
 	// If we found no tasks
 	if len(aliasedTasks) == 0 {
 		didYouMean := ""
-		if e.fuzzyModel != nil {
-			didYouMean = e.fuzzyModel.SpellCheck(call.Task)
+		if !e.DisableFuzzy {
+			e.fuzzyModelOnce.Do(e.setupFuzzyModel)
+			if e.fuzzyModel != nil {
+				didYouMean = e.fuzzyModel.SpellCheck(call.Task)
+			}
 		}
 		return nil, &errors.TaskNotFoundError{
 			TaskName:   call.Task,

taskrc/ast/taskrc.go

@@ -10,12 +10,13 @@ import (
 )
 
 type TaskRC struct {
-	Version     *semver.Version `yaml:"version"`
-	Verbose     *bool           `yaml:"verbose"`
-	Concurrency *int            `yaml:"concurrency"`
-	Remote      Remote          `yaml:"remote"`
-	Experiments map[string]int  `yaml:"experiments"`
-	Failfast    bool            `yaml:"failfast"`
+	Version      *semver.Version `yaml:"version"`
+	Verbose      *bool           `yaml:"verbose"`
+	DisableFuzzy *bool           `yaml:"disable-fuzzy"`
+	Concurrency  *int            `yaml:"concurrency"`
+	Remote       Remote          `yaml:"remote"`
+	Failfast     bool            `yaml:"failfast"`
+	Experiments  map[string]int  `yaml:"experiments"`
 }
 
 type Remote struct {
@@ -53,6 +54,7 @@ func (t *TaskRC) Merge(other *TaskRC) {
 	}
 
 	t.Verbose = cmp.Or(other.Verbose, t.Verbose)
+	t.DisableFuzzy = cmp.Or(other.DisableFuzzy, t.DisableFuzzy)
 	t.Concurrency = cmp.Or(other.Concurrency, t.Concurrency)
 	t.Failfast = cmp.Or(other.Failfast, t.Failfast)
 }

website/src/docs/reference/cli.md

@@ -108,6 +108,16 @@ Disable command echoing.
 task deploy --silent
 ```
 
+#### `--disable-fuzzy`
+
+Disable fuzzy matching for task names. When enabled, Task will not suggest similar task names when you mistype a task name.
+
+```bash
+task buidl --disable-fuzzy
+# Output: Task "buidl" does not exist
+# (without "Did you mean 'build'?" suggestion)
+```
+
 ### Execution Control
 
 #### `-F, --failfast`