From 9ac5bbf53f129ddcc40303207b8a1c4ec4790eed Mon Sep 17 00:00:00 2001 From: Tevin <tingquanren@163.com> Date: Wed, 19 Mar 2025 15:31:45 +0800 Subject: [PATCH] 知识库，增加AI指令，更新公共组件 --- _cursor.ai/rules/all-dev-specification.mdc | 4 ++-- _cursor.ai/rules/type-surface.mdc | 4 ++-- _cursor.ai/prompts/更新公共组件文档.prompts.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 4 deletions(-) diff --git "a/_cursor.ai/prompts/\346\233\264\346\226\260\345\205\254\345\205\261\347\273\204\344\273\266\346\226\207\346\241\243.prompts.md" "b/_cursor.ai/prompts/\346\233\264\346\226\260\345\205\254\345\205\261\347\273\204\344\273\266\346\226\207\346\241\243.prompts.md" new file mode 100644 index 0000000..bd62fe2 --- /dev/null +++ "b/_cursor.ai/prompts/\346\233\264\346\226\260\345\205\254\345\205\261\347\273\204\344\273\266\346\226\207\346\241\243.prompts.md" @@ -0,0 +1,47 @@ +# 更新公共组件文档 + +## 第一步，检查组件 + +### 根据组件路径，检查是否为公共组件 + +检查当前组件路径，如果不在公共组件目录内，则不是公共组件，不适用本更新策略，任务跳过 + +公共组件的三个目录： +- src/components/forms +- src/components/layout +- src/components/plugins + +### 读取组件，检查是否为 Vue 组件 + +根据组件内容，判断为是不是 Vue 组件，如果不是，任务跳过 + +## 第二步，检查文档是否已经存在 + +每一个公共组件，都有一份组件文档 + +如果当前组件为： +src/components/forms/checkbox/CCheckBox.vue + +那么它对应的文档为： +src/components/_cursor.ai/forms.doc/checkbox.doc/CCheckBox.doc.md + +其规律为： +- 组件的文档都在 src/components/_cursor.ai/ 文件夹下，有类似的目录结构 +- 组件文件夹 forms/ 对应文档文件夹 forms.doc/（名称增加 `.doc`） +- 组件子文件夹 checkbox/ 对应文档子文件夹 checkbox.doc/（名称增加 `.doc`） +- 组件文件 CCheckBox.vue 对应文档文件 CCheckBox.doc.md（名称增加 `.doc`，但扩展名不变） + +## 第三步，如果文档不存在，创建 + +依照位置与命名规律，创建对应的 markdown 文档文件 + +每份组件文档包含：功能说明、引用方式、组件参数、示例方法、使用示例、注意事项 +- 组件参数请使用列表形式，例如：- `paramName` (String，可选)：参数说明 +- 组件参数如果是可枚举的几个具体值，请以二级列表的形式说明，例如：- `enumValue`：枚举值说明 +- 实例方法是指 methods 中，名称以 `$` 符号开头的方法，没有可省略 +- 提供使用示例时，如果组件有多种使用模式，请分别提供不同模式的示例 +- 如果组件有特殊的技术点或使用场景，请在注意事项中说明 + +## 第四步，如果文档已存在，更新文档 + +读取文档内容，对比组件与文档，判断文档是否需要修剪已有内容和增加新内容，如果有，更新文档 diff --git a/_cursor.ai/rules/all-dev-specification.mdc b/_cursor.ai/rules/all-dev-specification.mdc index fdee80e..f02256a 100644 --- a/_cursor.ai/rules/all-dev-specification.mdc +++ b/_cursor.ai/rules/all-dev-specification.mdc @@ -294,8 +294,8 @@ ### 基础书写要求 -书写规则都由编辑器自动格式化即可，例如 -- 使用四个空格代替 tab +例如： +- 使用四个空格代替 tab 进行缩进（包括代码和文档） - 单行代码宽度最多100个字符 - js 代码使用单引号 diff --git a/_cursor.ai/rules/type-surface.mdc b/_cursor.ai/rules/type-surface.mdc index be5de5f..a501c45 100644 --- a/_cursor.ai/rules/type-surface.mdc +++ b/_cursor.ai/rules/type-surface.mdc @@ -39,5 +39,5 @@ ``` 说明： -- H5 界面需要 CPage、CContent、CNavBar 这三个排版组件作为页面的基础布局 -- 在小程序中则不需要，删除即可 \ No newline at end of file +- H5 界面需要 CPage、CContent、CNavBar 这三个排版组件作为页面的基础布局（在小程序中则不需要） + -- Gitblit v1.9.1