drichao/vue3-cn-rule
中文版vue3-rule,欢迎使用
Testing Guidelines
- 单元测试覆盖率需达到80%以上(使用Vitest框架) - E2E测试必须包含核心业务流程验证(推荐Cypress) - 测试文件需与源码同目录存放(*.spec.ts命名规范) - 测试数据需通过MSW实现API Mock
Code Style & Guidelines
- 使用组合式API规范(setup语法糖+TypeScript) - 组件命名必须采用PascalCase(与文件名保持一致) - 强制ESLint规则:
- 缩进2空格(no-tabs规则)
- 字符串使用单引号(quotes规则)
- 禁止未使用变量(no-unused-vars)
- 自动格式化配置(Prettier):
- 行宽120字符
- 对象/数组尾随逗号
- 组件props换行规则(max-attributes-per-line)
Documentation Guidelines
- 公共组件必须包含JSDoc类型注释 - 除专业术语外,使用中文注释 - 接口文档需维护在
/docs/api
目录(OpenAPI格式) - 项目README需包含:
- 重大变更需更新CHANGELOG.md(遵循Keep a Changelog格式)