Split UnusedPrivateMember #5722

drawers · 2023-01-23T17:30:34Z

Fixes #3418 where it was decided to split UnusedPrivateMember in a non-breaking way so that after the split:

The original rule is enabled by default
After the split, the rules are still enabled by default

I was not sure from the issue discussion whether to split into 2 or 3. I went for 3 because:

It allows individual configuration of each rule. For instance, a user might want to ignore unused parameters that begin with _ but not unused properties that begin with _.
It was suggested by the design of the visitors in the original version of UnusedPrivateMember
Detecting unused private functions benefits from type resolution whereas detecting private properties does not
Splitting helps with managing the many test cases

Diagram
Before

After

It's quite hard to review - the splitting of the UnusedPrivateMember functionality is mechanical but moving the test cases around is harder and requires more care. I guess I would recommend reviewing the individual commits.

…ivate properties

…eters

github-actions · 2023-01-23T17:31:10Z

	Warnings
⚠️	This PR is approved with no milestone set. If merged, it won't appear in the Detekt release notes.

	Messages
📖	Thanks for adding a new rule to Detekt ❤️

Generated by 🚫 dangerJS against ddd19eb

drawers · 2023-01-23T17:34:38Z

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

@@ -700,11 +700,17 @@ style:
    active: false
  UnusedImports:
    active: false
+  UnusedParameter:
+    active: true
+    allowedNames: '(_|ignored|expected|serialVersionUID)'


serialVersionUID is not likely to be a parameter name we want to ignore but I wanted to make this a non-breaking change.

I would suggest a follow up issue for all of the breaking changes that will further the clean up here (including things like renaming UnusedPrivateMember to UnusedPrivateFunction)

I guess we don't usually have parameters with names like ignored, expected, and serialVersionUID.

drawers · 2023-01-23T17:35:50Z

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedParameter.kt

