Optimize lint checker

LuckyPray · Dec 11, 2023 · fb372dc · fb372dc
1 parent 8b2a3ed
commit fb372dc
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 18 deletions.
diff --git a/lint-rules/src/main/java/org/luckypray/dexkit/lint/DexKitIssueRegistry.kt b/lint-rules/src/main/java/org/luckypray/dexkit/lint/DexKitIssueRegistry.kt
@@ -4,6 +4,8 @@ import com.android.tools.lint.client.api.IssueRegistry
 import com.android.tools.lint.client.api.Vendor
 import com.android.tools.lint.detector.api.CURRENT_API
 import com.android.tools.lint.detector.api.Issue
+import org.luckypray.dexkit.lint.detector.DexKitCreateDetector
+import org.luckypray.dexkit.lint.detector.DexKitDataFirstDetector
 
 class DexKitIssueRegistry : IssueRegistry() {
     override val issues: List<Issue>

diff --git a/...ypray/dexkit/lint/DexKitCreateDetector.kt → ...kit/lint/detector/DexKitCreateDetector.kt b/...ypray/dexkit/lint/DexKitCreateDetector.kt → ...kit/lint/detector/DexKitCreateDetector.kt
@@ -1,4 +1,4 @@
-package org.luckypray.dexkit.lint
+package org.luckypray.dexkit.lint.detector
 
 import com.android.tools.lint.detector.api.Category
 import com.android.tools.lint.detector.api.Context
@@ -10,12 +10,12 @@ import com.android.tools.lint.detector.api.Scope
 import com.android.tools.lint.detector.api.Severity
 import com.intellij.psi.PsiMethod
 import org.jetbrains.uast.UCallExpression
-import java.util.Locale
+import org.luckypray.dexkit.lint.util.lang
+import org.luckypray.dexkit.lint.util.log
 
 
 class DexKitCreateDetector : Detector(), Detector.UastScanner {
     companion object {
-        private val lang: String = runCatching { Locale.getDefault().language }.getOrElse { "en" }
         val title = when (lang) {
             "zh" -> "请不要重复创建相同的 DexKitBridge 对象！"
             else -> "Don't create the same DexKitBridge object repeatedly! "
@@ -25,7 +25,7 @@ class DexKitCreateDetector : Detector(), Detector.UastScanner {
             else -> "Creating DexKitBridge is a time-consuming operation, and you should maintain a global object instead of calling `create()` every time you search."
         }
 
-        private const val ISSUE_ID = "DuplicateCreationDexKit"
+        private const val ISSUE_ID = "DuplicateCreateDexKit"
         val ISSUE = Issue.create(
             ISSUE_ID,
             title,
@@ -54,6 +54,7 @@ class DexKitCreateDetector : Detector(), Detector.UastScanner {
             if (createParamSet.contains(params)) {
                 val location = context.getLocation(node)
                 context.report(ISSUE, node, location, title + explanation)
+                context.log(title, explanation, node, location)
             } else {
                 createParamSet.add(params)
             }

diff --git a/...ay/dexkit/lint/DexKitDataFirstDetector.kt → .../lint/detector/DexKitDataFirstDetector.kt b/...ay/dexkit/lint/DexKitDataFirstDetector.kt → .../lint/detector/DexKitDataFirstDetector.kt
@@ -1,4 +1,4 @@
-package org.luckypray.dexkit.lint
+package org.luckypray.dexkit.lint.detector
 
 import com.android.tools.lint.detector.api.Category
 import com.android.tools.lint.detector.api.Detector
@@ -9,27 +9,27 @@ import com.android.tools.lint.detector.api.Scope
 import com.android.tools.lint.detector.api.Severity
 import com.intellij.psi.PsiMethod
 import org.jetbrains.uast.UCallExpression
-import java.util.Locale
+import org.luckypray.dexkit.lint.util.lang
+import org.luckypray.dexkit.lint.util.log
 
 class DexKitDataFirstDetector : Detector(), Detector.UastScanner {
     companion object {
-        private val lang: String = runCatching { Locale.getDefault().language }.getOrElse { "en" }
         val title = when (lang) {
-            "zh" -> "结果可能不唯一！"
-            else -> "The result may not be unique! "
+            "zh" -> "返回结果不唯一！"
+            else -> "The result is not unique! "
         }
         val explanation = when (lang) {
             "zh" -> "可能会导致预期外的问题，不推荐使用。"
-            else -> "May cause unexpected problems and are not recommended"
+            else -> "May cause unexpected problems and are not recommended."
         }
 
-        private const val ISSUE_ID = "DataMayNonUnique"
+        private const val ISSUE_ID = "NonUniqueDexKitData"
         val ISSUE = Issue.create(
             ISSUE_ID,
             title,
             explanation,
             category = Category.CORRECTNESS,
-            priority = 9,
+            priority = 5,
             severity = Severity.WARNING,
             implementation = Implementation(
                 DexKitDataFirstDetector::class.java,
@@ -56,18 +56,20 @@ class DexKitDataFirstDetector : Detector(), Detector.UastScanner {
                 .text(method.name)
                 .with(fixMap[method.name]!!)
                 .build()
+            val location = context.uastParser.getCallLocation(
+                context,
+                node,
+                includeReceiver = false,
+                includeArguments = false
+            )
             context.report(
                 ISSUE,
                 node,
-                context.uastParser.getCallLocation(
-                    context,
-                    node,
-                    includeReceiver = false,
-                    includeArguments = false
-                ),
+                location,
                 title + explanation,
                 replaceFix
             )
+            context.log(title, explanation, node, location)
         }
     }
 }
diff --git a/lint-rules/src/main/java/org/luckypray/dexkit/lint/util/Utils.kt b/lint-rules/src/main/java/org/luckypray/dexkit/lint/util/Utils.kt
@@ -0,0 +1,29 @@
+package org.luckypray.dexkit.lint.util
+
+import com.android.tools.lint.detector.api.JavaContext
+import com.android.tools.lint.detector.api.Location
+import org.jetbrains.uast.UElement
+import org.jetbrains.uast.getContainingUFile
+import org.jetbrains.uast.getIoFile
+import java.util.Locale
+
+internal val lang: String = runCatching { Locale.getDefault().language }.getOrElse { "en" }
+
+internal fun loge(format: String, vararg args: Any?) {
+    System.err.println(String.format(format, *args))
+    System.out.flush()
+}
+
+internal fun JavaContext.log(title: String, explanation: String, node: UElement, location: Location) {
+    loge(buildString {
+        append(title)
+        append(explanation)
+        append("\n\t")
+        append(node.getContainingUFile()?.getIoFile()?.absolutePath)
+        append(":")
+        append(location.start?.line?.let { it + 1 })
+        append(":")
+        append(location.start?.column?.let { it + 1 })
+        append(": '${node.asSourceString()}'")
+    })
+}