From 5e7de7a792a12faf0f07eb089c4f9e9a4f73fc36 Mon Sep 17 00:00:00 2001 From: Jeffery Date: Mon, 31 Aug 2026 19:04:02 +0800 Subject: [PATCH] =?UTF-8?q?fix(frontmatter):=20=E4=BF=AE=E6=AD=A3=20api-do?= =?UTF-8?q?c=20=E6=8A=80=E8=83=BD=20SKILL.md=20frontmatter=20=E7=9A=84=20Y?= =?UTF-8?q?AML=20=E7=B4=94=E9=87=8F=E8=AA=9E=E6=B3=95=E9=8C=AF=E8=AA=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit What： - 修正 skills/api-doc/SKILL.md frontmatter 裡 description 欄位的 YAML 語法錯誤。 - 整串 description 加上單引號，內部撇號改寫成兩個單引號，內容文字一個字都沒變。 - 同步更新 plugin.json、.claude-plugin/plugin.json、.codex-plugin/plugin.json 三個 manifest 版本號，從 0.1.1 進到 0.1.2。 Why： - description 內含「冒號加空白」，屬於未加引號的 YAML plain scalar，違反 YAML 語法規定。 - Antigravity 解析 frontmatter 時當場中斷，整支技能被靜默丟棄，沒有任何錯誤訊息；磁碟上 34 支技能，Antigravity 只認得 28 支。 - 準則要求 description 用英文撰寫，不能把「: 」改成全形冒號迴避語法問題，只能加引號修正。 How： - 整串 description 值加上單引號，內部撇號寫成兩個單引號跳脫，其餘字元不動。 - 用 git show HEAD: 取出改前的原始值，把改後的單引號純量還原後做字串相等比對，確認逐字相同、字元數一致。 - 執行 ste100-lint.sh、check-behaviors.sh、lint-frontmatter.sh 三支檢查腳本，退出碼皆為 0；git diff --numstat 顯示只動了 frontmatter 那一行。 Who： - 本次修到 review 技能組的 api-doc 技能，屬稽核 API 專案 Swagger/OpenAPI 文件的功能。 --- .claude-plugin/plugin.json | 2 +- .codex-plugin/plugin.json | 2 +- plugin.json | 2 +- skills/api-doc/SKILL.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json index 26b40d4..70044f7 100644 --- a/.claude-plugin/plugin.json +++ b/.claude-plugin/plugin.json @@ -1,6 +1,6 @@ { "name": "jsc-review", - "version": "0.1.1", + "version": "0.1.2", "description": "程式碼審查：Refactoring 壞味道六組 + 註解規範 + 淺模組", "skills": "./skills", "author": { diff --git a/.codex-plugin/plugin.json b/.codex-plugin/plugin.json index 8538d08..25d48b8 100644 --- a/.codex-plugin/plugin.json +++ b/.codex-plugin/plugin.json @@ -1,6 +1,6 @@ { "name": "jsc-review", - "version": "0.1.1", + "version": "0.1.2", "description": "程式碼審查：Refactoring 壞味道六組 + 註解規範 + 淺模組", "skills": "./skills", "jsc": { diff --git a/plugin.json b/plugin.json index 7d21f14..cef73e2 100644 --- a/plugin.json +++ b/plugin.json @@ -1,6 +1,6 @@ { "name": "jsc-review", - "version": "0.1.1", + "version": "0.1.2", "description": "程式碼審查：Refactoring 壞味道六組 + 註解規範 + 淺模組", "skills": "./skills/", "jsc": { diff --git a/skills/api-doc/SKILL.md b/skills/api-doc/SKILL.md index 1fd7324..0a60cd6 100644 --- a/skills/api-doc/SKILL.md +++ b/skills/api-doc/SKILL.md @@ -1,6 +1,6 @@ --- name: api-doc -description: Audit an API project's Swagger/OpenAPI documentation: every returnable HTTP status code declares a response type, every input and output carries a description, and a real data example sits on scalar members only — a data-model member takes a description and hands the example duty down to its own properties, recursively to the innermost scalar. Run after controller work or an implementation is complete, e.g. from jsc-sdlc implement, next to jsc-review:code-review. Detection runs first via tools/swagger-detect.sh; without both the Swagger package and its wiring, report unsupported and stop. The source comment contract belongs to jsc-review:code-review group 5; this skill covers Swagger document attributes only. Findings carry file:line, severity, and the fix; this skill never modifies code. +description: 'Audit an API project''s Swagger/OpenAPI documentation: every returnable HTTP status code declares a response type, every input and output carries a description, and a real data example sits on scalar members only — a data-model member takes a description and hands the example duty down to its own properties, recursively to the innermost scalar. Run after controller work or an implementation is complete, e.g. from jsc-sdlc implement, next to jsc-review:code-review. Detection runs first via tools/swagger-detect.sh; without both the Swagger package and its wiring, report unsupported and stop. The source comment contract belongs to jsc-review:code-review group 5; this skill covers Swagger document attributes only. Findings carry file:line, severity, and the fix; this skill never modifies code.' --- # api-doc