CviLux_fe/.github/prompts/exportCSV.prompt.md

1.4 KiB
Raw Permalink Blame History

mode
agent

API 路徑整理與引用檢查規則

目標

  • 針對 apis 目錄下所有子資料夾(如 account、alert、asset、building、dashboard、energy、forge、graph、history、login、operation、productSetting、system的 api.js 與 index.js 檔案,完整追蹤 API 路徑的實際引用情形。
  • 追蹤流程:
    1. 先在 api.js 找出所有 API 路徑常數(如 export const GET_XXX_API = '/path')。
    2. 在 index.js 檔案確認這些常數有被 import 並包裝成 API functiongetXXX)。
    3. 再全專案搜尋這些 API function 是否有被其他檔案 import 並呼叫。
  • 產生一份 csv 報表,格式如下:
API 路徑 定義常數 API function 是否有被引用
/user GET_USER_API getUser Y
/admin GET_ADMIN_API getAdmin N

詳細規則

  • 處理 apis 目錄下所有子資料夾的 api.js 與 index.js 檔案。
  • API 路徑的定義需涵蓋 get/post/put/delete 等(如 export const API = '/path')。
  • 只統計有被 index.js import 並包裝成 function 的 API 路徑。
  • 檢查 function 是否有被其他檔案 import 並呼叫(排除 apis 目錄本身)。
  • 匹配到的檔案需記錄完整路徑,可多個檔案以分號分隔。
  • 統計結果輸出為 csv 檔案。

輸出

  • 檔名api_usage_report.csv
  • 欄位API 路徑, 定義常數, API function, 是否有被引用,