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

Show information from @active in the website #3569

Merged
merged 2 commits into from
Mar 21, 2021

Conversation

cortinico
Copy link
Member

Fixes #3568

The information from the @active KDoc annotation can be easily added to the website to make easier for our user to understand if a rule is active or not.

I've also cleaned up a bit the @since annotation as it was not really used.

@codecov
Copy link

codecov bot commented Mar 17, 2021

Codecov Report

Merging #3569 (f306009) into master (dde5fae) will increase coverage by 0.00%.
The diff coverage is 65.00%.

❗ Current head f306009 differs from pull request most recent head f8f18d9. Consider uploading reports for the commit f8f18d9 to get more accurate results
Impacted file tree graph

@@            Coverage Diff            @@
##             master    #3569   +/-   ##
=========================================
  Coverage     77.53%   77.53%           
- Complexity     2829     2835    +6     
=========================================
  Files           464      464           
  Lines          8769     8779   +10     
  Branches       1713     1720    +7     
=========================================
+ Hits           6799     6807    +8     
  Misses         1046     1046           
- Partials        924      926    +2     
Impacted Files Coverage Δ Complexity Δ
.../main/kotlin/io/gitlab/arturbosch/detekt/Detekt.kt 0.00% <0.00%> (ø) 0.00 <0.00> (ø)
...tlab/arturbosch/detekt/DetektCreateBaselineTask.kt 0.00% <0.00%> (ø) 0.00 <0.00> (ø)
...in/kotlin/io/github/detekt/report/xml/XmlEscape.kt 64.28% <ø> (ø) 3.00 <0.00> (ø)
...turbosch/detekt/rules/bugs/NullableToStringCall.kt 76.19% <ø> (ø) 21.00 <0.00> (ø)
...t/rules/naming/NonBooleanPropertyPrefixedWithIs.kt 85.18% <ø> (ø) 12.00 <0.00> (ø)
...kt/rules/style/LibraryEntitiesShouldNotBePublic.kt 83.33% <ø> (ø) 7.00 <0.00> (ø)
...b/arturbosch/detekt/rules/style/UseCheckNotNull.kt 90.00% <ø> (ø) 3.00 <0.00> (-1.00)
...arturbosch/detekt/rules/style/UseRequireNotNull.kt 90.90% <ø> (ø) 5.00 <0.00> (ø)
...etekt/rules/coroutines/RedundantSuspendModifier.kt 57.14% <50.00%> (-1.95%) 20.00 <5.00> (ø)
...enerator/printer/rulesetpage/RuleSetPagePrinter.kt 86.36% <66.66%> (-1.45%) 18.00 <0.00> (+2.00) ⬇️
... and 3 more

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 dde5fae...f8f18d9. Read the comment docs.

@cortinico cortinico added the housekeeping Marker for housekeeping tasks and refactorings label Mar 17, 2021
@cortinico cortinico added this to the 1.17.0 milestone Mar 17, 2021
### NoUnitKeyword

removes :Unit

**Active**: Yes - Since v1.16.0
Copy link
Member

Choose a reason for hiding this comment

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

Should we make it more clear that this is a default value? I mean, that this rule is active by default.

Copy link
Member Author

Choose a reason for hiding this comment

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

How about the label it as "Active by default"?

Copy link
Member

Choose a reason for hiding this comment

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

Add it just for the ones that are active by default? I like it

Copy link
Member Author

Choose a reason for hiding this comment

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

I've added it for both actually. I think it's better to be explicit rather than implicit, or is there a reason why we want to hide it for disabled rules?

Copy link
Member Author

Choose a reason for hiding this comment

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

Going to merge this as it is, and we can still re-discuss this if needed.

@cortinico cortinico merged commit 091dc91 into detekt:master Mar 21, 2021
@cortinico cortinico deleted the nc/active-since branch March 21, 2021 11:05
@cortinico cortinico modified the milestones: 1.17.0, 1.16.1 Mar 21, 2021
@chao2zhang chao2zhang modified the milestones: 1.16.1, 1.17.0 Mar 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Marker for housekeeping tasks and refactorings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add more info about rules to website
4 participants