ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/internal/command/views/json/testdata/diagnostic/error-with-empty-highlight-...

27 lines
476 B
JSON
Raw Normal View History

cli: Add comprehensive JSON diagnostic structure This commit adds a comprehensive JSON format for diagnostics, which ensures that all current diagnostic output can be semantically represented in a machine-readable format. The diagnostic formatter interface remains unchanged, but it first transforms its input via the JSON format to ensure that there is only one code path for creating the diagnostic data. The JSON diagnostic renderer extracts the non-presentational logic from the format package, and returns a structure which can either be marshaled into JSON or rendered as text. The resulting text diagnostic output is unchanged for all cases covered by unit tests and my own manual testing. Included in this commit are a number of golden reference files for the marshaled JSON output of a diagnostic. This format should change rarely if at all, and these are in place to ensure that any changes to the format are intentional and considered.
2021-03-11 18:08:47 +01:00
{
"severity": "error",
"summary": "You forgot something",
"detail": "Please finish your thought",
"range": {
"filename": "short.tf",
"start": {
"line": 1,
"column": 16,
"byte": 15
},
"end": {
"line": 1,
"column": 17,
"byte": 16
}
},
"snippet": {
"context": null,
"code": "bad source code",
"start_line": 1,
"highlight_start_offset": 15,
"highlight_end_offset": 15,
"values": []
}
}