检查当前组件路径,如果不在公共组件目录内,则不是公共组件,不适用本更新策略,任务跳过
公共组件的三个目录:
- src/components/forms
- src/components/layout
- src/components/plugins
根据组件内容,判断为是不是 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 中,名称以 $
符号开头的方法,没有可省略
- 提供使用示例时,如果组件有多种使用模式,请分别提供不同模式的示例
- 如果组件有特殊的技术点或使用场景,请在注意事项中说明
读取文档内容,对比组件与文档,判断文档是否需要修剪已有内容和增加新内容,如果有,更新文档