Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation link for rules in html report #4799

Merged
merged 3 commits into from May 3, 2022

Conversation

themkat
Copy link
Contributor

@themkat themkat commented May 1, 2022

My attempt at #4792.

Adds a documentation link to the HTML reports, so we don't have to find it manually on the Detekt website. Looks like this:
example

Printed once for each rule, at the top before the rule violations are printed. The link in the picture is https://detekt.dev/docs/rules/empty-blocks/#emptyclassblock

@cortinico cortinico added this to the 1.21.0 milestone May 1, 2022
Copy link
Member

@BraisGabin BraisGabin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@codecov
Copy link

codecov bot commented May 1, 2022

Codecov Report

Merging #4799 (8b699d7) into main (22bc63d) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##               main    #4799   +/-   ##
=========================================
  Coverage     84.70%   84.71%           
  Complexity     3426     3426           
=========================================
  Files           491      491           
  Lines         11253    11256    +3     
  Branches       2069     2069           
=========================================
+ Hits           9532     9535    +3     
  Misses          676      676           
  Partials       1045     1045           
Impacted Files Coverage Δ
...n/io/github/detekt/report/html/HtmlOutputReport.kt 95.65% <100.00%> (+0.14%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 22bc63d...8b699d7. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants