codeql icon indicating copy to clipboard operation
codeql copied to clipboard

Text format

Open mcandre opened this issue 1 year ago • 4 comments

Please implement text format console output, similar to how other linters work.

mcandre avatar May 27 '24 00:05 mcandre

Thanks for the suggestion. Could you elaborate a bit about the use-case for this feature? Note that CodeQL results are typically some complex than simple linter warning and often refer to multiple source location. Presenting an alert as a line of text on a single source line might not be enough to understand it.

aibaars avatar May 27 '24 11:05 aibaars

Console output has served as a simple, reliable, effective UX for an incredible number of earlier linters.

mcandre avatar Jun 16 '24 07:06 mcandre

https://github.com/github/codeql/issues/16594#issue-2318005421

majority131 avatar Jul 05 '24 13:07 majority131

A summary text view in the console provides an efficient way to rapidly improve large, complex repos. Any deep explanations of a rule can be documented elsewhere, such as on a wiki. Take, for example, the report structure of ShellCheck. It balances both needs quite well.

mcandre avatar Aug 27 '24 18:08 mcandre

Hi @mcandre,

As pointed out by @aibaars, CodeQL alerts are typically more complex than linter errors containing information from various parts of the code base that are not easily summarized to single lines. However, we support the SARIF output format that provided all the information you need and you can use this as a basis to output the format you prefer.

I'm closing this issue. If you have any follow-up questions, feel free to re-open this issue.

rvermeulen avatar Oct 15 '24 20:10 rvermeulen