Add a new ConsoleReport format by picklebento · Pull Request #4027 · detekt/detekt

picklebento · 2021-08-09T06:32:48Z

This addresses #3423.

This new consoleReport will be turned off by default. For comparison, I will list the console report from other tools below:

Existing FindingsReport

> Task :detekt-generator:detekt FAILED
style - 50min debt
        MagicNumber - [getArgument] at /Users/cazhang/detekt/detekt-generator/src/main/kotlin/io/gitlab/arturbosch/detekt/generator/collection/RuleVisitor.kt:158:57
        MaxLineLength - [<anonymous>] at /Users/cazhang/detekt/detekt-generator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/collection/RuleCollectorSpec.kt:427:21
        MaxLineLength - [<anonymous>] at /Users/cazhang/detekt/detekt-generator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/collection/RuleCollectorSpec.kt:440:21
        MaxLineLength - [<anonymous>] at /Users/cazhang/detekt/detekt-generator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/collection/RuleCollectorSpec.kt:453:21
        MaxLineLength - [<anonymous>] at /Users/cazhang/detekt/detekt-generator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/collection/RuleCollectorSpec.kt:465:21
        MaxLineLength - [code] at /Users/cazhang/detekt/detekt-generator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/collection/RuleCollectorSpec.kt:527:1
        MaxLineLength - [code] at /Users/cazhang/detekt/detekt-generator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/collection/RuleCollectorSpec.kt:529:1
        MaxLineLength - [code] at /Users/cazhang/detekt/detekt-generator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/collection/RuleCollectorSpec.kt:606:1
        MaxLineLength - [code] at /Users/cazhang/detekt/detekt-generator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/collection/RuleCollectorSpec.kt:608:1

New LiteFindingsReport

/Users/cazhang/detekt/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/ReadableFindingsReport.kt:29:46: Missing spacing after "{" [SpacingAroundCurly]
/Users/cazhang/detekt/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/ReadableFindingsReport.kt:20:24: Missing newline after "(" [Indentation]
/Users/cazhang/detekt/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/ReadableFindingsReport.kt:25:17: Missing newline before ")" [Indentation]
/Users/cazhang/detekt/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/ReadableFindingsReport.kt:22:35: Missing newline after "(" [Indentation]
/Users/cazhang/detekt/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/ReadableFindingsReport.kt:26:28: Missing newline after "(" [Indentation]
/Users/cazhang/detekt/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/ReadableFindingsReport.kt:27:1: Unexpected indentation (12) (should be 16) [Indentation]

Checkstyle

[ant:checkstyle] [ERROR] /Users/cazhang/myrepo/messaging/MessagingRoutes.java:29: 'import' has more than 1 empty lines before. [EmptyLineSeparator]
[ant:checkstyle] [ERROR] /Users/cazhang/myrepo/messaging/MessagingRoutes.java:38:52: Use a single space to separate non-whitespace characters. [SingleSpaceSeparator]

Ktlint

/Users/cazhang/ktlint/ktlint-reporter-json/src/main/kotlin/com/pinterest/ktlint/reporter/json/JsonReporter.kt:13:30: Unexpected spacing after "("
/Users/cazhang/ktlint/ktlint-reporter-json/src/main/kotlin/com/pinterest/ktlint/reporter/json/JsonReporter.kt:13:31: Unnecessary space(s)

Kotlinc

w: /Users/cazhang/ktlint/ktlint-ruleset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/NoWildcardImportsRule.kt: (8, 1): Visibility must be specified in explicit API mode
w: /Users/cazhang/ktlint/ktlint-ruleset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/ParameterListWrappingRule.kt: (30, 1): Visibility must be specified in explicit API mode
w: /Users/cazhang/ktlint/ktlint-ruleset-standard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/ParameterListWrappingRule.kt: (125, 41): Name shadowed: adjustedIndent

codecov · 2021-08-09T06:43:10Z

Codecov Report

Merging #4027 (cc13bf6) into main (cbdb460) will not change coverage.
The diff coverage is 100.00%.

❗ Current head cc13bf6 differs from pull request most recent head c565616. Consider uploading reports for the commit c565616 to get more accurate results

@@            Coverage Diff            @@
##               main    #4027   +/-   ##
=========================================
  Coverage     83.51%   83.51%           
+ Complexity     3186     3185    -1     
=========================================
  Files           461      463    +2     
  Lines          9095     9095           
  Branches       1768     1767    -1     
