代码规范守护者
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_da4128d0/code-spec-guardian。
技能介绍
解决的问题
每个项目都有自己的代码规范:缩进用 Tab 还是空格、命名用 camelCase 还是 snake_case、错误怎么抛、API 响应包几层、Git commit message 用什么格式。这些规范要么散落在 CONTRIBUTING.md 里,要么只存在于老成员的肌肉记忆里。新成员接手代码、AI 辅助写代码时,往往只能靠猜——结果就是同一个项目里出现三种风格,Code Review 里一半时间在讨论格式。
Code Spec Guardian 的思路是:不要重写一遍规则文档,而是从项目源码里反向提取实际被遵守的规范,沉淀成机器可加载的规范文件,之后写代码、改代码、做 Review 时按需加载。
核心能力
首次分析采用逐模块扫描,先运行脚本生成 project_context.json,拿到语言列表和框架信息(支持多语言),再按六个维度依次提取证据:
- 代码风格 — 支持 TypeScript(含
tsconfig.json配置感知)、Python、Java、Go、Node、PHP、Rust,语言特有规范写入对应的{lang}-style.md,而不是笼统的code-style.md - UI 风格 — 前端项目的组件、类名、样式组织约定
- 架构规范 — 目录分层、模块边界、依赖方向
- API 设计 — 路由、响应结构、错误码格式
- SQL/数据库 — 表结构、索引、查询写法约定
- Git 规范 — commit message、分支策略
每个模块从源码中抽样提取证据,写入 .code-spec/{module}.md,完成后生成 index.md 汇总索引和 _meta.json 元数据(条目数/版本/哈希)。分析过程会实时播报进度,避免用户对着黑窗口发呆。
日常使用则按需加载:对话开始时检测 .code-spec/ 是否存在,再通过路由表最多加载相关的 3 个模块,把规范应用到代码生成、修改、修复和 Review 中。
适用边界
- 抽取出来的是项目当前的实际写法,不是理想写法。如果项目本身规范混乱,产出的就是一份混乱的规范——先要有人做一轮清理
- 采样分析对超大仓库可能耗时较长,重大变更后建议手动触发重新分析,支持全量重扫(自动备份到
.code-spec.bak/)或只更新指定模块 - 规范文件在项目内是静态的,新规范要靠重新分析或自进化机制来同步
.code-spec/目录可纳入 Git 版本控制,团队共享一份规范基线
使用场景
- 接手陌生项目,需要快速弄清团队的命名、分层与提交规范
- 多语言仓库写新功能,要求按既有风格生成代码
- Code Review 时对照项目规范检查 API 响应与错误处理
- 团队重大重构后,更新架构与 SQL 规范并保持版本记录
适合人员
- 新加入项目的后端工程师,想在不反复问人的情况下了解项目规范
- 维护多语言 monorepo 的技术负责人,需要统一各语言的写法
- 使用 AI 编程助手的全栈开发者,希望生成代码符合当前仓库风格
- 准备把项目规范纳入版本控制的团队管理员