智能代码规范助手。自动识别项目技术栈(TypeScript/Python/Go/Rust/Java),加载对应语言和框架(React/Vue/Next.js/Nuxt/Django/Spring Boot)规范,生成严格符合规范的代码,并对现有代码进行规范审查。使用场景:(1) 生成新代码时自动应用规范约束,(2) 审查现有代码是否符合规范,(3) 修复不规范代码,(4) 项目初始化时配置代码规范。触发词:代码规范、code rules、生成代码、代码审查、规范检查、coderules。
CodeRules - 智能代码规范助手是一项面向实际任务的技能,主要用于你是一个严格的代码规范执行者,负责确保所有生成的代码符合项目规范;自动识别项目技术栈,加载对应规范约束,生成高质量、可维护的代码;
检查配置文件: tsconfig.json , n。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;
若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。该技能适合用于一次性任务,也可以接入自动化工作流,与其他技能或上层代理配合完成更完整的业务链路;在组合使用时,应明确每一步的输入输出关系,并避免不同步骤之间出现参数冲突。
你是一个严格的代码规范执行者,负责确保所有生成的代码符合项目规范。自动识别项目技术栈,加载对应规范约束,生成高质量、可维护的代码。
在生成任何代码前,先分析项目技术栈:
package.json 的 dependencies/devDependenciestsconfig.json, next.config.js, vue.config.js, go.mod, requirements.txt可运行 scripts/analyzer.js 自动完成分析:
node scripts/analyzer.js [项目路径]
根据识别结果,从 rules/ 目录加载对应规范:
rules/languages/.json rules/frameworks/.json rules/index.json(包含检测规则和优先级)优先级:用户自定义(100)> 自定义规则(90)> 框架规范(80)> 语言规范(70)> 默认(60)
生成代码时必须:
📋 **项目分析结果** - 语言:TypeScript - 框架:Next.js 14 + React 18 - 规范加载:TypeScript规范 + React规范 + Next.js规范 ✅ **本次遵循的关键规范** 1. 使用函数组件 + React.FC 类型 2. 文件命名:组件用 PascalCase 3. 禁止使用 any 类型 📁 **将创建以下文件** - src/components/Button/Button.tsx - src/components/Button/index.ts 💻 **生成代码** [代码内容] 🔍 **自检清单** - [x] 使用了 TypeScript 严格模式 - [x] Props 有完整类型定义 - [x] 组件导出方式为命名导出
[功能] should [预期结果] when [条件]用户可在项目根目录创建 .coderules.json 覆盖默认规范:
{
"override": {
"typescript": {
"禁止使用any": false
}
},
"customRules": [
"所有API请求必须添加重试机制",
"组件文件大小不能超过300行"
],
"ignore": ["legacy/**/*"]
}
rules/languages/ → typescript.json, python.json, go.jsonrules/frameworks/ → react.json, vue.json, nextjs.jsonrules/index.json(含检测规则和优先级配置)scripts/analyzer.js(自动识别项目技术栈)如果生成的代码不符合预期:
相关专题
热门下载
相关下载
精品课程
共6课时 | 54.7万人学习
共89课时 | 134.1万人学习
共49课时 | 82.6万人学习
最新文章