=========================================
  Hits           7596     7596           
  Misses          570      570           
  Partials        929      929

Impacted Files	Coverage Δ
...t/generator/printer/defaultconfig/ConfigPrinter.kt	`92.10% <ø> (ø)`
...tlab/arturbosch/detekt/core/reporting/Reporting.kt	`94.11% <100.00%> (ø)`
...t/core/reporting/console/AbstractFindingsReport.kt	`100.00% <100.00%> (ø)`
.../core/reporting/console/FileBasedFindingsReport.kt	`100.00% <100.00%> (ø)`
...ch/detekt/core/reporting/console/FindingsReport.kt	`100.00% <100.00%> (ø)`
...etekt/core/reporting/console/LiteFindingsReport.kt	`100.00% <100.00%> (ø)`

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 cbdb460...c565616. Read the comment docs.

BraisGabin

I think that this should be the one turned on by default.

marschwar

Other than the name I really like this. The name seems to imply that all others are unreadable. Maybe something like LinePerFindingReport ?

cortinico · 2021-08-09T19:16:29Z

The name seems to imply that all others are unreadable

Agree. How about somethine like LiteFindingsReport or CompactFindingsReport?

cortinico

Great work 👍

cortinico · 2021-08-09T19:25:15Z

+ * Contains a clear read of the console report, where each line contains location, messages and issue id.
+ * See: https://detekt.github.io/detekt/configurations.html#console-reports
+ */
+class ReadableFindingsReport : ConsoleReport() {


Could we refactor FindingsReport and this class to a single hierarchy? Apparently the difference is just the (Map<String, List<Finding>>) -> String function that they're invoking.

I wouldn't call this ReadableFindingsReport. Is the other FindingsReport not readable? I would prefer to call it ConciseFindingsReport.

I changed the name to LiteFindingsReport as suggested above.

Add a new ConsoleReport format

a08ef8d

BraisGabin approved these changes Aug 9, 2021

View reviewed changes

picklebento marked this pull request as ready for review August 9, 2021 18:17

picklebento changed the title ~~[RFC] Add a new ConsoleReport format~~ Add a new ConsoleReport format Aug 9, 2021

marschwar approved these changes Aug 9, 2021

View reviewed changes

cortinico approved these changes Aug 9, 2021

View reviewed changes

Chao Zhang added 2 commits August 9, 2021 14:59

Consolidate duplicate console report logic to an abstract class

bd0d4f2

Update referenced names

ec77608

picklebento added this to the 1.19.0 milestone Aug 15, 2021

Chao Zhang added 2 commits September 17, 2021 09:13

Merge remote-tracking branch 'detekt/main' into consolereport

e4968fe

Address Detekt violations

c565616

picklebento merged commit 72d7e4f into detekt:main Sep 28, 2021

cortinico added the notable changes Marker for notable changes in the changelog label Sep 30, 2021

picklebento deleted the consolereport branch November 1, 2022 18:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add a new ConsoleReport format#4027

Add a new ConsoleReport format#4027
picklebento merged 5 commits intodetekt:mainfrom
picklebento:consolereport

picklebento commented Aug 9, 2021 •

edited by cortinico

Loading

Uh oh!

codecov bot commented Aug 9, 2021 •

edited

Loading

Uh oh!

BraisGabin left a comment

Uh oh!

marschwar left a comment

Uh oh!

cortinico commented Aug 9, 2021

Uh oh!

cortinico left a comment

Uh oh!

Uh oh!

cortinico Aug 9, 2021

Uh oh!

schalkms Aug 9, 2021

Uh oh!

picklebento Sep 17, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

picklebento commented Aug 9, 2021 • edited by cortinico Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Existing FindingsReport

New LiteFindingsReport

Checkstyle

Ktlint

Kotlinc

Uh oh!

codecov bot commented Aug 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

BraisGabin left a comment

Choose a reason for hiding this comment

Uh oh!

marschwar left a comment

Choose a reason for hiding this comment

Uh oh!

cortinico commented Aug 9, 2021

Uh oh!

cortinico left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cortinico Aug 9, 2021

Choose a reason for hiding this comment

Uh oh!

schalkms Aug 9, 2021

Choose a reason for hiding this comment

Uh oh!

picklebento Sep 17, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

picklebento commented Aug 9, 2021 •

edited by cortinico

Loading

codecov bot commented Aug 9, 2021 •

edited

Loading