Insights as a shareable report?

[emjayess]

Q	A
Bug report?	no
Feature request?	yes
Library version	{any}

Question

Is there a good way to generate a decent-looking shareable report / output?

It is something that I've been looking for, but have struggled with. It would be a very nice-to-have feature, to share with a team, to management, or especially in my case, onboarding new clients with proposals that take into consideration an objective measure of their existing codebase.

---

I realize there are a few output flags, like json, but I don't understand what or how json output is to be used after it's generated. I appreciate any and all insights!

[olivernybroe]

The point of json output, is that changing the format is a BC, while changing the normal output is not BC.

However JSON output does not have any UI to it.

[emjayess]

BC?

[50bhan]

@emjayess Breaking Changes (BC).

[emjayess]

Honorable mentions

• Implement output-format option #61 ~ Implement output-format option
• Implement option to output issues grouped by file #202 ~ Implement option to output issues grouped by file
• Improvement: add serve dashboard command / static page #232 ~ Improvement: add serve dashboard command / static page
  • add HTML formatter #258 ~ add HTML formatter

---

Seems like a presentation template that could ingest/interpret the json output format would be a nice addition, which a few folks seem to've tinkered with already (see also #258). Further, a good html result could then have a print stylesheet, thereby producing an easily shareable PDF report.

Screen/proof-of-concept posted by @Gummibeer in #232 (comment) and PR #258