Fix detekt rule for PsiUtilCore (#2608)

Author: rli

detekt-rules/src/main/kotlin/software/aws/toolkits/gradle/detekt/rules/BannedPatternRule.kt

@@ -15,18 +15,20 @@ class BannedPatternRule(private val patterns: List<BannedPattern>) : Rule() {
     override val issue = Issue("BannedPattern", Severity.Defect, "Banned calls", Debt.FIVE_MINS)
 
     override fun visitKtFile(file: KtFile) {
-        super.visitKtFile(file)
+        var offset = 0
         file.text.split("\n").forEachIndexed { line, text ->
             patterns.forEach { pattern ->
                 val match = pattern.regex.find(text) ?: return@forEach
                 report(
                     CodeSmell(
                         issue,
-                        Entity.from(file),
-                        message = "[${line + 1}:${match.range.first + 1}] ${pattern.message}"
+                        Entity.from(file, offset + match.range.first),
+                        message = pattern.message
                     )
                 )
             }
+            // account for delimiter
+            offset += text.length + 1
         }
     }
 
@@ -42,7 +44,7 @@ class BannedPatternRule(private val patterns: List<BannedPattern>) : Rule() {
                 "PsiUtil (java-api.jar) is not available in all IDEs, use PsiManager.getInstance(project).findFile() instead"
             ),
             BannedPattern(
-                """com\.intellij\.psi\.util\.PsiUtil""".toRegex(),
+                """com\.intellij\.psi\.util\.PsiUtil$""".toRegex(),
                 "PsiUtil (java-api.jar) is not available in all IDEs, use PsiUtilCore or PsiManager instead (platform-api.jar)"
             )
         )

detekt-rules/src/test/kotlin/BannedPatternRuleTest.kt

@@ -21,7 +21,9 @@ class BannedPatternRuleTest {
             )
         )
             .hasOnlyOneElementSatisfying {
-                it.id == "BannedPattern" && it.message == "[2:5] Use of method blah() is banned."
+                it.id == "BannedPattern" && it.message == "Use of method blah() is banned." &&
+                    it.location.source.line == 2 &&
+                    it.location.source.column == 5
             }
     }
 
@@ -30,7 +32,7 @@ class BannedPatternRuleTest {
         val rule = BannedPatternRule(BannedPatternRule.DEFAULT_PATTERNS)
         assertThat(
             rule.lint(
-                """ 
+                """
             import com.intellij.psi.util.PsiUtil
             class DockerfileParser(private val project: Project) {
                 fun parse(virtualFile: VirtualFile): DockerfileDetails? {
@@ -43,11 +45,33 @@ class BannedPatternRuleTest {
             .hasSize(2)
             .anyMatch {
                 it.id == "BannedPattern" &&
-                    it.message == "[1:8] PsiUtil (java-api.jar) is not available in all IDEs, use PsiUtilCore or PsiManager instead (platform-api.jar)"
+                    it.message == "PsiUtil (java-api.jar) is not available in all IDEs, use PsiUtilCore or PsiManager instead (platform-api.jar)" &&
+                    it.location.source.line == 1 &&
+                    it.location.source.column == 8
             }
             .anyMatch {
                 it.id == "BannedPattern" &&
-                    it.message == "[4:23] PsiUtil (java-api.jar) is not available in all IDEs, use PsiManager.getInstance(project).findFile() instead"
+                    it.message == "PsiUtil (java-api.jar) is not available in all IDEs, use PsiManager.getInstance(project).findFile() instead" &&
+                    it.location.source.line == 4 &&
+                    it.location.source.column == 23
             }
     }
+
+    @Test
+    fun allowPsiUtilCore() {
+        val rule = BannedPatternRule(BannedPatternRule.DEFAULT_PATTERNS)
+        assertThat(
+            rule.lint(
+                """
+            import com.intellij.psi.util.PsiUtilCore
+            class DockerfileParser(private val project: Project) {
+                fun parse(virtualFile: VirtualFile): DockerfileDetails? {
+                    val psiFile = PsiUtilCore.getPsiFile(project, virtualFile)
+                }
+            }
+                """.trimIndent()
+            )
+        )
+            .hasSize(0)
+    }
 }