feat(core): add support for .devin files in project rules #349

- Update ProjectRule class to check for .devin files
- Add .devin file support in getAllRules method
- Update documentation to mention .devin file usage
- Rename proejct-rule.md to project-rule.md in documentation

Author: phodal

core/src/main/kotlin/cc/unitmesh/devti/sketch/rule/ProjectRule.kt

@@ -25,6 +25,13 @@ class ProjectRule(private val project: Project) {
             return "<user-rule>\n$content\n</user-rule>"
         }
 
+        /// try .devin file
+        val devinFile = project.lookupFile("$RULE_PATH/$filename.devin")
+        if (devinFile != null) {
+            val content = devinFile.readText()
+            return "<user-rule>\n$content\n</user-rule>"
+        }
+
         return file
     }
 
@@ -39,6 +46,6 @@ class ProjectRule(private val project: Project) {
      */
     fun getAllRules(): List<VirtualFile> {
         val ruleDir = project.guessProjectDir()?.findFileByRelativePath(RULE_PATH) ?: return emptyList()
-        return ruleDir.children.filter { it.extension == "md" }
+        return ruleDir.children.filter { it.extension == "md" || it.extension == "devin" }
     }
 }

docs/composer/custom-ai-composer.md

@@ -9,12 +9,14 @@ nav_order: 1
 
 ## Custom AI Composer
 
-follow [Prompt Override](/customize/prompt-override), the AI Composer can be customized. in the `prompt/code` folder, 
-you can create a file named `sketch.vm` to override the composer prompt.
+follow [Prompt Override](/customize/prompt-override), the AI Composer can be customized. in the `prompt/code` folder,
+you can create a file named [`sketch.vm`](https://github.com/unit-mesh/auto-dev/blob/master/core/src/main/resources/genius/zh/code/sketch.vm) 
+to override the composer prompt.
 
 ## Use RipgrepSearch
 
-Since we don't have a full-text search feature, you can use `RipgrepSearch` to search for files in the project. You can install it via Homebrew:
+Since we don't have a full-text search feature, you can use `RipgrepSearch` to search for files in the project. You can
+install it via Homebrew:
 
 ```bash
 brew install ripgrep

docs/composer/proejct-rule.md

@@ -0,0 +1,36 @@
+---
+layout: default
+title: Project Rule
+parent: AutoDev Sketch/Composer
+nav_order: 3
+---
+
+# Project Rule
+
+Notes: We prefer to use [prompts override](https://ide.unitmesh.cc/customize/prompt-override.html) to customize the
+prompt, but if you want to use the project rule, you can use the following method to customize the prompt.
+
+Since @2.0.2 version, AutoDev supports project rule. The project rule is a set of rules that are used to validate the
+project structure and configuration. The project rule is defined under `prompts/rules` directory. 
+
+## Project Rule Example
+
+The project rule is a Markdown file that contains the following fields:
+
+For example, the project rule file is defined as follows:
+
+```bash
+prompts/rules/
+├── service.md
+├── controller.md
+├── repository.md
+├── rpc.md
+└── README.md  # will always load this file default !!
+```
+
+Then the AutoDev will auto handle the project rule by RuleInsCommand, you can use the following command to check the project
+rule:
+
+```devin
+/rule:service
+```