xinjie-review

CodeBuddy 全能代码与文档审查技能（xinjie 审查）的 npm 发布包。

一键安装后，即可在 CodeBuddy 中自动获得对前端、后端、CSS/样式、Markdown 文档、流程图、依赖配置等内容的系统性质量审查能力，输出结构化分级审查报告。

✨ 特性

• 多类型覆盖：前端 / 后端 / 样式 / 文档 / 流程图 / 依赖安全，可混合审查
• 统一分级标准：🔴 阻断 / 🟠 严重 / 🟡 建议 / 🔵 风格，判定一致
• 结构化报告：文件 + 行号 + 片段 + 影响 + 修复建议
• PR/MR 审查：基于 git diff，输出 Approve / Request changes / Comment 结论
• 审查边界约束：只审查不擅自修改，默认仅输出报告

🚀 安装

方式一：全局安装（推荐）

npm install -g xinjie-review

postinstall 钩子会自动把技能安装到 ~/.codebuddy/skills/，装完即用，无需任何额外操作。

方式二：npx 一次性使用

npx xinjie-review

方式三：安装到指定项目（团队共享）

npm install xinjie-review
node node_modules/xinjie-review/bin/install.js --project

--project 会把技能安装到当前项目的 .codebuddy/skills/，随仓库共享给团队成员。

卸载

npm uninstall -g xinjie-review

postuninstall 钩子会自动删除已安装的技能。

手动安装 / 卸载

# 安装（默认用户级，--project 可安装到当前项目）
npx xinjie-review-install
npx xinjie-review-install --project

# 卸载
node node_modules/xinjie-review/bin/uninstall.js

💡 使用方式

安装完成后，在 CodeBuddy 对话中直接描述审查需求，AI 会根据技能描述自动识别并调用本技能。示例：

审查 src/components/Button.vue
审查后端 user 模块，检查 SQL 注入和安全问题
帮我审查这份 README，检查语句是否通顺
用 xinjie-review 审查最近的 git diff

也可手动触发：输入 /xinjie-review。

生成报告落盘

bash skills/xinjie-review/scripts/gen-report.sh "后端模块审查" ./review-report.md -t 后端

对应技能目录位于：用户级 ~/.codebuddy/skills/xinjie-review/，项目级 .codebuddy/skills/xinjie-review/。

📂 包结构

xinjie-review/
├── package.json          # npm 包清单（含 postinstall/postuninstall 钩子）
├── README.md             # 本说明文件
├── bin/
│   ├── install.js        # 安装脚本
│   └── uninstall.js      # 卸载脚本
└── skills/
    └── xinjie-review/    # 技能本体
        ├── SKILL.md      # 技能核心定义（入口）
        ├── README.md     # 技能详细说明
        ├── references/   # 各类型审查清单
        ├── examples/     # 示例审查报告
        └── scripts/      # 报告生成脚本

🔒 安全说明

• 本技能 allowed-tools 限定为 Read / Write / Search / Grep / ListFiles / Bash，仅执行只读与安全检查类操作。
• 技能默认不读取也不执行任何未知来源的 hooks。若你安装的第三方技能 frontmatter 包含 hooks 且需要启用，请在 ~/.codebuddy/settings.json 中设置 "allowUntrustedFrontmatterHooks": true——本技能当前未使用 hooks，不受影响。

🚢 发布与版本管理

本项目通过 GitHub Actions 实现"打 tag 即自动发布到 npm"，无需手动执行 npm publish。

版本号规则（语义化版本）

| 操作 | 命令 | 示例 | |------|------|------| | 修复 Bug | npm version patch | 1.0.0 → 1.0.1 | | 新增功能 | npm version minor | 1.0.1 → 1.1.0 | | 破坏性变更 | npm version major | 1.1.0 → 2.0.0 |

npm version xxx 会自动更新 package.json 中的版本号并创建对应的 git tag。

一键发布流程

# 1. 更新版本号（自动打 tag，如 v1.1.0）
npm version patch

# 2. 推送到 GitHub（tag 一并推送）
git push
git push --tags

# 3. GitHub Actions 检测到 v* tag，自动执行：
#    npm pack 校验 → npm publish

配置要求（首次需在 GitHub 仓库设置）

1. 在 GitHub 仓库 Settings → Secrets and variables → Actions → New repository secret 添加：
   • Name: NPM_TOKEN
   • Value: 你的 npm 访问令牌（在 npmjs.com → Access Tokens 生成，权限选 Automation 或 Publish）
2. 发布前先 npm login（或确保令牌有效）。

📄 许可证

MIT License