Ignore imports for assign in no-unused-imports rule (#2343) (#2382)

Removing this import results in compilation error when shorthand "=" is used instead of function `assign(..)`. Closes #2343
pinterest · Nov 27, 2023 · bfaa201 · bfaa201
1 parent 9452621
commit bfaa201
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 2 deletions.
diff --git a/...andard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/NoUnusedImportsRule.kt b/...andard/src/main/kotlin/com/pinterest/ktlint/ruleset/standard/rules/NoUnusedImportsRule.kt
@@ -298,8 +298,8 @@ public class NoUnusedImportsRule : StandardRule("no-unused-imports") {
                 "get", "set",
                 // invoke
                 "invoke",
-                // augmented assignments
-                "plusAssign", "minusAssign", "timesAssign", "divAssign", "modAssign",
+                // (augmented) assignment
+                "assign", "plusAssign", "minusAssign", "timesAssign", "divAssign", "modAssign",
                 // (in)equality
                 "equals",
                 // comparison

diff --git a/...rd/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/NoUnusedImportsRuleTest.kt b/...rd/src/test/kotlin/com/pinterest/ktlint/ruleset/standard/rules/NoUnusedImportsRuleTest.kt
@@ -856,4 +856,29 @@ class NoUnusedImportsRuleTest {
             """.trimIndent()
         noUnusedImportsRuleAssertThat(code).hasNoLintViolations()
     }
+
+    @Test
+    fun `Issue 2343 - Do not mark assign as unused import`() {
+        val code =
+            """
+            package com.github.erdi.ktlint.bug
+
+            import org.gradle.api.Plugin
+            import org.gradle.api.Project
+            import org.gradle.kotlin.dsl.assign
+            import javax.inject.Inject
+
+            class ExamplePlugin @Inject constructor() : Plugin<Project> {
+              override fun apply(project: Project) {
+                project.let {
+                  it.javaexec {
+                    mainClass = "com.github.erdi.ktlint.bug.ExampleMainClass"
+                  }
+                }
+              }
+            }
+            """.trimIndent()
+        noUnusedImportsRuleAssertThat(code)
+            .hasNoLintViolations()
+    }
 }