+ */
+@ActiveByDefault(since = "1.23.0")
+class UnusedParameter(config: Config = Config.empty) : Rule(config) {
+    override val defaultRuleIdAliases: Set<String> = setOf("UNUSED_VARIABLE", "UNUSED_PARAMETER", "unused")


I kept "UNUSED_VARIABLE" as an alias even though this rule now only handles params. This was in order to preserve existing behavior. Maybe this can be tracked in the follow-up issue for 2.0 I talked about in the other comment?

drawers · 2023-01-23T17:36:32Z

...t-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMember.kt

@@ -125,7 +103,8 @@ private class UnusedFunctionVisitor(
                                KtTokens.MINUS,
                                KtTokens.MUL,
                                KtTokens.DIV,
-                                KtTokens.PERC -> operatorValue?.let { functionReferences["$it="] }.orEmpty()
+                                KtTokens.PERC,
+                                -> operatorValue?.let { functionReferences["$it="] }.orEmpty()


Change from running ktlint --format

drawers · 2023-01-23T17:45:05Z

...-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateParameterSpec.kt

-    @Nested
-    inner class `parameters in primary constructors` {
-        @Test
-        fun `reports unused parameter`() {
-            val code = """
-                class Test(unused: Any)
-            """.trimIndent()
-            assertThat(subject.lint(code)).hasSize(1)
-        }
-
-        @Test
-        fun `does not report used parameter for calling super`() {
-            val code = """
-                class Parent(val ignored: Any)
-                class Test(used: Any) : Parent(used)
-            """.trimIndent()
-            assertThat(subject.lint(code)).isEmpty()
-        }
-
-        @Test
-        fun `does not report used parameter in init block`() {
-            val code = """
-                class Test(used: Any) {
-                    init {
-                        used.toString()
-                    }
-                }
-            """.trimIndent()
-            assertThat(subject.lint(code)).isEmpty()
-        }
-
-        @Test
-        fun `does not report used parameter to initialize property`() {
-            val code = """
-                class Test(used: Any) {
-                    val usedString = used.toString()
-                }
-            """.trimIndent()
-            assertThat(subject.lint(code)).isEmpty()
-        }
-    }
-
-    @Nested
-    inner class `secondary parameters` {
-        @Test
-        fun `report unused parameters in secondary constructors`() {
-            val code = """
-                private class ClassWithSecondaryConstructor {
-                    constructor(used: Any, unused: Any) {
-                        used.toString()
-                    }
-
-                    // this is actually unused, but clashes with the other constructor
-                    constructor(used: Any)
-                }
-            """.trimIndent()
-            assertThat(subject.lint(code)).hasSize(1)
-        }
-    }
-


An unfortunate consequence of this refactor is that unused primary and secondary constructor params are now detected by UnusedPrivateProperty (they used to be detected by UnusedPrivateMember which handled everything together).

I wanted to keep this refactor focused on mechanical splitting and not introduce logic changes that would be even harder to review. I would suggest follow up on this in a tracking issue I talk about in the other comments to see if it's possible to move the checks into UnusedParameter

It might be reasonable given that a property can be defined from constructor's parameters, by adding val or var. If you can describe the behavior in the KDoc documentation it would be great

Thank you @chao2zhang - that seems like good suggestion. I added to the KDoc in 5897a31

drawers · 2023-01-23T17:46:18Z

...-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateParameterSpec.kt

@@ -10,7 +11,7 @@ import org.junit.jupiter.api.Test

 @KotlinCoreEnvironmentTest
 class UnusedPrivateParameterSpec(val env: KotlinCoreEnvironment) {


Can I rename this to UnusedParameterSpec to match the new rule? It seems to detect unused params for both public and private.

Yes please.

Thank you, done as b563ece

codecov · 2023-01-23T21:06:40Z

Codecov Report

Merging #5722 (ddd19eb) into main (73e015b) will decrease coverage by 0.05%.
The diff coverage is 85.71%.

@@             Coverage Diff              @@
##               main    #5722      +/-   ##
============================================
- Coverage     84.52%   84.48%   -0.05%     
- Complexity     3731     3742      +11     
============================================
  Files           544      546       +2     
  Lines         12759    12791      +32     
  Branches       2232     2233       +1     
============================================
+ Hits          10785    10806      +21     
- Misses          864      869       +5     
- Partials       1110     1116       +6

Impacted Files	Coverage Δ
...b/arturbosch/detekt/rules/style/UnusedParameter.kt	`77.35% <77.35%> (ø)`
...turbosch/detekt/rules/style/UnusedPrivateMember.kt	`92.22% <88.88%> (-0.64%)`	⬇️
...rbosch/detekt/rules/style/UnusedPrivateProperty.kt	`92.72% <92.72%> (ø)`
...rturbosch/detekt/rules/style/StyleGuideProvider.kt	`100.00% <100.00%> (ø)`

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

…roperty so it doesn't become a breaking change

…nstructor params

schalkms

I haven't reviewed in detail, but I think after the restructuring the code looks way cleaner than before.
After the merge conflict is resolved, I think we should merge this asap.

drawers · 2023-02-05T19:26:48Z

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMemberSpec.kt

@@ -383,7 +383,35 @@ class UnusedPrivateMemberSpec(val env: KotlinCoreEnvironment) {
    }

    @Nested
-    inner class `operators` {
+    inner class `main methods` {


Hey @schalkms thank you for performing the merge 🙏 but I think this main methods now needs to be in UnusedParameterSpec.kt rather than in UnusedPrivateMemberSpec.kt. That was how it was in the original patch I submitted since those test cases now cover UnusedParameter.kt

@schalkms would you prefer me to add a commit to address this?

Good catch. Btw, sorry for messing around with the merge.

@drawers you were a few seconds faster. 😉

@schalkms I added a commit ddd19eb to address this. If I take Chao's last commit before the merge as authoritative (1e4bcb8) then I do:

git diff --name-only 1e4bcb8 | grep Unused

I get:

detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMemberSpec.kt

Then if I do:

git diff 1e4bcb8 detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMemberSpec.kt

I get:

diff --git a/detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMemberSpec.kt b/detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMemberSpec.kt index 2dbf7673d3..237df91e75 100644 --- a/detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMemberSpec.kt +++ b/detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnusedPrivateMemberSpec.kt @@ -383,7 +383,7 @@ class UnusedPrivateMemberSpec(val env: KotlinCoreEnvironment) { } @Nested - inner class `operators` { + inner class Operators { @Test fun `does not report used plus operator - #1354`() {

So we end up with only the change from renaming inner class operators to inner class Operators and nothing else. Which I think is what we want.

inner class operators {
to
inner class Operators {

Yes 🙏

We could also rollback the merge and do a rebase. That might be easier to grasp.

@schalkms yes if you would prefer me to rebase then I don't mind doing it just let me know 👍
(sorry about leaving the branch to go stale, I didn't anticipate another PR touching that test)

@drawers if we are good to go after the merge, we are fine, no need to do another rebase then, IMHO.

@schalkms looks okay to me now!

drawers added 21 commits January 23, 2023 20:27

Run ktlint --format on files about to be touched

968683f

Make UnusedPrivateMember focus on private functions

7cb6c0f

Extract UnusedParameter

806a415

Extract UnusedParameter

429142c

Extract UnusedPrivateProperty

09a7c6b

Move first batch of property tests from inside UnusedPrivateMemberSpec

7c50787

Move second batch of property tests from inside UnusedPrivateMemberSpec

eb11585

Readjust expectations in test now that subject only detects unused pr…

a86e950

…ivate properties

Move over next batch of property tests from UnusedPrivateMemberSpec

7ff9c21

Move one test from "unused class declarations which are allowed"

39491ae

Move "nested class declarations" from UnusedPrivateMemberSpec

49df7cb

Split "error messages"

939c679

Move "suppress unused property warning annotations"

f6ffe46

Move "main methods" inner test class

2406a24

Move "backtick identifiers" inner test class

8048a00

Move "backtick identifiers" inner test class for unused private param…

4376627

…eters

Split "highlights declaration name"

93f090d

Move "parameter with the same name as named argument"

99a350b

Split "actual functions and classes"

636b3ad

Move "properties in primary constructors"

18830f8

Fix typo

5227986

github-actions bot added the rules label Jan 23, 2023

vercel bot deployed to Preview January 23, 2023 17:35 View deployment

Fix disabled tests

9241ae4

drawers commented Jan 23, 2023

View reviewed changes

vercel bot deployed to Preview January 23, 2023 17:48 View deployment

Add alias "UnusedPrivateMember" to UnusedParameter and UnusedPrivateP…

8c4c509

…roperty so it doesn't become a breaking change

vercel bot deployed to Preview January 23, 2023 21:14 View deployment

drawers added 3 commits January 26, 2023 05:16

Rename "UnusedPrivateParameterSpec" to "UnusedParameterSpec"

b563ece

Adjust KDoc to say "source file" instead of "class etc." for clarity

5a3a901

Adjust KDoc to explain how UnusedPrivateProperty can detect unused co…

5897a31

…nstructor params

vercel bot deployed to Preview January 25, 2023 16:28 View deployment

inline method

1e4bcb8

vercel bot deployed to Preview January 28, 2023 01:59 View deployment

chao2zhang approved these changes Jan 28, 2023

View reviewed changes

schalkms reviewed Feb 5, 2023

View reviewed changes

Merge branch 'main' into fix-3418-split

8f9a9e5

vercel bot deployed to Preview February 5, 2023 19:26 View deployment

drawers commented Feb 5, 2023

View reviewed changes

Remove duplicate main methods inner class after merge

ddd19eb

vercel bot deployed to Preview February 5, 2023 21:24 View deployment

schalkms merged commit f259aed into detekt:main Feb 5, 2023

schalkms added this to the 1.23.0 milestone Feb 5, 2023

cortinico added the notable changes Marker for notable changes in the changelog label Feb 12, 2023

BraisGabin mentioned this pull request Feb 21, 2023

Reduce configuration of UnusedPrivateMember's split rules #5800

Merged

TWiStErRob mentioned this pull request Apr 4, 2023

#unusedparameter anchor missing from web site rule docs #5964

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split UnusedPrivateMember #5722

Split UnusedPrivateMember #5722

drawers commented Jan 23, 2023 •

edited

github-actions bot commented Jan 23, 2023 •

edited

drawers Jan 23, 2023

chao2zhang Jan 28, 2023

drawers Jan 23, 2023 •

edited

drawers Jan 23, 2023

drawers Jan 23, 2023 •

edited

chao2zhang Jan 25, 2023

drawers Jan 25, 2023

drawers Jan 23, 2023

chao2zhang Jan 25, 2023

drawers Jan 25, 2023

codecov bot commented Jan 23, 2023 •

edited

schalkms left a comment

drawers Feb 5, 2023

drawers Feb 5, 2023

schalkms Feb 5, 2023

schalkms Feb 5, 2023

drawers Feb 5, 2023

schalkms Feb 5, 2023

schalkms Feb 5, 2023

drawers Feb 5, 2023

schalkms Feb 5, 2023

drawers Feb 5, 2023

		@@ -10,7 +11,7 @@ import org.junit.jupiter.api.Test

		@KotlinCoreEnvironmentTest
		class UnusedPrivateParameterSpec(val env: KotlinCoreEnvironment) {

Split UnusedPrivateMember #5722

Split UnusedPrivateMember #5722

Conversation

drawers commented Jan 23, 2023 • edited

github-actions bot commented Jan 23, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drawers Jan 23, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drawers Jan 23, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jan 23, 2023 • edited

Codecov Report

schalkms left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drawers commented Jan 23, 2023 •

edited

github-actions bot commented Jan 23, 2023 •

edited

drawers Jan 23, 2023 •

edited

drawers Jan 23, 2023 •

edited

codecov bot commented Jan 23, 2023 •

edited