Add rule deprecation mechanism and deprecate DuplicateCaseInWhenExpression, MissingWhenCase, RedundantElseInWhen by VitalyVPinchuk · Pull Request #5309 · detekt/detekt

VitalyVPinchuk · 2022-09-17T19:44:24Z

Close (#4973)
~~Exactly the same as deprecation.properties save for filename deprecation.rules~~.
Uses deprecation.properties to write deprecated rules.

github-actions · 2022-09-17T19:44:54Z

	Messages
📖	Thank you very much for making our website better ❤️!

Generated by 🚫 dangerJS against 77c61c3

...-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/config/validation/ConfigValidation.kt

schalkms

Thanks for that! Looks good!
I also prefer using the existing single file for this use case, as Nico mentioned.

...generator/src/main/kotlin/io/gitlab/arturbosch/detekt/generator/printer/DeprecatedPrinter.kt

VitalyVPinchuk · 2022-09-18T10:12:37Z

Updated, and now it uses single file.

detekt-core/src/main/resources/deprecation.properties

detekt-generator/src/main/kotlin/io/gitlab/arturbosch/detekt/generator/collection/Rule.kt

...rone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/DuplicateCaseInWhenExpression.kt

Co-authored-by: Nicola Corti <corti.nico@gmail.com>

…enerator/collection/Rule.kt Co-authored-by: Nicola Corti <corti.nico@gmail.com>

cortinico · 2022-09-19T15:04:03Z

You'll have to suppress the deprecation locally inside PotentialBugProvider as otherwise the CI is red.

w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/PotentialBugProvider.kt: (23, 13): 'DuplicateCaseInWhenExpression' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/PotentialBugProvider.kt: (24, 13): 'ElseCaseInsteadOfExhaustiveWhen' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/PotentialBugProvider.kt: (37, 13): 'MissingWhenCase' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/PotentialBugProvider.kt: (39, 13): 'RedundantElseInWhen' is deprecated. Rule deprecated as compiler performs this check by default

VitalyVPinchuk · 2022-09-19T16:21:55Z

You'll have to suppress the deprecation locally inside PotentialBugProvider as otherwise the CI is red.

w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/PotentialBugProvider.kt: (23, 13): 'DuplicateCaseInWhenExpression' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/PotentialBugProvider.kt: (24, 13): 'ElseCaseInsteadOfExhaustiveWhen' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/PotentialBugProvider.kt: (37, 13): 'MissingWhenCase' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/PotentialBugProvider.kt: (39, 13): 'RedundantElseInWhen' is deprecated. Rule deprecated as compiler performs this check by default

I did it like this, but it doesn't help

    @Suppress("DEPRECATION")
    override fun instance(config: Config): RuleSet = RuleSet(

cortinico · 2022-09-19T23:56:45Z

I think you'll have to inline it:

        listOf(
            AvoidReferentialEquality(config),
            Deprecation(config),
            DontDowncastCollectionTypes(config),
            DoubleMutabilityForCollection(config),
            @Suppress("DEPRECATION") DuplicateCaseInWhenExpression(config),
            ElseCaseInsteadOfExhaustiveWhen(config),
            EqualsAlwaysReturnsTrueOrFalse(config),

cortinico · 2022-09-20T11:16:55Z

You have more warnings:

w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/DuplicateCaseInWhenExpressionSpec.kt: (9, 27): 'DuplicateCaseInWhenExpression' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/ElseCaseInsteadOfExhaustiveWhenSpec.kt: (13, 27): 'ElseCaseInsteadOfExhaustiveWhen' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/MissingWhenCaseSpec.kt: (17, 31): 'MissingWhenCase' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/MissingWhenCaseSpec.kt: (312, 31): 'MissingWhenCase' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/RedundantElseInWhenSpec.kt: (13, 27): 'RedundantElseInWhen' is deprecated. Rule deprecated as compiler performs this check by default

VitalyVPinchuk · 2022-09-20T13:09:27Z

I think you'll have to inline it:

        listOf(
            AvoidReferentialEquality(config),
            Deprecation(config),
            DontDowncastCollectionTypes(config),
            DoubleMutabilityForCollection(config),
            @Suppress("DEPRECATION") DuplicateCaseInWhenExpression(config),
            ElseCaseInsteadOfExhaustiveWhen(config),
            EqualsAlwaysReturnsTrueOrFalse(config),

Yes, that worked. Thanks!
This way suppressed rules are ignored by RuleSetProviderCollector.kt, so I slightly modified visitCallExpression.

?.map { if (it is KtAnnotatedExpression) it.lastChild as KtCallExpression else it }

VitalyVPinchuk · 2022-09-20T13:19:31Z

You have more warnings:

w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/DuplicateCaseInWhenExpressionSpec.kt: (9, 27): 'DuplicateCaseInWhenExpression' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/ElseCaseInsteadOfExhaustiveWhenSpec.kt: (13, 27): 'ElseCaseInsteadOfExhaustiveWhen' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/MissingWhenCaseSpec.kt: (17, 31): 'MissingWhenCase' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/MissingWhenCaseSpec.kt: (312, 31): 'MissingWhenCase' is deprecated. Rule deprecated as compiler performs this check by default
w: /home/runner/work/detekt/detekt/detekt-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/RedundantElseInWhenSpec.kt: (13, 27): 'RedundantElseInWhen' is deprecated. Rule deprecated as compiler performs this check by default

Right.
I didn't see them while running ./gradlew clean build. Maybe there's a simple command to purge Gradle's cache without downloading dependencies?

cortinico · 2022-09-20T15:03:49Z

I didn't see them while running ./gradlew clean build. Maybe there's a simple command to purge Gradle's cache without downloading dependencies?

You should be able to replicate locally with:

./gradlew build -x detekt -PwarningsAsErrors=true

BraisGabin

I like your solution :)!

But I really think that we should not deprecate ElseCaseInsteadOfExhaustiveWhen.

detekt-core/src/main/resources/default-detekt-config.yml

website/versioned_docs/version-1.21.0/rules/potential-bugs.md

detekt-generator/src/test/resources/RuleSet.md

cortinico · 2022-09-21T10:40:34Z

Add rule deprecation mechanism

Can we also update the title of this PR mentioning which rule we deprecated?

- Revert docs for 1.21.0 - Exclude ElseCaseInsteadOfExhaustiveWhen rule - Mark deprecated with Strikethrough font.

codecov · 2022-09-21T11:35:03Z

Codecov Report

Merging #5309 (77c61c3) into main (15c19aa) will increase coverage by 85.84%.
The diff coverage is 88.88%.

@@             Coverage Diff             @@
##             main    #5309       +/-   ##
===========================================
+ Coverage        0   85.84%   +85.84%     
- Complexity      0     3727     +3727     
===========================================
  Files           0      513      +513     
  Lines           0    12035    +12035     
  Branches        0     2232     +2232     
===========================================
+ Hits            0    10331    +10331     
- Misses          0      611      +611     
- Partials        0     1093     +1093

Impacted Files	Coverage Δ
...t/generator/collection/RuleSetProviderCollector.kt	`78.31% <0.00%> (ø)`
...detekt/rules/bugs/DuplicateCaseInWhenExpression.kt	`100.00% <ø> (ø)`
...ab/arturbosch/detekt/rules/bugs/MissingWhenCase.kt	`92.85% <ø> (ø)`
...rturbosch/detekt/rules/bugs/RedundantElseInWhen.kt	`92.30% <ø> (ø)`
...arturbosch/detekt/generator/printer/RulePrinter.kt	`96.96% <75.00%> (ø)`
...lab/arturbosch/detekt/generator/collection/Rule.kt	`100.00% <100.00%> (ø)`
...urbosch/detekt/generator/collection/RuleVisitor.kt	`89.89% <100.00%> (ø)`
...osch/detekt/generator/printer/DeprecatedPrinter.kt	`100.00% <100.00%> (ø)`
...ator/printer/defaultconfig/RuleSetConfigPrinter.kt	`88.46% <100.00%> (ø)`
...turbosch/detekt/rules/bugs/PotentialBugProvider.kt	`100.00% <100.00%> (ø)`
... and 513 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

BraisGabin

LGTM Thank you so much for the contribution.

github-actions bot added core documentation rules labels Sep 17, 2022

vercel bot deployed to Preview September 17, 2022 19:49 View deployment

cortinico reviewed Sep 17, 2022

View reviewed changes

...-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/config/validation/ConfigValidation.kt Outdated Show resolved Hide resolved

schalkms reviewed Sep 18, 2022

View reviewed changes

...generator/src/main/kotlin/io/gitlab/arturbosch/detekt/generator/printer/DeprecatedPrinter.kt Outdated Show resolved Hide resolved

Add rule deprecation mechanism

3f08963

VitalyVPinchuk force-pushed the rules_deprecation branch from 97a901d to 3f08963 Compare September 18, 2022 10:05

github-actions bot removed the core label Sep 18, 2022

vercel bot deployed to Preview September 18, 2022 10:10 View deployment

cortinico reviewed Sep 18, 2022

View reviewed changes

VitalyVPinchuk and others added 2 commits September 18, 2022 17:52

Update detekt-core/src/main/resources/deprecation.properties

3c815c9

Co-authored-by: Nicola Corti <corti.nico@gmail.com>

Update detekt-generator/src/main/kotlin/io/gitlab/arturbosch/detekt/g…

679fffb

…enerator/collection/Rule.kt Co-authored-by: Nicola Corti <corti.nico@gmail.com>

vercel bot had a problem deploying to Preview September 18, 2022 15:01 Failure

Fix and reword

3af456f

vercel bot deployed to Preview September 18, 2022 16:16 View deployment

cortinico added the notable changes Marker for notable changes in the changelog label Sep 19, 2022

cortinico added this to the 1.22.0 milestone Sep 19, 2022

Suppress deprecation warnings in PotentialBugProvider.kt

897eee5

vercel bot deployed to Preview September 19, 2022 16:05 View deployment

vercel bot deployed to Preview September 20, 2022 10:41 View deployment

Suppress deprecation warnings in PotentialBugProvider.kt

cc947c5

VitalyVPinchuk added 2 commits September 20, 2022 15:36

Suppress deprecation warnings in PotentialBugProvider.kt

ce3a934

Suppress deprecation warnings

2344934

VitalyVPinchuk force-pushed the rules_deprecation branch from 14d7bad to 2344934 Compare September 20, 2022 12:57

vercel bot deployed to Preview September 20, 2022 13:04 View deployment

BraisGabin reviewed Sep 20, 2022

View reviewed changes

VitalyVPinchuk changed the title ~~Add rule deprecation mechanism~~ Add rule deprecation mechanism and deprecate DuplicateCaseInWhenExpression, MissingWhenCase, RedundantElseInWhen Sep 21, 2022

vercel bot deployed to Preview September 21, 2022 11:28 View deployment

Revert docs, exclude rule, mark deprecated with ~~

77c61c3

- Revert docs for 1.21.0 - Exclude ElseCaseInsteadOfExhaustiveWhen rule - Mark deprecated with Strikethrough font.

VitalyVPinchuk force-pushed the rules_deprecation branch from 31702d6 to 77c61c3 Compare September 21, 2022 11:34

vercel bot deployed to Preview September 21, 2022 11:39 View deployment

BraisGabin approved these changes Sep 21, 2022

View reviewed changes

BraisGabin merged commit 8784c78 into detekt:main Oct 4, 2022

VitalyVPinchuk deleted the rules_deprecation branch October 5, 2022 09:50

antonis added a commit to wordpress-mobile/WordPress-Android that referenced this pull request Jul 18, 2023

Removes deprecated MissingWhenCase rule detekt/detekt#5309

8991bd9

Uh oh!

Conversation

VitalyVPinchuk commented Sep 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

schalkms left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

VitalyVPinchuk commented Sep 18, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cortinico commented Sep 19, 2022

Uh oh!

VitalyVPinchuk commented Sep 19, 2022

Uh oh!

cortinico commented Sep 19, 2022

Uh oh!

cortinico commented Sep 20, 2022

Uh oh!

VitalyVPinchuk commented Sep 20, 2022

Uh oh!

VitalyVPinchuk commented Sep 20, 2022

Uh oh!

cortinico commented Sep 20, 2022

Uh oh!

BraisGabin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cortinico commented Sep 21, 2022

Uh oh!

codecov bot commented Sep 21, 2022 • 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

VitalyVPinchuk commented Sep 17, 2022 •

edited

Loading

github-actions bot commented Sep 17, 2022 •

edited

Loading

codecov bot commented Sep 21, 2022 •

edited

Loading