Fix ForbiddenComment rule not checking for KDoc #3275
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ForbiddenComment now analyzes KDoc elements for forbidden comments. KDoc sections don't inherit from the PsiComment type. Hence, this rule needs to also gather and analyze KDocSection types. Fixes #3273
Codecov Report
@@ Coverage Diff @@
## master #3275 +/- ##
============================================
+ Coverage 80.07% 80.11% +0.03%
- Complexity 2653 2654 +1
============================================
Files 443 443
Lines 8096 8100 +4
Branches 1540 1538 -2
============================================
+ Hits 6483 6489 +6
Misses 789 789
+ Partials 824 822 -2
Continue to review full report at Codecov.
|
arturbosch
reviewed
Dec 11, 2020
detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt
Show resolved
Hide resolved
arturbosch
reviewed
Dec 11, 2020
detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt
Outdated
Show resolved
Hide resolved
arturbosch
reviewed
Dec 11, 2020
detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt
Outdated
Show resolved
Hide resolved
arturbosch
reviewed
Dec 11, 2020
| "defined as forbidden in detekt.")) | ||
| report( | ||
| CodeSmell( | ||
| issue, Entity.from(comment), "This comment contains text that has been " + |
There was a problem hiding this comment.
Suggested change
| issue, Entity.from(comment), "This comment contains text that has been " + | |
| issue, Entity.from(comment), "This comment contains '$it' that has been " + |
There was a problem hiding this comment.
We can actually be specific here. This would help when just reading the reports.
There was a problem hiding this comment.
This would then report the whole comment. I'm not sure whether we want to print the whole text. Detekt already outputs the flagged entity.
There was a problem hiding this comment.
it would be in that block TODO: for example.
Do you mean it outputs it in the html report?
The console report would just print `"ForbiddenComment - This comment contains text that has been defined as forbidden in detekt." right?
There was a problem hiding this comment.
Yes, thanks for the explanation. I'll change it. That makes sense.
arturbosch
approved these changes
Dec 11, 2020
This allows to document rule violations in the noncompliant section.
revert back to old style
BraisGabin
approved these changes
Dec 12, 2020
arturbosch
pushed a commit
that referenced
this pull request
Dec 21, 2020
* Fix ForbiddenComment rule not checking for KDoc ForbiddenComment now analyzes KDoc elements for forbidden comments. KDoc sections don't inherit from the PsiComment type. Hence, this rule needs to also gather and analyze KDocSection types. Fixes #3273 * Remove wildcard import * Add ForbiddenComment suppression to rule itself This allows to document rule violations in the noncompliant section. * Format report statement accordingly revert back to old style * Update report message to include the violated value
arturbosch
pushed a commit
that referenced
this pull request
Jan 16, 2021
* Fix ForbiddenComment rule not checking for KDoc ForbiddenComment now analyzes KDoc elements for forbidden comments. KDoc sections don't inherit from the PsiComment type. Hence, this rule needs to also gather and analyze KDocSection types. Fixes #3273 * Remove wildcard import * Add ForbiddenComment suppression to rule itself This allows to document rule violations in the noncompliant section. * Format report statement accordingly revert back to old style * Update report message to include the violated value
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ForbiddenComment now analyzes KDoc elements for forbidden comments.
KDoc sections don't inherit from the PsiComment type.
Hence, this rule needs to also gather and analyze KDocSection types.
Fixes #3273