Add an inspection for missing script symbols

waleedyaseen · waleedyaseen · commit de5ced294b9b · 2023-08-24T18:00:11.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 - Add a formatter option for space within return list parenthesis.
 - Add error recovery for statements.
 - Add support for parsing empty statements.
+- Add an inspection for missing script symbols.
 
 ### Changed
 - The build window will now display internal compiler errors as well.
diff --git a/src/main/kotlin/io/runescript/plugin/ide/inspections/RuneScriptMissingScriptSymbolInspection.kt b/src/main/kotlin/io/runescript/plugin/ide/inspections/RuneScriptMissingScriptSymbolInspection.kt
@@ -0,0 +1,37 @@
+package io.runescript.plugin.ide.inspections
+
+import com.intellij.codeInspection.LocalInspectionTool
+import com.intellij.codeInspection.ProblemHighlightType
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElementVisitor
+import com.intellij.refactoring.suggested.endOffset
+import com.intellij.refactoring.suggested.startOffset
+import io.runescript.plugin.ide.RsBundle
+import io.runescript.plugin.lang.psi.RsScript
+import io.runescript.plugin.lang.psi.RsVisitor
+import io.runescript.plugin.lang.psi.qualifiedName
+import io.runescript.plugin.lang.psi.type.RsPrimitiveType
+import io.runescript.plugin.symbollang.psi.index.RsSymbolIndex
+
+class RuneScriptMissingScriptSymbolInspection : LocalInspectionTool() {
+
+    override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {
+        return object : RsVisitor() {
+
+            override fun visitScript(o: RsScript) {
+                val name = o.qualifiedName
+                val length = o.rbracket.endOffset - o.lbracket.startOffset
+                val range = TextRange.from(o.lbracket.startOffsetInParent, length)
+                if (RsSymbolIndex.lookup(o.project, RsPrimitiveType.CLIENTSCRIPT, name) == null) {
+                    holder.registerProblem(
+                        o,
+                        RsBundle.message("inspection.error.script.symbol.not.found", name),
+                        ProblemHighlightType.ERROR,
+                        range
+                    )
+                }
+            }
+        }
+    }
+}
diff --git a/src/main/resources/META-INF/inspections.xml b/src/main/resources/META-INF/inspections.xml
@@ -54,6 +54,12 @@
                          enabledByDefault="true"
                          level="WARNING"
                          implementationClass="io.runescript.plugin.ide.inspections.RuneScriptUnreachableCodeInspection"/>
+        <localInspection language="RuneScript"
+                         groupName="RuneScript"
+                         displayName="Missing script symbol"
+                         enabledByDefault="true"
+                         level="ERROR"
+                         implementationClass="io.runescript.plugin.ide.inspections.RuneScriptMissingScriptSymbolInspection"/>
         <localInspection language="RuneScriptSymbol"
                          groupName="RuneScript"
                          displayName="Invalid symbol file"
diff --git a/src/main/resources/inspectionDescriptions/RuneScriptMissingScriptSymbol.html b/src/main/resources/inspectionDescriptions/RuneScriptMissingScriptSymbol.html
@@ -0,0 +1,5 @@
+<html>
+<body>
+<p>Reports when a clientscript has no symbol defined for it.</p>
+</body>
+</html>
diff --git a/src/main/resources/messages/RsBundle.properties b/src/main/resources/messages/RsBundle.properties
@@ -56,6 +56,7 @@ inspection.error.unrecognized.trigger.type=Unrecognized trigger name `{0}`
 inspection.error.trigger.return.list.not.allowed=Trigger type `{0}` does not allow for return list
 inspection.error.trigger.parameter.list.not.allowed=Trigger type `{0}` does not allow for parameter list
 inspection.error.trigger.subject.not.found=Unresolved subject `{0}` of type `{1}`
+inspection.error.script.symbol.not.found=Script symbol not found for `{0}`
 
 # Intentions
 intention.category.expressions=RuneScript/Expressions

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +<html>
 +<body>
 +<p>Reports when a clientscript has no symbol defined for it.</p>
 +</body>
 +</html>