Commit Graph
2 Commits
Author SHA1 Message Date
jiantw83 a0bd488ac8 feat(tools): 新增發現合併與變更註解兩支腳本
- 合併、去重、排序原本寫在兩支技能的步驟文字裡,各寫一份就會各自演化。改由腳本執行,並定下六欄 TSV 的回報格式。格式不對就擋下並指出是第幾列,不猜、不放行、不自行補欄。
- 另一支腳本列出本次改到的註解行,清理範圍不再靠肉眼判讀。
- 註解樣式與非程式碼副檔名清單沿用註解範圍腳本的同一份,不另立第二套判準。markdown 的標題行開頭就是井字號,判準不一致就會把整份文件當成註解。
2026-08-31 11:07:05 +08:00
jiantw83 57ac9cdcd9 feat(swagger-detect): 新增判斷專案有沒有啟用 Swagger 的工具
What:新增 tools/swagger-detect.sh,判斷一個專案有沒有真的啟用 Swagger 文件。
涵蓋 dotnet、nodejs、python 三種技術棧,輸出 support=、stack=、package=、
config= 四類欄位;結束碼 0 支援、1 不支援、2 參數個數不對或專案路徑不存在。

Why:API 文件稽核只對產得出 Swagger 文件的專案有意義。支不支援如果交給 agent
自己看程式碼判斷,同一個專案可能這次說支援、下次說不支援。判定寫成腳本,呼叫端
讀結束碼分支就好,不必自己猜。

How:雙重確認,套件與設定缺一不算支援。第一關在套件宣告檔裡找已知的 Swagger
套件,第二關在原始碼裡找真的把 Swagger 接上去的呼叫或裝飾子。設定關鍵字一律
挑接線動作,不挑 import 或 require——光是引入套件不代表文件真的掛上去了。裝了
套件卻沒啟用的專案很常見,只看套件會誤判,讓稽核跑在一個根本產不出文件的專案
上。輸出刻意做成一行一個 key=value,呼叫端逐行讀就好。

Who:jsc-review 的 api-doc 技能,以及 jsc-sdlc 實作階段的收尾稽核。
2026-08-27 15:41:38 +08:00