Archived
228 lines
16 KiB
Markdown
228 lines
16 KiB
Markdown
# code-review — 跨 AI 助理 Plugin
|
||
|
||
一個可同時被 **Claude Code、Codex、Antigravity、OpenCode** 安裝的 plugin，提供一組以 **程式碼審查工作流** 為核心的 skills：
|
||
**RPG 攻防對決式 `git diff` review**、**裁決結果歸檔**、**Gitea AI review findings 修復、分類提交、push 與 PR 建立流程**，以及 **C# / .NET NuGet 套件更新流程**。
|
||
核心是以 [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）
|
||
│ ├── code-review-archive/ # 保存裁決：成立→已知問題、誤判→排除事項
|
||
│ ├── code-review-resolve/ # 解決 findings.json + 分類提交 + push + 發 PR
|
||
│ └── code-review-nuget/ # C# / .NET NuGet 套件更新 + build 驗證
|
||
├── 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 exclusions.md --known-issues known-issues.md"` |
|
||
| Codex | `codex exec "<prompt>"` | `codex exec '$code-review main feature/login all --exclusions exclusions.md --known-issues known-issues.md'` |
|
||
| Antigravity | `agy -p "<prompt>"` | `agy -p "/jsc:code-review main feature/login all --exclusions exclusions.md --known-issues known-issues.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 <排除事項檔案路徑>] [--known-issues <前次審查紀錄路徑>]`（目標在前、來源在後；角色可省略，會詢問；`--exclusions`、`--known-issues` 指定對應檔案路徑，省略時若選到防守方會反問）。
|
||
|
||
- **Claude Code / Antigravity**：`/jsc:code-review`（反問分支與角色），或帶參數 `/jsc:code-review main feature/login mage`、`/jsc:code-review main feature/login all --exclusions exclusions.md --known-issues known-issues.md`
|
||
- **Codex**：`$code-review main feature/login attack`，或 `$code-review main feature/login all --exclusions docs/review-rules.md --known-issues docs/known-issues.md`，或用 `/skills` 選單
|
||
- **OpenCode**：描述需求（如「用攻防角色 review main 與 feature/login 的差異，排除事項看 docs/review-rules.md、已知問題看 docs/known-issues.md」）自動觸發
|
||
|
||
### `code-review-archive`
|
||
|
||
將 `/jsc:code-review` 已裁決的問題保存到專案：**✅ 成立** 附加到前次審查紀錄（已知問題）檔、**❌ 誤判** 附加到排除事項檔，讓防守方下次自動標 🔁 已知問題 / 🚫 略過；🔁／🚫 已存在者僅計數不重複寫入。只吃既有裁決結果（合併攻擊方問題表＋防守方裁決表），不自己跑 review、不改程式碼，且寫檔前先取得同意。檔案格式依副檔名（`.md` / `.json`）決定。
|
||
|
||
參數：`--known-issues <前次審查紀錄路徑> --exclusions <排除事項檔案路徑>`（與 code-review 同名旗標，沿用同一組路徑；缺漏會反問）。
|
||
|
||
- **Claude Code / Antigravity**：`/jsc:code-review-archive --known-issues known-issues.md --exclusions exclusions.md`
|
||
- **Codex**：`$code-review-archive --known-issues docs/known-issues.md --exclusions docs/review-rules.md`，或用 `/skills` 選單
|
||
- **OpenCode**：描述需求（如「把剛剛 code-review 成立的問題存到 known-issues.md、誤判存到 exclusions.md」）自動觸發
|
||
|
||
### `code-review-resolve`
|
||
|
||
四階段：**(A 解決)** 讀工作目錄 `.gitea/ai-review/findings.json`（Gitea AI review 產出的問題清單），依嚴重等級 **🔴 嚴重 → 🟠 高 → 🟡 中 → 🔵 低** 由高到低**逐條修復**程式碼問題（無法安全自動修復者標「待人工處理」不硬改），全部處理完把 `findings.json` 清空為空陣列 `[]`。**(B 提交)** 分析工作區**所有**變更，依異動內容歸類為 `feat`/`fix`/`docs`/`style`/`refactor`/`perf`/`test`/`chore`/`revert`，**每個 type 各自一個 commit**，訊息為「`type(範圍): 一句總結`」格式，**括號內的範圍須對應實際異動的功能／模組**（例 `feat(使用者登入): 新增帳密登入流程`、`perf(物件查詢): 改用批次查詢降低 DB 往返`，而非 `feat(新增功能)` 這類重述 type 的詞）。**(C 推送)** push 當前分支：先用**認證管理器**、失敗改用 **token**、再失敗**詢問使用者**。**(D 開 PR)** 用 token 透過 **Gitea API** 對目標分支發 PR（**目標分支不明必須詢問、不可猜測**），PR 描述可選**完整版**（重新分析 `git diff` 總結）／**簡單版**（逐條列 commit 訊息）／**使用者輸入**；完成後因內文可能含 gitea token，**提醒並清除 AI 助理對話內文**。修改程式碼／commit／push／開 PR 前先輸出計畫並取得同意（`--yes` 可略過）；token 一律由環境變數（如 `GITEA_TOKEN`）提供，全程不明文輸出。
|
||
|
||
參數：`[--findings <findings.json 路徑>] [--target <目標分支>] [--pr-desc <full|simple|自訂文字>] [--no-commit] [--no-pr] [--yes]`（findings 省略時預設 `.gitea/ai-review/findings.json`；`--target` 省略時於開 PR 階段必問；`--no-commit` 只修復不提交；`--no-pr` 推送但不開 PR；`--yes` 略過確認）。
|
||
|
||
- **Claude Code / Antigravity**：`/jsc:code-review-resolve`，或 `/jsc:code-review-resolve --target develop --pr-desc full --yes`、`/jsc:code-review-resolve --no-pr`、`/jsc:code-review-resolve --no-commit`
|
||
- **Codex**：`$code-review-resolve`，或 `$code-review-resolve --target develop --pr-desc simple --yes`，或用 `/skills` 選單
|
||
- **OpenCode**：描述需求（如「讀 .gitea/ai-review/findings.json 依嚴重度逐條修好、清空該檔，把工作區變更依 conventional commit 分類提交，push 後對 develop 發 PR（完整版描述）」）自動觸發
|
||
|
||
### `code-review-nuget`
|
||
|
||
將 C# / .NET 專案的 NuGet 套件更新到最新可用版本。流程會先探測 `.sln` / `.slnx` / `.csproj` 與 `dotnet` 工具，執行 baseline `restore` / `build`，再**依專案分組列出所有 direct / transitive 套件**與目前版本、最新版本、參考來源。接著建立 `ProjectReference` graph：若當前專案所參考的上層專案已 direct reference 相同 NuGet 套件，且該套件會透過專案參考安全傳遞，便逐一移除重複 `PackageReference`；每移除一筆都立刻 `restore` / `build` 驗證，失敗即回復。最後逐一更新 direct 套件版本（支援 Central Package Management / `Directory.Packages.props`），**每更新一個套件就 restore/build 確認專案可正常編譯**；失敗的套件會回復並記錄原因，不會保留破壞 build 的更新。
|
||
|
||
參數：`[<solution-or-project>] [--include-prerelease] [--no-dedupe] [--build <command>] [--yes]`（目標可為 `.sln`、`.slnx` 或 `.csproj`；`--include-prerelease` 允許 prerelease；`--no-dedupe` 略過重複參考清理；`--build` 覆寫驗證指令；`--yes` 略過一般確認但不略過必要決策）。
|
||
|
||
- **Claude Code / Antigravity**：`/jsc:code-review-nuget`，或 `/jsc:code-review-nuget MySolution.sln --include-prerelease`
|
||
- **Codex**：`$code-review-nuget`，或 `$code-review-nuget src/App/App.csproj --build "dotnet build App.sln -c Release"`，或用 `/skills` 選單
|
||
- **OpenCode**：描述需求（如「把這個 .NET solution 的 NuGet 都更新到最新，先清掉 ProjectReference 已提供的重複套件，每更新一包就 build」）自動觸發
|
||
|
||
<!-- 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/`
|