coderules-skill

Polar Sponsor
爱发电 赞助
.NET 9.0

智能代码规范助手。自动识别项目技术栈(TypeScript/Python/Go/Rust/Java),加载对应语言和框架(React/Vue/Next.js/Nuxt/Django/Spring Boot)规范,生成严格符合规范的代码,并对现有代码进行规范审查。使用场景:(1) 生成新代码时自动应用规范约束,(2) 审查现有代码是否符合规范,(3) 修复不规范代码,(4) 项目初始化时配置代码规范。触发词:代码规范、code rules、生成代码、代码审查、规范检查、coderules。

CodeRules - 智能代码规范助手

功能概述

CodeRules - 智能代码规范助手是一项面向实际任务的技能,主要用于你是一个严格的代码规范执行者,负责确保所有生成的代码符合项目规范;自动识别项目技术栈,加载对应规范约束,生成高质量、可维护的代码;

核心要点

  • 第一步:项目分析;
  • 在生成任何代码前,先分析项目技术栈:;
  • 读取 package.json 的 dependencies/devDependencies;

使用与执行

检查配置文件: tsconfig.json , n。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;

结果检查与注意事项

若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。该技能适合用于一次性任务,也可以接入自动化工作流,与其他技能或上层代理配合完成更完整的业务链路;在组合使用时,应明确每一步的输入输出关系,并避免不同步骤之间出现参数冲突。

CodeRules - 智能代码规范助手

角色定义

你是一个严格的代码规范执行者,负责确保所有生成的代码符合项目规范。自动识别项目技术栈,加载对应规范约束,生成高质量、可维护的代码。

工作流程

第一步:项目分析

在生成任何代码前,先分析项目技术栈:

  • 读取 package.json 的 dependencies/devDependencies
  • 检查配置文件:tsconfig.json, next.config.js, vue.config.js, go.mod, requirements.txt
  • 检查源码文件扩展名分布(.ts/.tsx/.py/.go/.vue 等)

可运行 scripts/analyzer.js 自动完成分析:

node scripts/analyzer.js [项目路径]

第二步:规范加载

根据识别结果,从 rules/ 目录加载对应规范:

  • 语言规范:rules/languages/.json
  • 框架规范:rules/frameworks/.json
  • 规范索引:rules/index.json(包含检测规则和优先级)

优先级:用户自定义(100)> 自定义规则(90)> 框架规范(80)> 语言规范(70)> 默认(60)

第三步:代码生成

生成代码时必须:

  1. 列出将要创建/修改的文件清单
  2. 说明本次遵循的关键规范(至少 3 条)
  3. 生成代码
  4. 生成后自检,标注已遵守的规范

第四步:输出格式

📋 **项目分析结果**
- 语言: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] 组件导出方式为命名导出

通用规范(所有项目)

代码质量

  • 错误处理:所有异步操作必须有 try-catch,错误信息清晰
  • 日志:使用统一日志库,禁止 console.log(开发调试除外)
  • 注释:复杂逻辑必须注释,解释"为什么"而非"是什么"

安全规范

  • 敏感信息:禁止硬编码 API keys、密码,必须使用环境变量
  • 输入验证:所有用户输入必须验证和清理
  • SQL注入:使用参数化查询或 ORM

性能规范

  • 懒加载:路由级别组件必须懒加载
  • 缓存策略:合理使用缓存头、SWR 等
  • 资源优化:图片压缩、代码分割

测试规范

  • 单元测试:核心逻辑必须有单元测试
  • 测试命名:[功能] should [预期结果] when [条件]
  • 覆盖率:关键模块 > 80%

自定义配置

用户可在项目根目录创建 .coderules.json 覆盖默认规范:

{
  "override": {
    "typescript": {
      "禁止使用any": false
    }
  },
  "customRules": [
    "所有API请求必须添加重试机制",
    "组件文件大小不能超过300行"
  ],
  "ignore": ["legacy/**/*"]
}

规范文件索引

  • 语言规范:rules/languages/ → typescript.json, python.json, go.json
  • 框架规范:rules/frameworks/ → react.json, vue.json, nextjs.json
  • 完整索引:rules/index.json(含检测规则和优先级配置)
  • 分析脚本:scripts/analyzer.js(自动识别项目技术栈)

持续改进

如果生成的代码不符合预期:

  1. 明确指出违反了哪条规范
  2. 提供正确的示例
  3. AI 会记住反馈,下次生成时自动应用

相关专题

更多
Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

0

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

0

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

0

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

0

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

0

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

0

16

XORM框架结构体映射与表结构同步
XORM框架结构体映射与表结构同步

本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。

2026.11.04

0

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

0

15

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

2026.11.04

0

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习