CodeRules 智能代码规范助手
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3b34947d/coderules-skill 到你的 AI 助手中。
技能介绍
解决什么问题
在真实项目里,大模型直接写代码常见的问题是:不看现有技术栈、不遵守团队规范、混用日志和错误处理方式,甚至把密钥写进代码。CodeRules 把“代码规范”前置成生成约束,而不是事后 review。它先识别项目栈,再加载对应语言、框架规范,让输出尽量符合项目约定。
技能如何工作
- 项目分析:读取
package.json的 dependencies/devDependencies,检查tsconfig.json、next.config.js、vue.config.js、go.mod、requirements.txt等配置,并统计.ts、.py、.go、.vue等源码文件分布;也可通过scripts/analyzer.js自动完成分析。 - 规范加载:从
rules/languages/、rules/frameworks/和rules/index.json读取语言、框架及检测规则,按优先级合并:用户自定义 > 自定义规则 > 框架规范 > 语言规范 > 默认规范。 - 受约束生成:生成前列出创建/修改文件清单,说明至少 3 条关键规范,生成后做自检并标注已遵守的规范。
- 通用约束:覆盖异步错误处理、统一日志、环境变量保存密钥、输入验证、参数化查询、路由懒加载、缓存策略、单元测试命名与覆盖率等。
适用边界
它适合已有明确技术栈、需要统一代码风格的项目;如果项目规范频繁变化,建议维护 .coderules.json 和 rules/index.json,否则默认规则可能跟不上团队约定。
使用场景
- 在 Next.js/TypeScript 项目中新增路由组件前,读取 tsconfig、package.json 与 nextjs.json,按懒加载和错误处理输出文件清单。
- 在 Python 项目中新增接口时,要求验证用户输入、使用参数化查询、密钥走环境变量,并给出符合命名规范的单元测试。
- 在 Vue 3 项目重构组件时,加载 vue.json 与 typescript.json,统一日志和 why 注释,避免 console.log 与硬编码配置。
- 在 Go 服务新增模块前,根据 go.mod 与源码分布加载 go.json,约束错误处理、输入验证和关键模块测试覆盖。
适合人员
- 负责前端重构、希望组件生成前先加载 Vue 与 TypeScript 规范的工程师
- 维护后端接口、要求输入验证、密钥和查询方式符合安全规范的服务端工程师
- 需要 AI 生成代码前列出目标文件和关键规范的项目负责人
- 希望通过 .coderules.json 覆盖团队默认规则并保持风格一致的技术负责人