x/tools/go/analysis: accomodate multiple output formats in Diagnostic #32156
Labels
FrozenDueToAge
NeedsDecision
Feedback is required from experts, contributors, and/or the community before a change can be made.
Tools
This label describes issues relating to any tools in the x/tools repository.
Milestone
Right now, analyses report diagnostics, where a diagnostic consists of a position, category and message. This makes it difficult to accommodate multiple output formats. For editor integration, we want short, concise messages. These messages are usually restricted to one line, but may be occasionally multi-line. For interactive use in a terminal, we may want to offer a more verbose format that includes instructions on how to address the finding, or provide more information about the context of the finding. For interactive use in a browser, we would like to include hyperlinks, or possibly other markup. It is not feasible to address all these different media with a single message.
I am not proposing a concrete solution to the problem. Instead, I'd like to encourage discussion on how we can improve the situation.
/cc @matloob @ianthehat @mvdan @fatih
The text was updated successfully, but these errors were encountered: