Skip to content
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

Remove deprecated configuration items #7306

Open
3flex opened this issue May 19, 2024 · 1 comment
Open

Remove deprecated configuration items #7306

3flex opened this issue May 19, 2024 · 1 comment
Labels
Milestone

Comments

@3flex
Copy link
Member

3flex commented May 19, 2024

Expected Behavior of the rule

Configuration items on the rule are all in use.

Context

Some are deprecated. These should be removed for detekt 2.

@3flex 3flex added the rules label May 19, 2024
@3flex 3flex added this to the 2.0.0 milestone May 19, 2024
@cortinico
Copy link
Member

For reference, those are the one I found:

detekt-rules-empty/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/empty/EmptyFunctionBlock.kt
25-    @Configuration("Excludes all the overridden functions")
26:    @Deprecated("Use `ignoreOverridden` instead")
27-    private val ignoreOverriddenFunctions: Boolean by config(false)

detekt-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/VariableNaming.kt
37-    @Configuration("ignores member properties that have the override modifier")
38:    @Deprecated("This configuration is ignored and will be removed in the future")
39-    @Suppress("UnusedPrivateMember")

detekt-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/FunctionParameterNaming.kt
32-    @Configuration("ignores overridden functions with parameters not matching the pattern")
33:    @Deprecated("Use `ignoreOverridden` instead")
34-    private val ignoreOverriddenFunctions: Boolean by config(true)
--
36-    @Configuration("ignores overridden functions with parameters not matching the pattern")
37:    @Deprecated("This configuration is ignored and will be removed in the future")
38-    @Suppress("DEPRECATION", "UnusedPrivateMember")

detekt-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/ConstructorParameterNaming.kt
34-    @Configuration("ignores constructor properties that have the override modifier")
35:    @Deprecated("This configuration is ignored and will be removed in the future")
36-    @Suppress("UnusedPrivateMember")

detekt-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/FunctionNaming.kt
34-    @Configuration("ignores functions that have the override modifier")
35:    @Deprecated("This configuration is ignored and will be removed in the future")
36-    @Suppress("UnusedPrivateMember")

detekt-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/BooleanPropertyNaming.kt
39-    @Configuration("ignores properties that have the override modifier")
40:    @Deprecated("This configuration is ignored and will be removed in the future")
41-    @Suppress("UnusedPrivateMember")

detekt-rules-naming/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/naming/MemberNameEqualsClassName.kt
64-    @Configuration("if overridden functions and properties should be ignored")
65:    @Deprecated("Use `ignoreOverridden` instead")
66-    private val ignoreOverriddenFunction: Boolean by config(true)

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/UseDataClass.kt
52-    @Configuration("allows to provide a list of annotations that disable this check")
53:    @Deprecated("Use `ignoreAnnotated` instead")
54-    private val excludeAnnotatedClasses: List<Regex> by config(emptyList<String>()) { list ->

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt
94-    @Configuration("forbidden comment strings")
95:    @Deprecated("Use `comments` instead, make sure you escape your text for Regular Expressions.")
96-    private val values: List<String> by config(emptyList())
--
113-    @Configuration("error message which overrides the default one")
114:    @Deprecated("Use `comments` and provide `reason` against each `value`.")
115-    private val customMessage: String by config("")

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/UnderscoresInNumericLiterals.kt
36-    @Configuration("Length under which base 10 numbers are not required to have underscores")
37:    @Deprecated("Use `acceptableLength` instead")
38-    private val acceptableDecimalLength: Int by config(5) { it - 1 }

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/AbstractClassCanBeConcreteClass.kt
57-    @Configuration("Allows you to provide a list of annotations that disable this check.")
58:    @Deprecated("Use `ignoreAnnotated` instead")
59-    private val excludeAnnotatedClasses: List<Regex> by config(emptyList<String>()) { list ->

detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/IgnoredReturnValue.kt
58-    @Configuration("if the rule should check only annotated methods")
59:    @Deprecated("Use `restrictToConfig` instead")
60-    private val restrictToAnnotatedMethods: Boolean by config(defaultValue = true)

detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/LongParameterList.kt
33-
34:    @Deprecated("Use `allowedFunctionParameters` and `allowedConstructorParameters` instead")
35-    @Configuration("number of parameters required to trigger the rule")

detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/Indentation.kt
28-    @Configuration("continuation indentation size")
29:    @Deprecated("`continuationIndentSize` is ignored by KtLint and will have no effect")
30-    @Suppress("UnusedPrivateMember")

Those rules are instead deprecated, perhaps we should just remove them:

detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/DuplicateCaseInWhenExpression.kt
31-@ActiveByDefault(since = "1.0.0")
32:@Deprecated("Rule deprecated as compiler performs this check by default")
33-class DuplicateCaseInWhenExpression(config: Config) : Rule(

detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/RedundantElseInWhen.kt
58-@ActiveByDefault(since = "1.2.0")
59:@Deprecated("Rule deprecated as compiler performs this check by default")
60-class RedundantElseInWhen(config: Config) : Rule(

detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/MissingWhenCase.kt
68-@RequiresTypeResolution
69:@Deprecated("Rule deprecated as compiler performs this check by default")
70-class MissingWhenCase(config: Config) : Rule(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants