feat: add task name to the json output #2256
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aleksandersh
force-pushed
the
feat/add-task-name-to-json-output
branch
from
bd4065f to
c58d59d
Compare
pd93
reviewed
May 12, 2025
task_test.go
Outdated
Comment on lines
242
to
261
| // 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 interface{}) TestOption { | ||
| return &fixtureTemplateDataTestOption{data: data} | ||
| } | ||
|
|
||
| type fixtureTemplateDataTestOption struct { | ||
| data interface{} | ||
| } | ||
|
|
||
| func (opt *fixtureTemplateDataTestOption) applyToExecutorTest(t *ExecutorTest) { | ||
| t.fixtureTemplateData = opt.data | ||
| } | ||
|
|
||
| func (opt *fixtureTemplateDataTestOption) applyToFormatterTest(t *FormatterTest) { | ||
| t.fixtureTemplateData = opt.data | ||
| } | ||
|
|
There was a problem hiding this comment.
Niceee! I really like this idea. In other tests we use a post-process function to remove absolute paths from the fixtures, but I was never really happy with that solution. This is much cleaner!
I wonder if we should provide a standardised set of variables to all tests for this purpose. No need to do this in this PR though.
There was a problem hiding this comment.
Thank you, Pete! I'm glad you found these changes interesting
pd93
reviewed
May 12, 2025
aleksandersh
force-pushed
the
feat/add-task-name-to-json-output
branch
from
c58d59d to
e1b6f4b
Compare
pd93
added a commit
that referenced
this pull request
May 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, nice to meet you, and thanks for developing the task tool!
Rationale
I'm implementing the tui client for the task. I have decided that the best way to integrate a user interface is to use the JSON output feature (
task --list --json).All works fine except the labels. If some tasks have the label field, the JSON output will contain it instead of the real name. Since I can't request the execution by the task label, the client is stuck here.
task/taskfile/ast/task.go
Line 53 in da4ce5b
I found the same problem in the vscode plugin (go-task/vscode-task#167) since it is integrated with the task in the same way.
Changes
I assume that it's not right to change the behavior of this field, because there are some tools which can rely on this. Therefore, I decided to add a separate field (
task) with the real task name, which can be used exactly for the purpose of executing the task.The new JSON output will look like below
{ "tasks": [ { "name": "foobar", "task": "foo", "desc": "task description", "summary": "", "aliases": [], "up_to_date": false, "location": { "line": 0, "column": 0, "taskfile": "" } } ], "location": "" }