ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/internal/command/views/json/testdata/diagnostic/error-whose-range-starts-at...

26 lines
442 B
JSON
Raw Normal View History

command/views/json: Never generate invalid diagnostic snippet offsets Because our snippet generator is trying to select whole lines to include in the snippet, it has some edge cases for odd situations where the relevant source range starts or ends directly at a newline, which were previously causing this logic to return out-of-bounds offsets into the code snippet string. Although arguably it'd be better for the original diagnostics to report more reasonable source ranges, it's better for us to report a slightly-inaccurate snippet than to crash altogether, and so we'll extend our existing range checks to check both bounds of the string and thus avoid downstreams having to deal with out-of-bounds indices. For completeness here I also added some similar logic to the human-oriented diagnostic formatter, which consumes the result of the JSON diagnostic builder. That's not really needed with the additional checks in the JSON diagnostic builder, but it's nice to reinforce that this code can't panic (in this way, at least) even if its input isn't valid.
2021-06-28 19:58:40 +02:00
{
"severity": "error",
"summary": "Invalid newline",
"detail": "How awkward!",
"range": {
"filename": "odd-comment.tf",
"start": {
"line": 2,
"column": 5,
"byte": 4
},
"end": {
"line": 3,
"column": 1,
"byte": 6
}
},
"snippet": {
"context": null,
"code": "#",
"start_line": 2,
"highlight_start_offset": 0,
"highlight_end_offset": 1,
"values": []
}
}