安装方式
手动下载安装
下载 ZIP 后解压到技能目录即可安装。若在桌面客户端 WebView中直接下载出现异常，本站会改为提示页 + 原始链接，请按页内说明操作。
下载 ZIP (shub-coderules-v1.0.0.zip)触发指令
/coderules
跨平台安装指引
该技能声明兼容以下 1 个平台，将 ZIP 解压到对应目录即可被识别。
unzip shub-coderules-v1.0.0.zip -d ~/.claude/skills/
mkdir -p 创建；启用 Skill 后请重启对应 Agent 让配置生效。
使用指南
Coderules 规范
围绕 Coderules 规范：团队代码规范的定义、检查与落地；与「cursor-rules」可组合使用。 无需在每次任务前把零散英文说明手工拼进上下文，也 减少 与客户端默认行为脱节的试错；具体命令、钩子与 JSON 参数仍以 ZIP 包内 SKILL.md 为权威。下文结构与站内 MCP CLI 类专题稿相同：何时用、前置、流程、速查与故障。
何时使用
- 团队代码规范的定义、检查与落地
- 与「cursor-rules」可组合使用
- 已获取本技能 ZIP，并准备在 Claude Code / OpenClaw 中按 SKILL.md 挂载。
- 希望用中文专题稿快速判断「该不该启用」，再深入英文 SKILL 查参数与边界。
- 需要与团队对齐同一套触发方式、目录约定或回调格式时。
前置条件
- 通用：可运行 Claude Code 或文档要求的客户端；有可读写的项目工作区（或 SKILL.md 指定的沙箱目录）。
- 权威细节：API Key / OAuth、钩子路径、环境变量以 ZIP 内 SKILL.md 为准。
典型流程
- 从 ClawHub / 站内分发获取技能 ZIP，校验版本与校验和（若提供）。
- 阅读 SKILL.md 的安装段落：目录落点、客户端类型（Claude Code / OpenClaw / 脚本）。
- 用文档中的最小示例完成第一次调用（单文件修改、单次查询或单次委派）。
- 确认工作目录、权限边界与输出路径后，再处理多文件或长耗时任务。
- 需要回调 / Webhook / 通知时，按 SKILL.md 配置端点并在测试环境先验通。
与 ZIP / SKILL.md 的关系
站内专题稿与 MCP CLI 类 oss 稿同样：概括何时用、怎么接、怎么排错；命令模板、钩子名、JSON 字段、版本矩阵一律以 ZIP 内 SKILL.md 与 ClawHub 上游为准。
命令示例（摘自包内 SKILL.md）
以下为从上游 SKILL.md（或入库正文）自动抽取的终端/脚本片段；路径、环境变量与参数以当前 ZIP 与官方说明为准。
ClawHub slug：coderules（安装命令以 SKILL.md / claw CLI 为准）。
node scripts/analyzer.js [项目路径]
站内入库时的触发命令（完整语义见 ZIP）：
# 使用本技能时可在对话中引用或执行上述指令；完整参数与示例见下载包内 SKILL.md。
/coderules
最佳实践
- 先 SKILL.md 再猜参数；站内专题稿不替代 schema 与必填字段说明。
- 委派任务时写清验收标准（命令、文件路径、测试命令），减少来回追问。
- 长任务用文档推荐的回调 / 日志落盘代替高频轮询，省 Token 也省机器负载。
- 多技能同时启用时，注意钩子加载顺序与重复工具调用（以 SKILL.md 冲突说明为准）。
调试与排错
- 打开 stderr 与客户端日志；PTY/tmux 场景同时看面板最后几十行输出。
- 参数错误时对照 SKILL.md 中的 JSON/CLI 示例（引号、转义、工作目录）。
- 网络类失败：查代理、防火墙、MCP 传输方式（stdio / HTTP / SSE）。
速查
| 动作 | 说明 |
|------|------|
| 获取技能包 | ClawHub / 站内 ZIP，核对版本 |
| 权威步骤 | 优先阅读 ZIP 内 SKILL.md |
| 首次试跑 | 使用 SKILL.md 最小示例 |
| 验收 | 对照路径、测试命令或回调负载 |
常见故障
- 无输出或立即退出 → 工作目录错误、依赖未装、或 Claude Code 未登录；按 SKILL.md 自检清单执行。
- 权限被拒绝 → 检查沙箱路径、
--permission-mode与工具白名单。 - 与简介不符 → 以英文 SKILL 与上游仓库为准，站内稿仅作结构化导读。
# 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` 自动完成分析：
```bash
node scripts/analyzer.js [项目路径]
```
### 第二步：规范加载
根据识别结果，从 `rules/` 目录加载对应规范：
- 语言规范：`rules/languages/<language>.json`
- 框架规范：`rules/frameworks/<framework>.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` 覆盖默认规范：
```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 会记住反馈，下次生成时自动应用