rayan/go-task
1
0
Fork 0
mirror of https://github.com/go-task/task.git synced 2026-06-24 21:26:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add task location data to json output (#1056)

Browse Source 
* feat: add task location data to json output

* feat: add root taskfile location to --json output
This commit is contained in:
Pete Davison
2023-03-17 12:34:06 +00:00
committed by GitHub
parent 15ef1fa1c2
commit e40d2eec9e
11 changed files with 169 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/docs/api_reference.md
View File

@@ -34,6 +34,7 @@ variable
| `-I` | `--interval` | `string` | `5s` | Sets a different watch interval when using `--watch`, the default being 5 seconds. This string should be a valid [Go Duration](https://pkg.go.dev/time#ParseDuration). |
| `-l` | `--list` | `bool` | `false` | Lists tasks with description of current Taskfile. |
| `-a` | `--list-all` | `bool` | `false` | Lists tasks with or without a description. |
| | `--json` | `bool` | `false` | See [JSON Output](#json-output) |
| `-o` | `--output` | `string` | Default set in the Taskfile or `intervealed` | Sets output style: [`interleaved`/`group`/`prefixed`]. |
| | `--output-group-begin` | `string` | | Message template to print before a task's grouped output. |
| | `--output-group-end` | `string` | | Message template to print after a task's grouped output. |
@@ -47,6 +48,30 @@ variable
| | `--version` | `bool` | `false` | Show Task version. |
| `-w` | `--watch` | `bool` | `false` | Enables watch of the given task. |
## JSON Output
When using the `--json` flag in combination with either the `--list` or `--list-all` flags, the output will be a JSON object with the following structure:
```jsonc
{
"tasks": [
{
"name": "",
"desc": "",
"summary": "",
"up_to_date": false,
"location": {
"line": 54,
"column": 3,
"taskfile": "/path/to/Taskfile.yml"
}
},
// ...
],
"location": "/path/to/Taskfile.yml"
}
```
## Special Variables
There are some special variables that is available on the templating system: