feat: add task name to json output (#2256)

formatter_test.go

@@ -218,3 +218,23 @@ func TestListDescInterpolation(t *testing.T) {
 		}),
 	)
 }
+
+func TestJsonListFormat(t *testing.T) {
+	t.Parallel()
+
+	fp, err := filepath.Abs("testdata/json_list_format/Taskfile.yml")
+	require.NoError(t, err)
+	NewFormatterTest(t,
+		WithExecutorOptions(
+			task.WithDir("testdata/json_list_format"),
+		),
+		WithListOptions(task.ListOptions{
+			FormatTaskListAsJSON: true,
+		}),
+		WithFixtureTemplateData(struct {
+			TaskfileLocation string
+		}{
+			TaskfileLocation: fp,
+		}),
+	)
+}

help.go

@@ -149,6 +149,7 @@ func (e *Executor) ToEditorOutput(tasks []*ast.Task, noStatus bool) (*editors.Ta
 		g.Go(func() error {
 			o.Tasks[i] = editors.Task{
 				Name:     tasks[i].Name(),
+				Task:     tasks[i].Task,
 				Desc:     tasks[i].Desc,
 				Summary:  tasks[i].Summary,
 				Aliases:  aliases,

internal/editors/output.go

@@ -9,6 +9,7 @@ type (
 	// Task describes a single task
 	Task struct {
 		Name     string    `json:"name"`
+		Task     string    `json:"task"`
 		Desc     string    `json:"desc"`
 		Summary  string    `json:"summary"`
 		Aliases  []string  `json:"aliases"`

task_test.go

@@ -45,6 +45,7 @@ type (
 		name                string
 		experiments         map[*experiments.Experiment]int
 		postProcessFns      []PostProcessFn
+		fixtureTemplateData any
 	}
 )
 
@@ -79,8 +80,12 @@ func (tt *TaskTest) writeFixture(
 	if goldenFileSuffix != "" {
 		goldenFileName += "-" + goldenFileSuffix
 	}
+	if tt.fixtureTemplateData != nil {
+		g.AssertWithTemplate(t, goldenFileName, tt.fixtureTemplateData, b)
+	} else {
 		g.Assert(t, goldenFileName, b)
 	}
+}
 
 // writeFixtureBuffer is a wrapper for writing the main output of the task to a
 // fixture file.
@@ -234,6 +239,26 @@ func (opt *setupErrorTestOption) applyToFormatterTest(t *FormatterTest) {
 	t.wantSetupError = true
 }
 
+// WithFixtureTemplateData sets up data defined in the golden file using golang
+// template. Useful if the golden file can change depending on the test.
+// Example template: {{ .Value }}
+// Example data definition: struct{ Value string }{Value: "value"}
+func WithFixtureTemplateData(data any) TestOption {
+	return &fixtureTemplateDataTestOption{data: data}
+}
+
+type fixtureTemplateDataTestOption struct {
+	data any
+}
+
+func (opt *fixtureTemplateDataTestOption) applyToExecutorTest(t *ExecutorTest) {
+	t.fixtureTemplateData = opt.data
+}
+
+func (opt *fixtureTemplateDataTestOption) applyToFormatterTest(t *FormatterTest) {
+	t.fixtureTemplateData = opt.data
+}
+
 // Post-processing
 
 // A PostProcessFn is a function that can be applied to the output of a test

testdata/json_list_format/Taskfile.yml

@@ -0,0 +1,6 @@
+version: '3'
+
+tasks:
+  foo:
+    label: "foobar"
+    desc: "task description"

testdata/json_list_format/testdata/TestJsonListFormat.golden

@@ -0,0 +1,18 @@
+{
+  "tasks": [
+    {
+      "name": "foobar",
+      "task": "foo",
+      "desc": "task description",
+      "summary": "",
+      "aliases": [],
+      "up_to_date": false,
+      "location": {
+        "line": 4,
+        "column": 3,
+        "taskfile": "{{ .TaskfileLocation }}"
+      }
+    }
+  ],
+  "location": "{{ .TaskfileLocation }}"
+}

website/docs/reference/cli.mdx

@@ -104,6 +104,7 @@ structure:
   "tasks": [
     {
       "name": "",
+      "task": "",
       "desc": "",
       "summary": "",
       "up_to_date": false,