feat: iterators

help.go

@@ -132,16 +132,10 @@ func (e *Executor) ListTaskNames(allTasks bool) error {
 	if e.TaskSorter == nil {
 		e.TaskSorter = sort.AlphaNumericWithRootTasksFirst
 	}
-	keys := e.Taskfile.Tasks.Keys()
-	e.TaskSorter(keys, nil)
 
 	// Create a list of task names
 	taskNames := make([]string, 0, e.Taskfile.Tasks.Len())
-	for _, key := range keys {
-		task, ok := e.Taskfile.Tasks.Get(key)
-		if !ok {
-			continue
-		}
+	for task := range e.Taskfile.Tasks.Values(e.TaskSorter) {
 		if (allTasks || task.Desc != "") && !task.Internal {
 			taskNames = append(taskNames, strings.TrimRight(task.Task, ":"))
 			for _, alias := range task.Aliases {

internal/compiler/compiler.go

@@ -104,31 +104,43 @@ func (c *Compiler) getVariables(t *ast.Task, call *ast.Call, evaluateShVars bool
 		taskRangeFunc = getRangeFunc(dir)
 	}
 
-	if err := c.TaskfileEnv.Range(rangeFunc); err != nil {
+	for k, v := range c.TaskfileEnv.All() {
+		if err := rangeFunc(k, v); err != nil {
 			return nil, err
 		}
-	if err := c.TaskfileVars.Range(rangeFunc); err != nil {
+	}
+	for k, v := range c.TaskfileVars.All() {
+		if err := rangeFunc(k, v); err != nil {
 			return nil, err
 		}
+	}
 	if t != nil {
-		if err := t.IncludeVars.Range(rangeFunc); err != nil {
+		for k, v := range t.IncludeVars.All() {
+			if err := rangeFunc(k, v); err != nil {
 				return nil, err
 			}
-		if err := t.IncludedTaskfileVars.Range(taskRangeFunc); err != nil {
+		}
+		for k, v := range t.IncludedTaskfileVars.All() {
+			if err := taskRangeFunc(k, v); err != nil {
 				return nil, err
 			}
 		}
+	}
 
 	if t == nil || call == nil {
 		return result, nil
 	}
 
-	if err := call.Vars.Range(rangeFunc); err != nil {
+	for k, v := range call.Vars.All() {
+		if err := rangeFunc(k, v); err != nil {
 			return nil, err
 		}
-	if err := t.Vars.Range(taskRangeFunc); err != nil {
+	}
+	for k, v := range t.Vars.All() {
+		if err := taskRangeFunc(k, v); err != nil {
 			return nil, err
 		}
+	}
 
 	return result, nil
 }

internal/templater/templater.go

@@ -141,10 +141,9 @@ func ReplaceVarsWithExtra(vars *ast.Vars, cache *Cache, extra map[string]any) *a
 	}
 
 	var newVars ast.Vars
-	_ = vars.Range(func(k string, v ast.Var) error {
+	for k, v := range vars.All() {
 		newVars.Set(k, ReplaceVarWithExtra(v, cache, extra))
-		return nil
-	})
+	}
 
 	return &newVars
 }

setup.go

@@ -92,13 +92,10 @@ func (e *Executor) setupFuzzyModel() {
 	model.SetThreshold(1) // because we want to build grammar based on every task name
 
 	var words []string
-	for _, taskName := range e.Taskfile.Tasks.Keys() {
-		words = append(words, taskName)
-
-		for _, task := range e.Taskfile.Tasks.Values() {
+	for name, task := range e.Taskfile.Tasks.All(nil) {
+		words = append(words, name)
 		words = slices.Concat(words, task.Aliases)
 	}
-	}
 
 	model.Train(words)
 	e.fuzzyModel = model
@@ -212,12 +209,11 @@ func (e *Executor) readDotEnvFiles() error {
 		return err
 	}
 
-	err = env.Range(func(key string, value ast.Var) error {
-		if _, ok := e.Taskfile.Env.Get(key); !ok {
-			e.Taskfile.Env.Set(key, value)
+	for k, v := range env.All() {
+		if _, ok := e.Taskfile.Env.Get(k); !ok {
+			e.Taskfile.Env.Set(k, v)
+		}
 	}
-		return nil
-	})
 	return err
 }
 
@@ -235,7 +231,7 @@ func (e *Executor) setupConcurrencyState() {
 
 	e.taskCallCount = make(map[string]*int32, e.Taskfile.Tasks.Len())
 	e.mkdirMutexMap = make(map[string]*sync.Mutex, e.Taskfile.Tasks.Len())
-	for _, k := range e.Taskfile.Tasks.Keys() {
+	for k := range e.Taskfile.Tasks.Keys(nil) {
 		e.taskCallCount[k] = new(int32)
 		e.mkdirMutexMap[k] = &sync.Mutex{}
 	}

task.go

@@ -462,7 +462,7 @@ func (e *Executor) GetTask(call *ast.Call) (*ast.Task, error) {
 	// If didn't find one, search for a task with a matching alias
 	var matchingTask *ast.Task
 	var aliasedTasks []string
-	for _, task := range e.Taskfile.Tasks.Values() {
+	for task := range e.Taskfile.Tasks.Values(nil) {
 		if slices.Contains(task.Aliases, call.Task) {
 			aliasedTasks = append(aliasedTasks, task.Task)
 			matchingTask = task
@@ -502,15 +502,9 @@ func (e *Executor) GetTaskList(filters ...FilterFunc) ([]*ast.Task, error) {
 	if e.TaskSorter == nil {
 		e.TaskSorter = sort.AlphaNumericWithRootTasksFirst
 	}
-	keys := e.Taskfile.Tasks.Keys()
-	e.TaskSorter(keys, nil)
 
 	// Filter tasks based on the given filter functions
-	for _, key := range keys {
-		task, ok := e.Taskfile.Tasks.Get(key)
-		if !ok {
-			continue
-		}
+	for task := range e.Taskfile.Tasks.Values(e.TaskSorter) {
 		var shouldFilter bool
 		for _, filter := range filters {
 			if filter(task) {

taskfile/ast/graph.go

@@ -116,14 +116,14 @@ func (tfg *TaskfileGraph) Merge() (*Taskfile, error) {
 		return nil, err
 	}
 
-	_ = rootVertex.Taskfile.Tasks.Range(func(name string, task *Task) error {
+	// TODO: I don't think this is necessary anymore
+	for name, task := range rootVertex.Taskfile.Tasks.All(nil) {
 		if task == nil {
 			task = &Task{}
 			rootVertex.Taskfile.Tasks.Set(name, task)
 		}
 		task.Task = name
-		return nil
-	})
+	}
 
 	return rootVertex.Taskfile, nil
 }

taskfile/ast/include.go

@@ -1,10 +1,13 @@
 package ast
 
 import (
+	"iter"
+
 	"github.com/elliotchance/orderedmap/v2"
 	"gopkg.in/yaml.v3"
 
 	"github.com/go-task/task/v3/errors"
+	"github.com/go-task/task/v3/internal/sort"
 )
 
 // Include represents information about included taskfiles
@@ -61,16 +64,34 @@ func (includes *Includes) Set(key string, value *Include) bool {
 	return includes.om.Set(key, value)
 }
 
-func (includes *Includes) Range(f func(k string, v *Include) error) error {
+// All returns an iterator that loops over all task key-value pairs.
+func (includes *Includes) All() iter.Seq2[string, *Include] {
 	if includes == nil || includes.om == nil {
-		return nil
+		return func(yield func(string, *Include) bool) {}
+	}
+	return includes.om.Iterator()
+}
+
+// Keys returns an iterator that loops over all task keys.
+func (includes *Includes) Keys(sorter sort.Sorter) iter.Seq[string] {
+	return func(yield func(string) bool) {
+		for k := range includes.All() {
+			if !yield(k) {
+				return
+			}
+		}
+	}
+}
+
+// Values returns an iterator that loops over all task values.
+func (includes *Includes) Values(sorter sort.Sorter) iter.Seq[*Include] {
+	return func(yield func(*Include) bool) {
+		for _, v := range includes.All() {
+			if !yield(v) {
+				return
 			}
-	for pair := includes.om.Front(); pair != nil; pair = pair.Next() {
-		if err := f(pair.Key, pair.Value); err != nil {
-			return err
 		}
 	}
-	return nil
 }
 
 // UnmarshalYAML implements the yaml.Unmarshaler interface.

taskfile/ast/matrix.go

@@ -1,11 +1,14 @@
 package ast
 
 import (
+	"iter"
+
 	"github.com/elliotchance/orderedmap/v2"
 	"gopkg.in/yaml.v3"
 
 	"github.com/go-task/task/v3/errors"
 	"github.com/go-task/task/v3/internal/deepcopy"
+	"github.com/go-task/task/v3/internal/sort"
 )
 
 type Matrix struct {
@@ -48,16 +51,31 @@ func (matrix *Matrix) Set(key string, value []any) bool {
 	return matrix.om.Set(key, value)
 }
 
-func (matrix *Matrix) Range(f func(k string, v []any) error) error {
-	if matrix == nil || matrix.om == nil {
-		return nil
-	}
-	for pair := matrix.om.Front(); pair != nil; pair = pair.Next() {
-		if err := f(pair.Key, pair.Value); err != nil {
-			return err
+// All returns an iterator that loops over all task key-value pairs.
+func (matrix *Matrix) All() iter.Seq2[string, []any] {
+	return matrix.om.Iterator()
+}
+
+// Keys returns an iterator that loops over all task keys.
+func (matrix *Matrix) Keys(sorter sort.Sorter) iter.Seq[string] {
+	return func(yield func(string) bool) {
+		for k := range matrix.All() {
+			if !yield(k) {
+				return
+			}
+		}
+	}
+}
+
+// Values returns an iterator that loops over all task values.
+func (matrix *Matrix) Values(sorter sort.Sorter) iter.Seq[[]any] {
+	return func(yield func([]any) bool) {
+		for _, v := range matrix.All() {
+			if !yield(v) {
+				return
+			}
 		}
 	}
-	return nil
 }
 
 func (matrix *Matrix) DeepCopy() *Matrix {

taskfile/ast/tasks.go

@@ -2,6 +2,7 @@ package ast
 
 import (
 	"fmt"
+	"iter"
 	"slices"
 	"strings"
 
@@ -10,6 +11,7 @@ import (
 
 	"github.com/go-task/task/v3/errors"
 	"github.com/go-task/task/v3/internal/filepathext"
+	"github.com/go-task/task/v3/internal/sort"
 )
 
 // Tasks represents a group of tasks
@@ -53,38 +55,47 @@ func (tasks *Tasks) Set(key string, value *Task) bool {
 	return tasks.om.Set(key, value)
 }
 
-func (tasks *Tasks) Range(f func(k string, v *Task) error) error {
-	if tasks == nil || tasks.om == nil {
-		return nil
+// All returns an iterator that loops over all task key-value pairs in the order
+// specified by the sorter.
+func (t *Tasks) All(sorter sort.Sorter) iter.Seq2[string, *Task] {
+	if t == nil || t.om == nil {
+		return func(yield func(string, *Task) bool) {}
+	}
+	if sorter == nil {
+		return t.om.Iterator()
+	}
+	return func(yield func(string, *Task) bool) {
+		for _, key := range sorter(t.om.Keys(), nil) {
+			el := t.om.GetElement(key)
+			if !yield(el.Key, el.Value) {
+				return
 			}
-	for pair := tasks.om.Front(); pair != nil; pair = pair.Next() {
-		if err := f(pair.Key, pair.Value); err != nil {
-			return err
 		}
 	}
-	return nil
 }
 
-func (tasks *Tasks) Keys() []string {
-	if tasks == nil {
-		return nil
+// Keys returns an iterator that loops over all task keys in the order specified
+// by the sorter.
+func (t *Tasks) Keys(sorter sort.Sorter) iter.Seq[string] {
+	return func(yield func(string) bool) {
+		for k := range t.All(sorter) {
+			if !yield(k) {
+				return
+			}
 		}
-	var keys []string
-	for pair := tasks.om.Front(); pair != nil; pair = pair.Next() {
-		keys = append(keys, pair.Key)
 	}
-	return keys
 }
 
-func (tasks *Tasks) Values() []*Task {
-	if tasks == nil {
-		return nil
+// Values returns an iterator that loops over all task values in the order
+// specified by the sorter.
+func (t *Tasks) Values(sorter sort.Sorter) iter.Seq[*Task] {
+	return func(yield func(*Task) bool) {
+		for _, v := range t.All(sorter) {
+			if !yield(v) {
+				return
+			}
 		}
-	var values []*Task
-	for pair := tasks.om.Front(); pair != nil; pair = pair.Next() {
-		values = append(values, pair.Value)
 	}
-	return values
 }
 
 type MatchingTask struct {
@@ -104,20 +115,19 @@ func (t *Tasks) FindMatchingTasks(call *Call) []*MatchingTask {
 	}
 	// Attempt a wildcard match
 	// For now, we can just nil check the task before each loop
-	_ = t.Range(func(key string, value *Task) error {
+	for _, value := range t.All(nil) {
 		if match, wildcards := value.WildcardMatch(call.Task); match {
 			matchingTasks = append(matchingTasks, &MatchingTask{
 				Task:      value,
 				Wildcards: wildcards,
 			})
 		}
-		return nil
-	})
+	}
 	return matchingTasks
 }
 
 func (t1 *Tasks) Merge(t2 *Tasks, include *Include, includedTaskfileVars *Vars) error {
-	err := t2.Range(func(name string, v *Task) error {
+	for name, v := range t2.All(nil) {
 		// We do a deep copy of the task struct here to ensure that no data can
 		// be changed elsewhere once the taskfile is merged.
 		task := v.DeepCopy()
@@ -177,9 +187,7 @@ func (t1 *Tasks) Merge(t2 *Tasks, include *Include, includedTaskfileVars *Vars)
 		}
 		// Add the task to the merged taskfile
 		t1.Set(taskName, task)
-
-		return nil
-	})
+	}
 
 	// If the included Taskfile has a default task, is not flattened and the
 	// parent namespace has no task with a matching name, we can add an alias so
@@ -197,7 +205,7 @@ func (t1 *Tasks) Merge(t2 *Tasks, include *Include, includedTaskfileVars *Vars)
 		}
 	}
 
-	return err
+	return nil
 }
 
 func (t *Tasks) UnmarshalYAML(node *yaml.Node) error {

taskfile/ast/var.go

@@ -1,6 +1,7 @@
 package ast
 
 import (
+	"iter"
 	"strings"
 
 	"github.com/elliotchance/orderedmap/v2"
@@ -9,6 +10,7 @@ import (
 	"github.com/go-task/task/v3/errors"
 	"github.com/go-task/task/v3/internal/deepcopy"
 	"github.com/go-task/task/v3/internal/experiments"
+	"github.com/go-task/task/v3/internal/sort"
 )
 
 // Vars is a string[string] variables map.
@@ -52,32 +54,50 @@ func (vs *Vars) Set(key string, value Var) bool {
 	return vs.om.Set(key, value)
 }
 
-func (vs *Vars) Range(f func(k string, v Var) error) error {
+// All returns an iterator that loops over all task key-value pairs.
+func (vs *Vars) All() iter.Seq2[string, Var] {
 	if vs == nil || vs.om == nil {
-		return nil
+		return func(yield func(string, Var) bool) {}
+	}
+	return vs.om.Iterator()
+}
+
+// Keys returns an iterator that loops over all task keys.
+func (vs *Vars) Keys(sorter sort.Sorter) iter.Seq[string] {
+	return func(yield func(string) bool) {
+		for k := range vs.All() {
+			if !yield(k) {
+				return
+			}
+		}
+	}
+}
+
+// Values returns an iterator that loops over all task values.
+func (vs *Vars) Values(sorter sort.Sorter) iter.Seq[Var] {
+	return func(yield func(Var) bool) {
+		for _, v := range vs.All() {
+			if !yield(v) {
+				return
 			}
-	for pair := vs.om.Front(); pair != nil; pair = pair.Next() {
-		if err := f(pair.Key, pair.Value); err != nil {
-			return err
 		}
 	}
-	return nil
 }
 
 // ToCacheMap converts Vars to a map containing only the static
 // variables
 func (vs *Vars) ToCacheMap() (m map[string]any) {
 	m = make(map[string]any, vs.Len())
-	for pair := vs.om.Front(); pair != nil; pair = pair.Next() {
-		if pair.Value.Sh != "" {
+	for k, v := range vs.All() {
+		if v.Sh != "" {
 			// Dynamic variable is not yet resolved; trigger
 			// <no value> to be used in templates.
 			return nil
 		}
-		if pair.Value.Live != nil {
-			m[pair.Key] = pair.Value.Live
+		if v.Live != nil {
+			m[k] = v.Live
 		} else {
-			m[pair.Key] = pair.Value.Value
+			m[k] = v.Value
 		}
 	}
 	return

taskfile/reader.go

@@ -97,7 +97,7 @@ func (r *Reader) include(node Node) error {
 	var g errgroup.Group
 
 	// Loop over each included taskfile
-	_ = vertex.Taskfile.Includes.Range(func(namespace string, include *ast.Include) error {
+	for _, include := range vertex.Taskfile.Includes.All() {
 		vars := compiler.GetEnviron()
 		vars.Merge(vertex.Taskfile.Vars, nil)
 		// Start a goroutine to process each included Taskfile
@@ -173,8 +173,7 @@ func (r *Reader) include(node Node) error {
 			}
 			return err
 		})
-		return nil
-	})
+	}
 
 	// Wait for all the go routines to finish
 	return g.Wait()
@@ -282,7 +281,7 @@ func (r *Reader) readNode(node Node) (*ast.Taskfile, error) {
 
 	// Set the taskfile/task's locations
 	tf.Location = node.Location()
-	for _, task := range tf.Tasks.Values() {
+	for task := range tf.Tasks.Values(nil) {
 		// If the task is not defined, create a new one
 		if task == nil {
 			task = &ast.Task{}

variables.go

@@ -109,21 +109,17 @@ func (e *Executor) compiledTask(call *ast.Call, evaluateShVars bool) (*ast.Task,
 	new.Env.Merge(templater.ReplaceVars(dotenvEnvs, cache), nil)
 	new.Env.Merge(templater.ReplaceVars(origTask.Env, cache), nil)
 	if evaluateShVars {
-		err = new.Env.Range(func(k string, v ast.Var) error {
+		for k, v := range new.Env.All() {
 			// If the variable is not dynamic, we can set it and return
 			if v.Value != nil || v.Sh == "" {
 				new.Env.Set(k, ast.Var{Value: v.Value})
-				return nil
+				continue
 			}
 			static, err := e.Compiler.HandleDynamicVar(v, new.Dir)
 			if err != nil {
-				return err
+				return nil, err
 			}
 			new.Env.Set(k, ast.Var{Value: static})
-			return nil
-		})
-		if err != nil {
-			return nil, err
 		}
 	}
 
@@ -300,7 +296,7 @@ func itemsFromFor(
 			// If the variable is dynamic, then it hasn't been resolved yet
 			// and we can't use it as a list. This happens when fast compiling a task
 			// for use in --list or --list-all etc.
-			if ok && v.Sh == "" {
+			if ok && v.Value != nil && v.Sh == "" {
 				switch value := v.Value.(type) {
 				case string:
 					if f.Split != "" {
@@ -337,7 +333,7 @@ func product(inputMap *ast.Matrix) []map[string]any {
 	result := []map[string]any{{}}
 
 	// Iterate over each slice in the slices
-	_ = inputMap.Range(func(key string, slice []any) error {
+	for key, slice := range inputMap.All() {
 		var newResult []map[string]any
 
 		// For each combination in the current result
@@ -357,8 +353,7 @@ func product(inputMap *ast.Matrix) []map[string]any {
 
 		// Update result with the new combinations
 		result = newResult
-		return nil
-	})
+	}
 
 	return result
 }