bodand / cg3

Other
0 stars 0 forks source link

Central collected warning API #3

Closed bodand closed 1 year ago

bodand commented 1 year ago

As of v0.2.0, each check uses its own, slightly different format for outputting the collected report of warnings.

This should be standardized in a way that does not require each new check to reimplement the whole thing. And while I'm at it, this should also have a stable API for string the warnings. This would allow different output formats to be implemented; for example, we could export HTML which would make looking over warnings much easier.

bodand commented 1 year ago

After #2 is completed, all warnings will go through clang diagnostics.

In the chk3 library, we could implement a DiagnosticsConsumer that collects each warning in a standard format. This would allow the checks to not require storing their own diagnostics each in a different format.

After this, an exporter is trivial to implement, and could easily be replaced with custom ones, for example, the HTML one mentioned in the main issue text.