Generates TASK_SOURCES and TASK_GENERATES variables, as well as allows you to loop over tasks and see their definitions.

Author: fhofherr

compiler.go

@@ -12,6 +12,7 @@ import (
 	"github.com/go-task/task/v3/internal/env"
 	"github.com/go-task/task/v3/internal/execext"
 	"github.com/go-task/task/v3/internal/filepathext"
+	"github.com/go-task/task/v3/internal/fingerprint"
 	"github.com/go-task/task/v3/internal/logger"
 	"github.com/go-task/task/v3/internal/templater"
 	"github.com/go-task/task/v3/internal/version"
@@ -197,19 +198,99 @@ func (c *Compiler) ResetCache() {
 	c.dynamicCache = nil
 }
 
-func (c *Compiler) getSpecialVars(t *ast.Task, call *Call) (map[string]string, error) {
-	allVars := map[string]string{
+func (c *Compiler) getSpecialVars(t *ast.Task, call *Call) (map[string]any, error) {
+	allVars := map[string]any{
 		"TASK_EXE":         filepath.ToSlash(os.Args[0]),
 		"ROOT_TASKFILE":    filepathext.SmartJoin(c.Dir, c.Entrypoint),
 		"ROOT_DIR":         c.Dir,
 		"USER_WORKING_DIR": c.UserWorkingDir,
 		"TASK_VERSION":     version.GetVersion(),
 	}
 	if t != nil {
+		taskDir := filepathext.SmartJoin(c.Dir, t.Dir)
+
 		allVars["TASK"] = t.Task
-		allVars["TASK_DIR"] = filepathext.SmartJoin(c.Dir, t.Dir)
+		allVars["TASK_DIR"] = taskDir
 		allVars["TASKFILE"] = t.Location.Taskfile
 		allVars["TASKFILE_DIR"] = filepath.Dir(t.Location.Taskfile)
+
+		// Template and expand shell variables for both Sources and Generates
+		envVars := env.GetEnviron()
+		// Add the special vars we've built so far to the cache
+		for k, v := range allVars {
+			envVars.Set(k, ast.Var{Value: v})
+		}
+		// Add taskfile variables to the cache so they're available for templating
+		// Note: Variables that reference TASK_SOURCES or TASK_GENERATES won't work here,
+		// but simple string variables like C_EXT: c will work fine
+		for k, v := range c.TaskfileEnv.All() {
+			envVars.Set(k, v)
+		}
+		for k, v := range c.TaskfileVars.All() {
+			envVars.Set(k, v)
+		}
+		for k, v := range t.IncludeVars.All() {
+			envVars.Set(k, v)
+		}
+		for k, v := range t.IncludedTaskfileVars.All() {
+			envVars.Set(k, v)
+		}
+		for k, v := range t.Vars.All() {
+			envVars.Set(k, v)
+		}
+		if call != nil {
+			for k, v := range call.Vars.All() {
+				envVars.Set(k, v)
+			}
+		}
+		cache := &templater.Cache{Vars: envVars}
+
+		// Template Sources
+		templatedSources := templater.ReplaceGlobs(t.Sources, cache)
+		if err := cache.Err(); err != nil {
+			return allVars, fmt.Errorf("template sources: %v", err)
+		}
+		// Expand shell variables in Sources and then expand globs to actual file paths
+		expandedSources := make([]*ast.Glob, len(templatedSources))
+		for i, g := range templatedSources {
+			expanded, err := execext.ExpandLiteral(g.Glob)
+			if err != nil {
+				return allVars, fmt.Errorf("expand shell variables in source glob %q: %v", g.Glob, err)
+			}
+			expandedSources[i] = &ast.Glob{Glob: expanded, Negate: g.Negate}
+		}
+		taskSources, err := fingerprint.Globs(taskDir, expandedSources)
+		if err != nil {
+			return allVars, fmt.Errorf("expand globs: %v", err)
+		}
+		// Convert absolute paths to relative paths (relative to root directory)
+		relativeSources := make([]string, len(taskSources))
+		for i, source := range taskSources {
+			rel, err := filepath.Rel(c.Dir, source)
+			if err != nil {
+				// If relative path calculation fails, use the original path
+				relativeSources[i] = source
+			} else {
+				relativeSources[i] = filepath.ToSlash(rel)
+			}
+		}
+		allVars["TASK_SOURCES"] = relativeSources
+
+		// Template Generates
+		templatedGenerates := templater.ReplaceGlobs(t.Generates, cache)
+		if err := cache.Err(); err != nil {
+			return allVars, fmt.Errorf("template generates: %v", err)
+		}
+		// Expand shell variables in Generates, but keep glob patterns intact
+		taskGenerates := make([]string, len(templatedGenerates))
+		for i, g := range templatedGenerates {
+			expanded, err := execext.ExpandLiteral(g.Glob)
+			if err != nil {
+				return allVars, fmt.Errorf("expand shell variables in generate glob %q: %v", g.Glob, err)
+			}
+			taskGenerates[i] = expanded
+		}
+		allVars["TASK_GENERATES"] = taskGenerates
 	} else {
 		allVars["TASK"] = ""
 		allVars["TASK_DIR"] = ""

executor_test.go

@@ -367,6 +367,8 @@ func TestSpecialVars(t *testing.T) {
 		"print-taskfile",
 		"print-taskfile-dir",
 		"print-task-dir",
+		"print-task-sources",
+		"print-task-sources-empty",
 		// Included
 		"included:print-task",
 		"included:print-root-dir",
@@ -382,6 +384,7 @@ func TestSpecialVars(t *testing.T) {
 					task.WithDir(dir),
 					task.WithSilent(true),
 					task.WithVersionCheck(true),
+					task.WithForce(true),
 				),
 				WithTask(test),
 				WithFixtureTemplating(),

testdata/special_vars/Taskfile.yml

@@ -22,3 +22,25 @@ tasks:
   print-task-dir:
     dir: 'foo'
     cmd: echo {{.TASK_DIR}}
+
+  print-task-sources:
+    sources:
+      - sources-as-var/**/*.txt
+    cmds:
+      - printf "{{.TASK_SOURCES | sortAlpha | join "\n"}}\n"
+
+  print-task-sources-empty:
+    # No sources defined, yet we try to use TASK_SOURCES.
+    cmds:
+      - echo "{{.TASK_SOURCES}}"
+
+  print-task-generates:
+    generates:
+      - generates-as-var/**/*.txt
+    cmds:
+      - printf "{{.TASK_GENERATES | sortAlpha | join "\n"}}\n"
+
+  print-task-generates-empty:
+    # No generates defined, yet we try to use TASK_GENERATES.
+    cmds:
+      - echo "{{.TASK_GENERATES}}"

testdata/special_vars/generates-as-var/file.txt

@@ -0,0 +1,2 @@
+test file
+

testdata/special_vars/generates-as-var/subdir1/file.txt

@@ -0,0 +1,2 @@
+test file
+

testdata/special_vars/generates-as-var/subdir2/file.txt

@@ -0,0 +1,2 @@
+test file
+

testdata/special_vars/sources-as-var/file.txt

@@ -0,0 +1 @@
+[]