plugins/code-review
Archived
2
0
Fork 0
Code Pull Requests Activity
This repository has been archived on 2026-07-15. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
8e4f9849257925776374075ea39d8123dc01e1a8
code-review/README.md
T
JefferyandClaude Opus 4.8 8e4f984925 排除事項：未明確指定路徑一律詢問，並新增 --exclusions 參數 
- 收緊措辭：預設檔名 .codereview.md 僅為詢問時的建議選項，
  未取得使用者明確指定前不可自行假設或直接採用
- 新增 slash 參數 --exclusions <路徑> 明確指定排除事項檔案，
  帶此旗標即視為明確指定、不再詢問
- SKILL.md / paladin.md / README 範例同步更新

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-15 16:52:18 +08:00

194 lines
9.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# code-review — 跨 AI 助理 Plugin
一個可同時被 **Claude Code、Codex、Antigravity、OpenCode** 安裝的 plugin，提供 **RPG 攻防對決式的 `git diff` 程式碼審查** skill。
核心是以 [Agent Skills（`SKILL.md`）](https://agentskills.io) 標準撰寫的共用 skills（唯一真實來源放在 `skills/`），
搭配各助理各自的 plugin manifest，讓**同一個 repo** 可用各家**原生 plugin CLI** 安裝。
plugin 名為 `jsc`，在 Claude Code 與 Antigravity 中 skill 以 **`/jsc:` 前綴**呼叫（例如 `/jsc:code-review`）。
---
## 前綴與呼叫方式
| 助理 | 安裝方式 | 呼叫 | `/jsc:` 前綴 |
| --- | --- | --- | --- |
| Claude Code | `claude plugin`（marketplace） | `/jsc:<name>` 或自動觸發 | ✅ |
| Codex | `codex plugin`（marketplace） | `$<name>` 或 `/skills` 選單 | ❌（用 `$name`） |
| Antigravity | `agy plugin install` | `/jsc:<name>` 或自動觸發 | ✅ |
| OpenCode | skills 目錄（複製/clone） | 描述需求自動觸發 | ❌（依名稱） |
> Codex 不支援自訂前綴（skill 以 `$name` 呼叫）；OpenCode 由模型依描述自動呼叫。兩者皆**不強制**前綴。
---
## 目錄結構
同一個 repo 同時帶四種 manifest，彼此以路徑隔離、互不干擾；四家都讀同一份 `skills/`。
```
code-review/
├── .claude-plugin/
│ ├── plugin.json # Claude 外掛定義（name: "jsc"）
│ └── marketplace.json # Claude marketplace（name: "code-review"，source 指向本 repo）
├── .codex-plugin/
│ └── plugin.json # Codex 外掛定義（name: "jsc"，skills: "./skills"）
├── .agents/plugins/
│ └── marketplace.json # Codex marketplace（name: "code-review"，url source 指向本 repo）
├── plugin.json # Antigravity 外掛定義（name: "jsc"，skills: "./skills/"）
├── skills/ # ★ 唯一真實來源：所有 skills
│ └── code-review/
│ ├── SKILL.md # 主 skill：取 diff → 選角 → 攻擊 → 裁決 → 總結
│ └── roles/ # 一角色一檔（bard/mage/rogue/assassin/paladin）
├── AGENTS.md # 跨助理共用指引
└── README.md
```
---
## 安裝 / 更新 / 移除（各家原生 plugin CLI）
> 指令中的 repo 網址換成你的：`https://gitea.jsc.idv.tw/plugins/code-review.git`
>
> **Claude / Codex 從 git URL 安裝（會 clone 遠端），請先把本 repo `push` 到 gitea。**
> **Antigravity 的 `agy plugin install <url>` 目前只支援 github.com**；gitea 請改用「clone + 本地路徑」（見 Antigravity 節）。
> 本機/離線：Claude 可用本地路徑加 marketplace；Antigravity 用本地路徑安裝。
### Claude Code
```bash
# 安裝
claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/code-review.git
claude plugin install jsc@code-review
# 更新
claude plugin marketplace update code-review
claude plugin update jsc@code-review
# 移除
claude plugin uninstall jsc@code-review
claude plugin marketplace remove code-review
```
- 工作階段內 slash 版（等價）：把 `claude plugin` 換成 `/plugin`。
- 本機開發（免 push）：`claude plugin marketplace add C:\Users\h3285\source\repos.plugins\code-review`（本地路徑）後再 install。
- **呼叫**：`/jsc:<name>`（例 `/jsc:code-review`）。
### Codex
```bash
# 安裝
codex plugin marketplace add https://gitea.jsc.idv.tw/plugins/code-review.git
codex plugin add jsc@code-review
# 更新（重新抓取 marketplace 的 git 快照）
codex plugin marketplace upgrade code-review
# 移除
codex plugin remove jsc@code-review
codex plugin marketplace remove code-review
```
- 安裝 token `jsc@code-review` = plugin 名（`.codex-plugin/plugin.json` 的 `name`）@ marketplace 名（`.agents/plugins/marketplace.json` 的 `name`）。
- 本 repo 的 Codex marketplace 以 `url` 來源指向自己，故 Codex **一律從 gitea 安裝**（需先 push）；安裝後重啟 Codex。
- **呼叫**：`$<name>`（例 `$code-review`），或用 `/skills` 選單。
### Antigravity（`agy`）
> `agy plugin install <url>` 目前**只支援 github.com**；gitea 等自架 git 不支援 URL 安裝，請先 `git clone` 再用**本地路徑**安裝。
```bash
# 安裝：clone 後用本地路徑
git clone https://gitea.jsc.idv.tw/plugins/code-review.git ~/jsc-plugin
agy plugin install ~/jsc-plugin
# 更新（agy 無 update 子指令 → git pull 後重裝）
git -C ~/jsc-plugin pull
agy plugin uninstall jsc
agy plugin install ~/jsc-plugin
# 移除
agy plugin uninstall jsc
```
- 若把 skills 放到 GitHub，則可直接 `agy plugin install https://github.com/<owner>/<repo>`。
- 其他：`agy plugin list`、`agy plugin enable jsc` / `disable jsc`、`agy plugin validate <path>`。安裝後重啟工作階段。
- **呼叫**：`/jsc:<name>`（例 `/jsc:code-review`）或依描述自動觸發。
### OpenCode
OpenCode 的「plugin」是 TypeScript/npm 套件，不適用於 skill 包；skills 改用**目錄安裝**。
OpenCode 會讀 `~/.config/opencode/skills/`（也會讀 `~/.claude/skills/`、`~/.agents/skills/`）。
```bash
# 安裝
git clone https://gitea.jsc.idv.tw/plugins/code-review.git ~/jsc-plugin
mkdir -p ~/.config/opencode/skills
cp -r ~/jsc-plugin/skills/* ~/.config/opencode/skills/
# 更新
git -C ~/jsc-plugin pull
cp -r ~/jsc-plugin/skills/* ~/.config/opencode/skills/
# 移除
rm -rf ~/.config/opencode/skills/code-review
```
> **Windows PowerShell**：`cp -r A B` → `Copy-Item A B -Recurse -Force`、`rm -rf X` → `Remove-Item X -Recurse -Force`、`~` → `$HOME`。
- **呼叫**：直接描述需求，模型會依 skill 描述自動透過 skill 工具呼叫。
---
## 用 CLI 直接執行 skill（headless / 一次性）
安裝好之後，不必進互動介面，一行指令就能叫某個 skill 跑完並印出結果：
| 助理 | headless 指令 | 執行 `code-review` skill |
| --- | --- | --- |
| Claude Code | `claude -p "<prompt>"` | `claude -p "/jsc:code-review main feature/login all --exclusions .codereview.md"` |
| Codex | `codex exec "<prompt>"` | `codex exec '$code-review main feature/login all --exclusions .codereview.md'` |
| Antigravity | `agy -p "<prompt>"` | `agy -p "/jsc:code-review main feature/login all --exclusions .codereview.md"` |
| OpenCode | `opencode run "<message>"` | `opencode run "用攻防角色 review main 與 feature/login 的差異"` |
- Claude / Antigravity 支援 `/jsc:` 前綴，直接 `-p "/jsc:<name>"` 即可。
- Codex 以 `$<name>` 觸發；在 shell 請用**單引號**避免 `$` 被展開：`codex exec '$code-review …'`。
- OpenCode 沒有前綴，用自然語言描述需求，模型會自動透過 skill 工具呼叫。
- 帶引數就接在後面，例如 `claude -p "/jsc:code-review main feature/login mage"`、`codex exec '$code-review main feature/login mage'`。
---
## Skills 目錄
> 此區塊列出本 plugin 內含的所有 skills（名稱／描述／使用方法）。
> 新增或修改 skill 後，請同步手動更新標記之間的內容。
<!-- JSC-SKILLS:START -->
### `code-review`
以 RPG 攻防對決方式審查 `git diff` 的程式碼審查 skill。審查範圍是兩個分支的差異，**來源分支與目標分支缺一不可**（缺漏會反問補齊）。角色分**攻擊方**（吟遊詩人=風格 🎼／法師=邏輯 🔮／盜賊=效率 ⚡／刺客=安全性 🗡️）與**防守方**（聖騎士=裁決 🛡️），每個角色定義在 `skills/code-review/roles/<role>.md`（含英文名稱／專案／個性／徽章／代表色）。攻擊方分析 diff 找出問題（問題／等級／描述／建議／檔案位置／所在行數）；防守方依專案根目錄排除事項設定檔與原始碼脈絡裁決每條問題（🚫 略過／❌ 誤判／✅ 成立）。使用者可選擇單一角色、整個攻擊方、整個防守方或全部；複選時以 sub agent 並行執行。
參數格式：`<target> <source> [角色...] [--exclusions <排除事項檔案路徑>]`（目標在前、來源在後；角色可省略，會詢問；`--exclusions` 指定排除事項檔案路徑，省略時若選到防守方會反問）。
- **Claude Code / Antigravity**：`/jsc:code-review`（反問分支與角色），或帶參數 `/jsc:code-review main feature/login`、`/jsc:code-review main feature/login mage`、`/jsc:code-review main feature/login all --exclusions .codereview.md`
- **Codex**：`$code-review main feature/login attack`，或指定排除事項 `$code-review main feature/login all --exclusions docs/review-rules.md`，或用 `/skills` 選單
- **OpenCode**：描述需求（如「用攻防角色 review main 與 feature/login 的差異，排除事項看 docs/review-rules.md」）自動觸發
<!-- JSC-SKILLS:END -->
---
## 新增一個 skill
1. 複製既有 skill 作範本：`cp -r skills/code-review skills/<your-skill-name>`
2. 編輯 `skills/<your-skill-name>/SKILL.md` 的 frontmatter：
- `name`：小寫、數字、連字號（`-`），最長 64 字元。**這就是 Claude Code / Antigravity 的 `/jsc:<name>`**。
- `description`：第三人稱，寫清楚「何時用、何時不用」與觸發關鍵字 — 這是各助理自動載入的唯一依據。
3. 在內文寫下 skill 的具體步驟。
4. 手動把這個 skill 補進上方「Skills 目錄」區塊。
5. **bump 版本並 push**：四家都以 git 內容/版本判斷更新，請把 `.claude-plugin/plugin.json`、`.codex-plugin/plugin.json`、`plugin.json` 三個 manifest 的 `version` 一起 bump，commit 後 push 到 gitea。
6. 讓各助理更新：
- Claude：`claude plugin update jsc@code-review`
- Codex：`codex plugin marketplace upgrade code-review`
- Antigravity：`git -C ~/jsc-plugin pull && agy plugin uninstall jsc && agy plugin install ~/jsc-plugin`
- OpenCode：`git pull` 後重新複製 `skills/`
View Git Blame Copy Permalink