detekt/detekt

Improve the html report

オープン

#5,607 opened on 2022/12/06

 (8 件のコメント) (6 件のリアクション) (1 人の担当者)Kotlin (834 件のフォーク)batch import
featuregood first issuehelp wanted

Repository metrics

Stars
 (6,942 個のスター)
PR merge metrics
 (PR metrics pending)

説明

I was answering at #5524 but I end up writing far too much so I'm moving out to a new issue.

In my ideal world, on the html report, I would like to see all the issues that were found (I would also like to see the ones that were suppressed and why they were suppressed). Of course the suppressed ones should be a bit hidden so they don't mess up the default report.

Also, at the bottom of the report, also a bit hidden, I would like to have the list of active rules that report nothing. And even more hidden the disabled rules.

And the final thing is that, every rule should show how it was configured and from where that configuration comes from and a diff with the default values.

The problem with that is that we will need a lot of thinking about how to create a template with all that information and keep the report still easy. We don't want to mess up with the default use case of this report: check why detekt is angry again.

We could split this in little pieces because there are thing here that can not be implemented with our current core.

I think that a report like this could help a lot about why detekt is doing what it is doing. And it should help to spot mud configurations on the configuration.

コントリビューターガイド