[Deprecation] Add config `ignoreImport` #7878

atulgpt · 2025-01-09T15:27:02Z

This allows deprecation in imports

BraisGabin · 2025-01-10T09:01:21Z

...ting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/wrappers/ArgumentListWrapping.kt

@@ -31,7 +31,7 @@ class ArgumentListWrapping(config: Config) : FormattingRule(
    @Configuration("maximum line length")
    private val maxLineLength by configWithAndroidVariants(120, 100)

-    @Configuration("paremeter threshold to ignore rule")
+    @Configuration("parameter threshold to ignore rule")


If you move this change to other PR it will be merged automatically.

I have added the PR #7881

And reverted from here

BraisGabin · 2025-01-10T09:02:13Z

The title of this PR is wrong, right? There is nothing related with ignoreRuleParameterThreshold.

BraisGabin · 2025-01-10T09:05:07Z

...t-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/DeprecationSpec.kt

+                }
+            """.trimIndent()
+            assertThat(ignoredImportSubject.lintWithContext(env, code, deprecatedFile))
+                .isEmpty()


I don't like ignoreImport because it creates false negatives. Here the code is using deprecated code but the rule says nothing even when there are more usages of LegacyFeatureFlags outside the imports block.

I also don't like that we can't suppress an issue over an import. It bothers me a lot and I end up using full qualified names in places where I don't want but I think that's better than false negatives.

I also don't like that we can't suppress an issue over an import. same, and most of the users end up suppressing the whole file which prevents any future issue from surfacing

More general issue here is that people tend to suppress at unnecessarily higher level which could be lowered down. Import becomes especially problematic as you don't have option other than file suppression

I end up using full qualified names this is very hard to enforce across the team, also in most of cases using fully qualified name will report the line length violation

there are more usages of LegacyFeatureFlags outside the imports block I didn't get this? there are three usages, two are suppressed and since we are using ignoredImportSubject deprecation in Import is not being reported

Wow! My bad, I didn't see the @Suppress 🤦‍♂️. That have way more sense. I'll re-review this.

cortinico · 2025-02-19T23:52:29Z

detekt-rules-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/Deprecation.kt

@@ -21,15 +25,30 @@ class Deprecation(config: Config) : Rule(
    "Deprecated elements should not be used."
 ) {

+    @Configuration("Ignore deprecation in import statements")
+    private val ignoreImport: Boolean by config(false)


This should be plurals as we have excludeImports in another rule

Thanks for pointing out, I have renamed it to excludeImportStatements which is also being used in MaxLineLength rule

This allows deprecation in imports

codecov · 2025-02-23T20:08:50Z

Codecov Report

Attention: Patch coverage is 88.88889% with 1 line in your changes missing coverage. Please review.

Project coverage is 85.61%. Comparing base (acfffd3) to head (e0df908).
Report is 76 commits behind head on main.

Files with missing lines	Patch %	Lines
...gitlab/arturbosch/detekt/rules/bugs/Deprecation.kt	88.88%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #7878   +/-   ##
=========================================
  Coverage     85.60%   85.61%           
- Complexity     4224     4229    +5     
=========================================
  Files           574      574           
  Lines         13365    13372    +7     
  Branches       2540     2541    +1     
=========================================
+ Hits          11441    11448    +7     
  Misses          653      653           
  Partials       1271     1271

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

atulgpt · 2025-02-23T21:10:19Z

...t-rules-errorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/DeprecationSpec.kt

+    @Test
+    fun `does not report import location`() {
+        val deprecatedFile = """
+            package com.example.detekt.featureflag


Hi @BraisGabin now my TC is failing when I pass -Pcompile-test-snippets=true. I think this started failing after test api changes. Do you know if anything needs to be changed here?

detekt-ci · 2025-05-25T02:15:16Z

This PR is stale because it has been open 90 days with no activity. Please comment or this will be closed in 7 days.

detekt-ci added rules formatting labels Jan 9, 2025

vercel bot deployed to Preview January 9, 2025 15:31 View deployment

atulgpt force-pushed the fixes/7402/config-for-ignoring-import-deprecation branch from 48578dc to 3532aab Compare January 9, 2025 15:31

vercel bot deployed to Preview January 9, 2025 15:35 View deployment

BraisGabin reviewed Jan 10, 2025

View reviewed changes

atulgpt changed the title ~~[Deprecation] Add config ignoreRuleParameterThreshold~~ [Deprecation] Add config ignoreImport Jan 10, 2025

atulgpt force-pushed the fixes/7402/config-for-ignoring-import-deprecation branch from 3532aab to f08ddb3 Compare January 10, 2025 11:30

vercel bot deployed to Preview January 10, 2025 11:34 View deployment

cortinico requested changes Feb 19, 2025

View reviewed changes

atulgpt force-pushed the fixes/7402/config-for-ignoring-import-deprecation branch from 9e23d63 to 18b2297 Compare February 23, 2025 19:44

atulgpt added 2 commits February 24, 2025 01:20

[Deprecation] Add config ignoreRuleParameterThreshold

d73ca3a

This allows deprecation in imports

Rename ignoreImport to excludeImportStatements

e0df908

atulgpt force-pushed the fixes/7402/config-for-ignoring-import-deprecation branch from 18b2297 to e0df908 Compare February 23, 2025 20:00

vercel bot deployed to Preview February 23, 2025 20:08 View deployment

atulgpt commented Feb 23, 2025

View reviewed changes

detekt-ci added the stale label May 25, 2025

BraisGabin removed the stale label May 25, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[Deprecation] Add config `ignoreImport` #7878

[Deprecation] Add config `ignoreImport` #7878

Uh oh!

atulgpt commented Jan 9, 2025

Uh oh!

BraisGabin Jan 10, 2025

Uh oh!

atulgpt Jan 10, 2025

Uh oh!

atulgpt Jan 10, 2025

Uh oh!

BraisGabin commented Jan 10, 2025

Uh oh!

BraisGabin Jan 10, 2025

Uh oh!

atulgpt Jan 10, 2025

Uh oh!

BraisGabin Jan 10, 2025

Uh oh!

cortinico Feb 19, 2025

Uh oh!

atulgpt Feb 23, 2025

Uh oh!

codecov bot commented Feb 23, 2025 •

edited

Loading

Uh oh!

atulgpt Feb 23, 2025

Uh oh!

detekt-ci commented May 25, 2025

Uh oh!

Uh oh!

Uh oh!

[Deprecation] Add config ignoreImport #7878

Are you sure you want to change the base?

[Deprecation] Add config ignoreImport #7878

Uh oh!

Conversation

atulgpt commented Jan 9, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BraisGabin commented Jan 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Feb 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

detekt-ci commented May 25, 2025

Uh oh!

Uh oh!

[Deprecation] Add config `ignoreImport` #7878

[Deprecation] Add config `ignoreImport` #7878

codecov bot commented Feb 23, 2025 •

edited

Loading