-
-
Notifications
You must be signed in to change notification settings - Fork 755
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
Adds issue details to findings on FindingsReport and FileBasedFindingsReporter #4464
Changes from all commits
8973109
d9382ed
41d7f0b
b5b96c4
b6bee2b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
Ruleset1 - 10min debt | ||
TestSmell - [TestEntity] at TestFile.kt:1:1 | ||
TestSmell - [TestEntity] at TestFile.kt:1:1 | ||
TestSmell - [TestMessage] at TestFile.kt:1:1 | ||
TestSmell - [TestMessage] at TestFile.kt:1:1 | ||
Ruleset2 - 5min debt | ||
TestSmell - [TestEntity] at TestFile.kt:1:1 | ||
TestSmell - [TestMessage] at TestFile.kt:1:1 | ||
|
||
Overall debt: 15min |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
File1.kt - 10min debt | ||
TestSmell - [TestEntity] at File1.kt:1:1 | ||
TestSmell - [TestEntity] at File1.kt:1:1 | ||
TestSmell - [TestMessage] at File1.kt:1:1 | ||
TestSmell - [TestMessage] at File1.kt:1:1 | ||
File2.kt - 5min debt | ||
TestSmell - [TestEntity] at File2.kt:1:1 | ||
TestSmell - [TestMessage] at File2.kt:1:1 | ||
|
||
Overall debt: 15min |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Ruleset - 10min debt | ||
LongRule - [This is just a long message that should be truncated after a given threshold is (…)] at File.kt:1:1 | ||
MultilineRule - [A multiline message.] at File.kt:1:1 | ||
|
||
Overall debt: 10min |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,11 +17,11 @@ Similar to the console output, each line of the txt output represents a finding | |
finding signature to help edit [baseline files](gettingstarted/gradle.md). | ||
|
||
``` | ||
EmptyFunctionBlock - [apply] at /user/home/detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt:14:42 - Signature=DetektPlugin.kt$DetektPlugin${ } | ||
NoUnusedImports - [] at /user/home/detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt:9:1 - Signature=io.gitlab.arturbosch.detekt.DetektPlugin.kt:9 | ||
NoUnusedImports - [] at /user/home/detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt:10:1 - Signature=io.gitlab.arturbosch.detekt.DetektPlugin.kt:10 | ||
NoConsecutiveBlankLines - [] at /user/home/detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt:86:1 - Signature=io.gitlab.arturbosch.detekt.DetektPlugin.kt:86 | ||
UnusedPrivateMember - [registerDetektJvmTasks] at /user/home/detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt:17:5 - Signature=DetektPlugin.kt$DetektPlugin$private fun Project.registerDetektJvmTasks(extension: DetektExtension) | ||
EmptyFunctionBlock - [This empty block of code can be removed.] at /user/home/detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt:14:42 - Signature=DetektPlugin.kt$DetektPlugin${ } | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. One last question: are there scenario where this text can either:
Askign as if so, we should escape it as it would screw up the final reporting. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As far as I'm aware of, there's no checks or anything to prevent these to be the case. These scenarios could also affect There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I think it's something we can address should we face it. Ideally Truncate and ellipsis sounds like a decent way to clean this up, but it's something we can follow-up on. EDIT: Just noticed you implemented it 👍 We can fine tune it if needed |
||
NoUnusedImports - [Unused import] at /user/home/detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt:9:1 - Signature=io.gitlab.arturbosch.detekt.DetektPlugin.kt:9 | ||
NoUnusedImports - [Unused import] at /user/home/detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt:10:1 - Signature=io.gitlab.arturbosch.detekt.DetektPlugin.kt:10 | ||
NoConsecutiveBlankLines - [Needless blank line(s)] at /user/home/detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt:86:1 - Signature=io.gitlab.arturbosch.detekt.DetektPlugin.kt:86 | ||
UnusedPrivateMember - [Private function registerDetektJvmTasks is unused.] at /user/home/detekt/detekt-gradle-plugin/src/main/kotlin/io/gitlab/arturbosch/detekt/DetektPlugin.kt:17:5 - Signature=DetektPlugin.kt$DetektPlugin$private fun Project.registerDetektJvmTasks(extension: DetektExtension) | ||
``` | ||
|
||
### HTML | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cortinico I applied this treatment to handle the scenarios you've raised. As seen above, I've loosely set
REPORT_MESSAGE_SIZE_LIMIT
to be 80. There is a test that validates both truncation and space characters (\n
,\r
,\t
, ...).