search

webhintio / hint

💡 A hinting engine for the web
https://webhint.io/
Apache License 2.0
3.62k stars 670 forks source link

[Proposal] Support HTML reports #284

Closed patrick-steele-idem closed 6 years ago

patrick-steele-idem commented 7 years ago

It would be great if an HTML report could easily be generated and, for each rule, show the full description for the rule (rendered to HTML from [my-rule/README.md]()). Sometimes the CLI just doesn't cut it. In addition, it would be nice if maybe a link (file path or URL?) to the rule's README.md could be included in the output on the CLI.

molant commented 7 years ago

I think I would use a url to link to the rules details in the CLI. That should be easy to add to the current formatters and we can hopefully use a custom url shortner for that.

molant commented 7 years ago

@qzhou1607 this could be a fun one for you. What do you think? Still need to define how the exact output will be but I'm sure @sonarwhal/contributors can help with some ideas :)

qzhou1607-zz commented 7 years ago

@molant Sounds great to me. Should the html report just contain the same content as the output in the CLI?

molant commented 7 years ago

It should contain more data than the CLI. What @patrick-steele-idem proposed is a good start. There are other things to discuss now like:

molant commented 7 years ago

The plan at the moment is to use the same HTML as the one from the online scanner once https://github.com/sonarwhal/sonarwhal.com/pull/187 gets merged.

We need to decide how we want to keep the online scanner in sync with the HTML report, at least until we start adding things exclusive to the online like comparing over time or against the rest of the web.

DanielRuf commented 6 years ago

Any updates? It's merged now.

molant commented 6 years ago

Starting on that really soon 😊 We need to finish #1133 and https://github.com/webhintio/webhint.io/issues/466 and that's the next thing will be working on. We want to make the online scanner results more actionable for the user and at the same time separate it into its own module.

DanielRuf commented 6 years ago

But one question still exists: what is the difference between webhint and sonarwhal, why 2 different orgs and what is the future repo? This is not yet clear to me.

molant commented 6 years ago

We are in the process of renaming but we haven't finished yet.