Fix documentation for deprecated 'reports' object (Issue #5908) #5924
Conversation
This file contains hidden or 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
|
cortinico
reviewed
Mar 23, 2023
Comment on lines
95
to
100
| detekt { | ||
| reports.xml.required.set(true) | ||
| // reports.sarif.required.set(true) | ||
| reports { | ||
| xml.required.set(true) | ||
| // sarif.required.set(true) | ||
| } | ||
| } |
There was a problem hiding this comment.
The docs are still wrong. The problem is that the whole:
detekt {
- reports {
- ...
- }
}is deprecated. Reports should be configured using this approach:
https://detekt.dev/docs/gettingstarted/gradle#reports
Codecov Report
@@ Coverage Diff @@
## main #5924 +/- ##
============================================
- Coverage 84.56% 84.46% -0.11%
- Complexity 3782 3784 +2
============================================
Files 546 546
Lines 12933 12923 -10
Branches 2271 2268 -3
============================================
- Hits 10937 10915 -22
- Misses 863 877 +14
+ Partials 1133 1131 -2
... and 2 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
|
should i write a test case for the detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/FormattingRule.kt |
|
That's not necessary. Thanks to improve the documentation |
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.
I made a completely new branch and removed whitespaced and fixed the deprecated reports object.
Fixes #5908