第 2 章 · 03 八个生产级示例命令
文档摘要
第 2 章 · 03 八个生产级示例命令 本节摘要:原书附带八个可直接复制的生产级命令模板。本节逐个点评其设计:optimize(性能瓶颈审查)、pr(PR 准备清单,conventional commits)、commit(注入 git 上下文生成提交)、push-all(设计最精细——带完整安全检查与确认摘要)、doc-refactor(文档重构)、generate-api-docs(API 文档生成)、setup-ci-cd(CI/CD 初始化)、unit-test-expand(测试补全)。重点精读 push-all 的安全检查清单(密钥/API Key/大文件/构建产物/临时文件的阻断规则、占位符放行规则、确认摘要格式)。
第 2 章 · 03 八个生产级示例命令
本节摘要:原书附带八个可直接复制的生产级命令模板。本节逐个点评其设计:optimize(性能瓶颈审查)、pr(PR 准备清单,conventional commits)、commit(注入 git 上下文生成提交)、push-all(设计最精细——带完整安全检查与确认摘要)、doc-refactor(文档重构)、generate-api-docs(API 文档生成)、setup-ci-cd(CI/CD 初始化)、unit-test-expand(测试补全)。重点精读 push-all 的安全检查清单(密钥/API Key/大文件/构建产物/临时文件的阻断规则、占位符放行规则、确认摘要格式)。
学习目标
阅读完本节,你应当能够:
- 说出八个命令各自解决什么问题,frontmatter 上有什么特殊设计。
- 背出 push-all 安全检查的阻断清单(至少四类)与放行占位符规则。
- 复述 push-all 的确认摘要格式与错误处理分支(pull --rebase/-u/PR)。
一、八个命令总览
| 命令 | 要点 | 用途 |
|---|---|---|
optimize |
仅 description | 按优先级审查性能瓶颈(O(n²)、内存泄漏、算法、缓存、并发),输出严重性 Critical/High/Medium/Low+位置+解释+修复示例 |
pr |
allowed-tools: Bash(git add:*), Bash(git status:*), Bash(git diff:*), Bash(npm test:*), Bash(npm run lint:*) |
PR 准备清单:prettier → npm test → git diff → git add → conventional commits(fix/feat/docs/refactor/test/chore)→ PR 摘要(改了什么/为什么/测试/影响) |
commit |
allowed-tools: Bash(git add:*), Bash(git status:*), Bash(git commit:*), Bash(git diff:*), argument-hint: [message] |
注入 git 上下文后生成单个 conventional commit;传参则直接用 $ARGUMENTS |
push-all |
白名单最全 | 设计最精细的模板:"暂存全部+提交+推送"带完整安全检查(见下) |
doc-refactor |
name + description | 按项目类型重构文档:集中到 docs/、根 README 精简为入口、组件级 README、按主题组织、Mermaid 图表 |
generate-api-docs |
仅 description | 扫描 /src/api/ → 提取签名与 JSDoc → 生成 /docs/api.md(含 curl 示例、TS 类型、请求/响应 Schema、错误文档) |
setup-ci-cd |
name + description | 检测语言/框架 → 配 pre-commit(格式化/检查/安全/类型/测试)→ 建 GitHub Actions 镜像检查 → 验证;强调"用免费开源工具、尊重已有配置、保持快速" |
unit-test-expand |
name + description | 跑覆盖率报告找缺口 → 按现有框架(Jest/pytest/Go/Rust)补边界与错误路径测试 → 复跑验证提升;"只展示新增测试代码块" |
二、精读:push-all 的安全检查(原书经验)
立即停止并警告的清单:
- Secrets:
.env*、*.key、*.pem、credentials.json、secrets.yaml、id_rsa、*.p12、*.pfx、*.cer; - API Keys 真实值:如
OPENAI_API_KEY=sk-proj-xxxxx、AWS_SECRET_KEY=AKIA...、STRIPE_API_KEY=sk_live_...; - 大文件:>10MB 且无 Git LFS;
- 构建产物:
node_modules/、dist/、build/、__pycache__/、.venv/; - 临时文件:
.DS_Store、thumbs.db、*.swp、*.tmp。
接受的占位符(放行):your-api-key-here、placeholder、xxx、<your-key>、${YOUR_SECRET}。
确认摘要格式:文件数/行数统计、🔒 安全状态、🌿 分支——要求用户输入 "yes" 才能继续,未获明确 yes 不得继续。
错误处理:push 非快进 → git pull --rebase && git push;无远程分支 → git push -u origin;受保护分支 → 改用 PR。原书提醒:"拿不准时,使用单独的 git 命令会更可控";替代方案:选择性暂存/git add -p/PR 工作流(配合 /pr)。
小结
八个模板展示了命令的三个层次:单步操作(commit)、多步流程(pr/setup-ci-cd)、带安全门禁的敏感操作(push-all)。push-all 的价值不在"一键推送",而在把人类的谨慎写进了命令——检查清单、确认摘要、错误分支,一条命令就是一套流程规范。