@cnbcool/cnb-api-generate 2.7.0 → 2.7.1

package/built/skills-tools/resolve-quick-commands.js

@@ -5,10 +5,39 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveQuickCommands = resolveQuickCommands;
 const debug_1 = __importDefault(require("debug"));
-const get_config_1 = require("../utils/get-config");
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
 const logger = (0, debug_1.default)('csg:quick-commands');
 /**
- * 把 cag.config.js 的 quickCommands 配置 + helpData 元数据，
+ * 内置快捷命令配置文件路径——位于包根的 `quick-commands.json`，随 npm 包发布。
+ *
+ * 路径推导：
+ * - 源码态：`src/skills-tools/resolve-quick-commands.ts` → `../../quick-commands.json`
+ * - 编译后：`built/skills-tools/resolve-quick-commands.js` → `../../quick-commands.json`
+ * 两态都正确指向包根。
+ */
+const QUICK_COMMANDS_JSON_PATH = path_1.default.join(__dirname, '../../quick-commands.json');
+/**
+ * 加载内置快捷命令清单。该文件由本仓库维护、随 npm 包发布，
+ * 使用方无需在 cag.config.js 中重复声明。
+ *
+ * 文件不存在时返回空对象（不阻断构建，仅相当于未配置任何快捷命令）。
+ */
+function loadQuickCommandsJson() {
+    if (!fs_1.default.existsSync(QUICK_COMMANDS_JSON_PATH)) {
+        logger(`quick-commands.json not found at ${QUICK_COMMANDS_JSON_PATH}`);
+        return {};
+    }
+    const raw = fs_1.default.readFileSync(QUICK_COMMANDS_JSON_PATH, 'utf8');
+    try {
+        return JSON.parse(raw);
+    }
+    catch (e) {
+        throw new Error(`[quickCommands] 解析 ${QUICK_COMMANDS_JSON_PATH} 失败：${e.message}`);
+    }
+}
+/**
+ * 把内置 quick-commands.json + helpData 元数据，
  * 解析为下游（client 产物 / SKILL.md 渲染）共用的结构化数据。
  *
  * 关键校验：
@@ -18,8 +47,8 @@ const logger = (0, debug_1.default)('csg:quick-commands');
  *   不强制要求 module 名等于 swagger category）。
  */
 function resolveQuickCommands(helpData) {
-    const { quickCommands } = (0, get_config_1.getConfig)();
-    if (!quickCommands)
+    const quickCommands = loadQuickCommandsJson();
+    if (!quickCommands || !Object.keys(quickCommands).length)
         return {};
     const { modulesHelp } = helpData;
     // 建一个 realTool → true 的全局集合，便于 O(1) 校验
@@ -32,7 +61,7 @@ function resolveQuickCommands(helpData) {
     const result = {};
     for (const [moduleName, items] of Object.entries(quickCommands)) {
         if (!Array.isArray(items)) {
-            throw new Error(`[quickCommands] 模块 "${moduleName}" 的值必须是数组，请检查 cag.config.js。`);
+            throw new Error(`[quickCommands] 模块 "${moduleName}" 的值必须是数组，请检查 quick-commands.json。`);
         }
         const resolved = [];
         for (const item of items) {
@@ -43,7 +72,7 @@ function resolveQuickCommands(helpData) {
             // custom 命令跳过 swagger 校验
             if (!item.custom && !allTools.has(item.realTool)) {
                 throw new Error(`[quickCommands] 命令 "${moduleName} ${item.shortName}" 的 realTool="${item.realTool}" ` +
-                    `在 swagger 生成结果中不存在。请检查 cag.config.js 是否与最新 swagger 同步，` +
+                    `在 swagger 生成结果中不存在。请检查 quick-commands.json 是否与最新 swagger 同步，` +
                     `或对自定义命令显式标记 custom: true。`);
             }
             resolved.push({ ...item, module: moduleName });

package/built/skills.js

@@ -33,7 +33,7 @@ async function start() {
     const helpData = (0, generate_skill_cli_help_1.generateSkillCliHelp)(requestMap, defintionsMap);
     // 编译core
     await (0, printer_skills_client_core_1.printerSkillsClientCore)(helpData);
-    // 解析快捷命令配置（cag.config.js → 校验 → 结构化），同时驱动 client 运行时数据与 SKILL.md 文档
+    // 解析快捷命令配置（quick-commands.json → 校验 → 结构化），同时驱动 client 运行时数据与 SKILL.md 文档
     const quickCommandsByModule = (0, resolve_quick_commands_1.resolveQuickCommands)(helpData);
     // 写入 client 运行时配置（core/shortcuts.config.json），替代 client/shortcuts.ts 中的硬编码常量
     await (0, generate_shortcuts_config_1.generateShortcutsConfig)(quickCommandsByModule);

package/client/core.ts

@@ -136,7 +136,7 @@ async function clientFetch(data: any): Promise<any> {
       Authorization: `Bearer ${token}`,
       Accept: 'application/vnd.cnb.api+json',
       // 当请求体存在时，附加 Content-Type，避免后端无法识别 JSON body
-      ...(data.data ? { 'Content-Type': 'application/vnd.cnb.api+json' } : {}),
+      ...(data.data ? { 'Content-Type': 'application/json' } : {}),
       ...(data?.header || {}),
     },
   });

package/client/shortcuts.ts

@@ -77,7 +77,7 @@ function getPRNumber(): string {
 // 快捷命令定义
 // ============================================================
 //
-// 数据由 csg 构建期从 cag.config.js 的 quickCommands 字段派生，
+// 数据由 csg 构建期从仓库内置的 quick-commands.json（随 npm 包发布）派生，
 // 写入同级目录下的 shortcuts.config.json。本文件仅负责加载并暴露给
 // 其它模块（register-modules.ts / execute-action.ts / utils/upload.ts）。
 //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cnbcool/cnb-api-generate",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "main": "./built/index.js",
   "module": "./src/index.ts",
   "types": "./src/index.ts",
@@ -72,6 +72,7 @@
     "package.json",
     "skills-template",
     "client",
+    "quick-commands.json",
     "README.md"
   ]
 }

package/quick-commands.json

@@ -0,0 +1,33 @@
+{
+  "issues": [
+    { "shortName": "get",                 "realTool": "get-issue",                                "description": "获取详情" },
+    { "shortName": "list-comments",       "realTool": "list-issue-comments",                      "description": "获取评论列表" },
+    { "shortName": "comment",             "realTool": "post-issue-comment",                       "description": "评论",                "dataTip": "--body 内容" },
+    { "shortName": "close",               "realTool": "update-issue",                             "description": "关闭",                "autoData": { "state": "closed", "state_reason": "completed" } },
+    { "shortName": "open",                "realTool": "update-issue",                             "description": "打开",                "autoData": { "state": "open",   "state_reason": "reopened"  } },
+    { "shortName": "list-labels",         "realTool": "list-issue-labels",                        "description": "查看标签" },
+    { "shortName": "add-labels",          "realTool": "post-issue-labels",                        "description": "添加标签",            "dataTip": "--labels bug --labels feature" },
+    { "shortName": "list-assignees",      "realTool": "list-issue-assignees",                     "description": "查看处理人" },
+    { "shortName": "add-assignees",       "realTool": "post-issue-assignees",                     "description": "添加处理人",          "dataTip": "--assignees username" },
+    { "shortName": "upload-file",         "realTool": "post-issue-comment-file-asset-upload-url", "description": "上传 issue 评论文件",  "upload": true, "kind": "file",  "dataTip": "--file 文件路径" },
+    { "shortName": "upload-image",        "realTool": "post-issue-comment-image-asset-upload-url","description": "上传 issue 评论图片",  "upload": true, "kind": "image", "dataTip": "--file 图片路径" },
+    { "shortName": "create-upload-file",  "realTool": "post-asset-group",                         "description": "创建 issue 时上传文件", "upload": true, "kind": "file",  "dataTip": "--file 文件路径" },
+    { "shortName": "create-upload-image", "realTool": "post-asset-group",                         "description": "创建 issue 时上传图片", "upload": true, "kind": "image", "dataTip": "--file 图片路径" }
+  ],
+  "pulls": [
+    { "shortName": "get",            "realTool": "get-pull",                  "description": "获取详情" },
+    { "shortName": "list-files",     "realTool": "list-pull-files",           "description": "获取文件变更" },
+    { "shortName": "list-commits",   "realTool": "list-pull-commits",         "description": "获取提交记录" },
+    { "shortName": "list-comments",  "realTool": "list-pull-comments",        "description": "获取评论列表" },
+    { "shortName": "comment",        "realTool": "post-pull-comment",         "description": "评论",          "dataTip": "--body 内容" },
+    { "shortName": "list-labels",    "realTool": "list-pull-labels",          "description": "查看标签" },
+    { "shortName": "add-labels",     "realTool": "post-pull-labels",          "description": "添加标签",      "dataTip": "--labels ready --labels approved" },
+    { "shortName": "check-status",   "realTool": "list-pull-commit-statuses", "description": "查看 CI 状态" },
+    { "shortName": "list-reviews",   "realTool": "list-pull-reviews",         "description": "查看评审列表" },
+    { "shortName": "list-assignees", "realTool": "list-pull-assignees",       "description": "查看处理人" },
+    { "shortName": "upload-file",    "realTool": "upload-files",              "description": "上传文件",      "repoOnly": true, "upload": true, "dataTip": "--file 文件路径" },
+    { "shortName": "upload-image",   "realTool": "upload-imgs",               "description": "上传图片",      "repoOnly": true, "upload": true, "dataTip": "--file 图片路径" },
+    { "shortName": "get-ci-logs",    "realTool": "__get-ci-logs__",           "description": "获取 CI 失败日志", "repoOnly": true, "custom": true, "dataTip": "--sn 构建号（可选）" },
+    { "shortName": "get-ci-timing",  "realTool": "__get-ci-timing__",         "description": "分析 CI 耗时瓶颈", "repoOnly": true, "custom": true, "dataTip": "--sn 构建号（可选）" }
+  ]
+}