feat(devti): add 'rule' command to retrieve code quality guidelines #349

Author: phodal

core/src/main/kotlin/cc/unitmesh/devti/AutoDevIcons.kt

@@ -73,4 +73,7 @@ object AutoDevIcons {
 
     @JvmField
     val EDIT: Icon = IconLoader.getIcon("/icons/edit.svg", AutoDevIcons::class.java)
+
+    @JvmField
+    val RULE: Icon = IconLoader.getIcon("/icons/rule.svg", AutoDevIcons::class.java)
 }

core/src/main/kotlin/cc/unitmesh/devti/devin/dataprovider/BuiltinCommand.kt

@@ -112,6 +112,13 @@ enum class BuiltinCommand(
     ),
     OPEN("open", "Open a file in the editor", AllIcons.Actions.MenuOpen, false, true),
     RIPGREP_SEARCH("ripgrepSearch", "Search text in the project with ripgrep", AllIcons.Actions.Regex, false, true),
+    RULE(
+        "rule",
+        "Get the rule from one file, such as code style, code quality, and code smell",
+        AutoDevIcons.RULE,
+        true,
+        true
+    ),
     TOOLCHAIN_COMMAND(
         "x",
         "Execute custom toolchain command",

core/src/main/kotlin/cc/unitmesh/devti/sketch/AutoSketchMode.kt

@@ -1,18 +1,7 @@
 package cc.unitmesh.devti.sketch
 
 import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.BROWSE
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.DATABASE
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.DIR
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.FILE
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.LOCAL_SEARCH
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.PATCH
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.RELATED
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.REV
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.RIPGREP_SEARCH
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.STRUCTURE
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.SYMBOL
-import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.WRITE
+import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand.*
 import cc.unitmesh.devti.observer.agent.AgentStateService
 import cc.unitmesh.devti.provider.devins.LanguageProcessor
 import cc.unitmesh.devti.provider.toolchain.ToolchainFunctionProvider
@@ -90,6 +79,7 @@ class AutoSketchMode(val project: Project) {
             DATABASE, // should be handle in run sql
             RELATED,
             RIPGREP_SEARCH,
+            RULE,
             BROWSE,
             PATCH,
             WRITE

core/src/main/resources/icons/rule.svg

@@ -303,6 +303,11 @@ class DevInsCompiler(
             RelatedSymbolInsCommand(myProject, prop)
         }
 
+        BuiltinCommand.RULE -> {
+            result.isLocalCommand = true
+            RuleInsCommand(myProject, prop)
+        }
+
         BuiltinCommand.OPEN -> {
             result.isLocalCommand = true
             OpenInsCommand(myProject, prop)

exts/devins-lang/src/main/kotlin/cc/unitmesh/devti/language/compiler/DevInsCompiler.kt

@@ -11,8 +11,6 @@ class OpenInsCommand(val myProject: Project, private val filename: String) : Ins
     override val commandName: BuiltinCommand = BuiltinCommand.OPEN
 
     override suspend fun execute(): String? {
-        FileDocumentManager.getInstance().saveAllDocuments()
-
         val file = myProject.lookupFile(filename)
         if (file != null) {
             FileEditorManager.getInstance(myProject).openFile(file, true)

exts/devins-lang/src/main/kotlin/cc/unitmesh/devti/language/compiler/exec/OpenInsCommand.kt

@@ -0,0 +1,23 @@
+package cc.unitmesh.devti.language.compiler.exec
+
+import cc.unitmesh.devti.devin.InsCommand
+import cc.unitmesh.devti.devin.dataprovider.BuiltinCommand
+import cc.unitmesh.devti.language.compiler.error.DEVINS_ERROR
+import cc.unitmesh.devti.language.utils.lookupFile
+import cc.unitmesh.devti.sketch.ui.patch.readText
+import com.intellij.openapi.project.Project
+
+class RuleInsCommand(val myProject: Project, private val filename: String) : InsCommand {
+    override val commandName: BuiltinCommand = BuiltinCommand.OPEN
+
+    override suspend fun execute(): String? {
+        val fullname = "prompts/rule/$filename.md"
+        val file = myProject.lookupFile(fullname)
+
+        if (file != null) {
+            return file.readText()
+        }
+
+        return "$DEVINS_ERROR rule file not found: $fullname"
+    }
+}

exts/devins-lang/src/main/kotlin/cc/unitmesh/devti/language/compiler/exec/RuleInsCommand.kt

@@ -0,0 +1,2 @@
+获取 service 相关的规则（将读取 promtps/rule/service.md 文件，请确保文件存在）
+/rule:service