style: Create ForbiddenImportsRule to avoid java.io.File imports in l…

…ib and app projects
guicamest · Oct 18, 2023 · 5220120 · 5220120
1 parent bb69331
commit 5220120
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 13 deletions.
diff --git a/ktlintForbiddenImports/src/main/kotlin/com/sleepcamel/ktlint/ForbiddenImportsRule.kt b/ktlintForbiddenImports/src/main/kotlin/com/sleepcamel/ktlint/ForbiddenImportsRule.kt
@@ -1,9 +1,10 @@
 package com.sleepcamel.ktlint
 
-import com.pinterest.ktlint.rule.engine.core.api.ElementType
 import com.pinterest.ktlint.rule.engine.core.api.Rule
 import com.pinterest.ktlint.rule.engine.core.api.RuleId
 import org.jetbrains.kotlin.com.intellij.lang.ASTNode
+import org.jetbrains.kotlin.psi.KtImportDirective
+import org.jetbrains.kotlin.psi.stubs.elements.KtStubElementTypes
 
 class ForbiddenImportsRule : Rule(
     ruleId = RuleId("$CUSTOM_RULE_SET_ID:forbidden"),
@@ -14,17 +15,12 @@ class ForbiddenImportsRule : Rule(
         autoCorrect: Boolean,
         emit: (offset: Int, errorMessage: String, canBeAutoCorrected: Boolean) -> Unit
     ) {
-        if (node.elementType == ElementType.IMPORT_LIST) {
-            val children = node.getChildren(null)
-            if (children.isNotEmpty()) {
-                children.forEach { println(it) }
-                val first = children.first()
-                println(first)
+        if (node.elementType == KtStubElementTypes.IMPORT_DIRECTIVE) {
+            val importDirective = node.psi as KtImportDirective
+            val path = importDirective.importPath?.pathStr
+            if (path.orEmpty() == "java.io.File") {
+                emit(node.startOffset, "File has a forbidden import: $path", false)
             }
-//            if (node is LeafPsiElement && node.textMatches("var") &&
-//            getNonStrictParentOfType(node, KtStringTemplateEntry::class.java) == null
-//        ) {
-//            emit(node.startOffset, "Unexpected var, use val instead", false)
         }
     }
 }
diff --git a/ktlintForbiddenImports/src/test/kotlin/com/sleepcamel/ktlint/ForbiddenImportsRuleTest.kt b/ktlintForbiddenImports/src/test/kotlin/com/sleepcamel/ktlint/ForbiddenImportsRuleTest.kt
@@ -12,12 +12,12 @@ class ForbiddenImportsRuleTest {
         val fileContent = """
             import java.io.File
         """.trimIndent()
-        System.setProperty("ktlintDebug", "ast")
+
         wrappingRuleAssertThat(fileContent)
             .hasLintViolationWithoutAutoCorrect(
                 line = 1,
                 col = 1,
-                detail = "no-java-io-file-import"
+                detail = "File has a forbidden import: java.io.File"
             )
     }
 }