@cnbcool/cnb-cli 1.0.1 → 1.0.3

package/skills/cnb-api/scripts/core/index.js

@@ -0,0 +1,463 @@
+#!/usr/bin/env node
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.parseArguments = parseArguments;
+var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
+var _modules = require("./modules.help");
+var _tools = require("./tools.help");
+var _shortcuts = require("./shortcuts");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const helpFileContent = _fs.default.readFileSync(_path.default.join(__dirname, 'help.json'), 'utf8');
+if (!helpFileContent) {
+  console.error('help.json not found');
+  process.exit(1);
+}
+const helpData = JSON.parse(helpFileContent);
+
+/**
+ * 解析命令行参数
+ * 支持：--key value, --key=value, -k value (短参数), 位置参数 (module, tool)
+ * @returns 解析后的参数对象
+ */
+function parseArguments() {
+  const args = process.argv.slice(2);
+  const result = {};
+  let positionalCount = 0;
+  let i = 0;
+  while (i < args.length) {
+    const arg = args[i];
+    if (arg.startsWith('--')) {
+      // --- 处理命名参数 (Options) ---
+      const fullKey = arg.slice(2);
+
+      // 支持 key=value 格式 (e.g., --config=file.json)
+      if (fullKey.includes('=')) {
+        const [key, ...valueParts] = fullKey.split('=');
+        result[key] = valueParts.join('=');
+        i++;
+        continue;
+      }
+      const key = fullKey;
+
+      // 检查下一个参数是否是值（不以 - 开头）
+      const nextArg = args[i + 1];
+      const isNextArgValue = i + 1 < args.length && !nextArg.startsWith('--') && !nextArg.startsWith('-');
+      if (isNextArgValue) {
+        result[key] = nextArg;
+        i += 2;
+      } else {
+        // 没有值，视为布尔标志
+        result[key] = true;
+        i++;
+      }
+    } else if (arg.startsWith('-') && arg.length > 1 && !/^-?\d+$/.test(arg)) {
+      // --- 处理短参数 (e.g., -h, -v)，排除负数 ---
+      const key = arg.slice(1);
+      const nextArg = args[i + 1];
+      const isNextArgValue = i + 1 < args.length && !nextArg.startsWith('--') && !nextArg.startsWith('-');
+
+      // 只有单字符短参才吞并下一个值 (如 -o output.txt)
+      if (isNextArgValue && key.length === 1) {
+        result[key] = nextArg;
+        i += 2;
+      } else {
+        result[key] = true;
+        i++;
+      }
+    } else {
+      // --- 处理位置参数 (Positional Args) ---
+      if (positionalCount === 0) {
+        result.module = arg;
+      } else if (positionalCount === 1) {
+        result.tool = arg;
+      }
+      positionalCount++;
+      i++;
+    }
+  }
+  return result;
+}
+
+/**
+ * 验证必须参数是否存在
+ * @param params 解析后的参数对象
+ * @returns 验证结果
+ */
+function validateRequiredParams(params) {
+  if (!params.tool || params.help) {
+    return false;
+  }
+  return true;
+}
+
+/**
+ * 尝试解析JSON字符串
+ * 先将真实控制字符转义为 JSON 合法形式，处理 shell/AI 传入的原始换行等情况
+ * @param str 要解析的字符串
+ * @returns 解析后的对象或原始字符串
+ */
+function tryParseJSON(str) {
+  if (typeof str !== 'string') return str;
+  const escaped = str.replace(/[\x00-\x1F\x7F]/g, ch => {
+    const map = {
+      '\n': '\\n',
+      '\r': '\\r',
+      '\t': '\\t',
+      '\b': '\\b',
+      '\f': '\\f'
+    };
+    return map[ch] || '\\u' + ch.charCodeAt(0).toString(16).padStart(4, '0');
+  });
+  try {
+    return JSON.parse(escaped);
+  } catch (error) {
+    return str;
+  }
+}
+
+/**
+ * 尝试从文件引用或 stdin 读取内容（类似 curl 的 @file / @- 语法）
+ */
+function tryReadFileRef(str) {
+  if (typeof str !== 'string' || !str.startsWith('@')) return str;
+  const ref = str.slice(1);
+
+  // @- 表示从 stdin 读取
+  if (ref === '-') {
+    try {
+      return _fs.default.readFileSync(0, 'utf8').trim();
+    } catch (e) {
+      console.error('从 stdin 读取失败:', e.message);
+      return str;
+    }
+  }
+
+  // @/path/to/file 表示从文件读取
+  if (_fs.default.existsSync(ref)) {
+    return _fs.default.readFileSync(ref, 'utf8').trim();
+  }
+  return str;
+}
+
+/**
+ * 获取 tool 的参数定义（用于自动分发 --key value 到 path/query）
+ */
+function getToolParamDefs(moduleName, toolName) {
+  const toolHelp = helpData.modulesHelp?.[moduleName]?.[toolName];
+  if (!toolHelp) return null;
+  return toolHelp.help?.parameter || {};
+}
+
+/**
+ * 格式化参数
+ * 支持新的 --key value 扁平格式，同时向后兼容旧的 --path/--query JSON 格式。
+ * 根据 help.json 中的参数定义，自动将扁平参数分发到 path 或 query。
+ * @param params 原始参数对象
+ * @returns 格式化后的参数对象，包含 module, tool, path, query, data 等
+ */
+function formatParams(params) {
+  const formatted = {
+    module: params.module,
+    tool: params.tool
+  };
+
+  // 保留控制标志
+  if (params.help) formatted.help = true;
+  if (params.short) formatted.short = true;
+  if (params.verbose) formatted.verbose = true;
+  if (params.summary) formatted.summary = true;
+
+  // 旧格式兼容：--path / --query / --data 是 JSON 字符串
+  if (typeof params.path === 'string') {
+    formatted.path = tryParseJSON(tryReadFileRef(params.path));
+  }
+  if (typeof params.query === 'string') {
+    formatted.query = tryParseJSON(tryReadFileRef(params.query));
+  }
+  if (typeof params.data === 'string') {
+    formatted.data = tryParseJSON(tryReadFileRef(params.data));
+  }
+
+  // 新格式：将其他 --key value 根据 help.json 自动分发到 path/query
+  const paramDefs = getToolParamDefs(params.module, params.tool);
+  if (paramDefs) {
+    const pathDef = paramDefs.path || {};
+    const queryDef = paramDefs.query || {};
+    const reservedKeys = new Set(['module', 'tool', 'help', 'short', 'verbose', 'summary', 'path', 'query', 'data', 'h', 'v']);
+    for (const [key, value] of Object.entries(params)) {
+      if (reservedKeys.has(key)) continue;
+      if (typeof value === 'boolean') continue;
+      if (pathDef[key]) {
+        // 归入 path
+        if (!formatted.path) formatted.path = {};
+        formatted.path[key] = value;
+      } else if (queryDef[key]) {
+        // 归入 query
+        if (!formatted.query) formatted.query = {};
+        // 自动转数字
+        const paramType = queryDef[key].type;
+        if (paramType === 'number' && typeof value === 'string' && !isNaN(Number(value))) {
+          formatted.query[key] = Number(value);
+        } else {
+          formatted.query[key] = value;
+        }
+      } else {
+        // 未知参数，尝试放入 query（兼容）
+        if (!formatted.query) formatted.query = {};
+        formatted.query[key] = typeof value === 'string' && !isNaN(Number(value)) ? Number(value) : value;
+      }
+    }
+  }
+
+  // 当没有传递 query 时，要判断当前 tool 是否支持 query
+  if (formatted.query === undefined) {
+    const paramDefs2 = getToolParamDefs(formatted.module, formatted.tool);
+    if (paramDefs2?.query) {
+      formatted.query = {};
+    }
+  }
+  return formatted;
+}
+
+/**
+ * 精简响应对象（非 verbose 模式使用）
+ * - 去掉 trace（仅错误时保留）
+ * - 去掉 header（原始 x-cnb-* 头）
+ * - 仅列表 API 时保留分页信息
+ */
+function compactResponse(response) {
+  if (!response || typeof response !== 'object') return response;
+  const compact = {
+    status: response.status
+  };
+
+  // 仅错误时保留 trace
+  if (response.status >= 300 && response.trace) {
+    compact.trace = response.trace;
+  }
+
+  // 仅列表 API 时保留分页信息
+  if (response.total != null) {
+    compact.page = response.page;
+    compact.pageSize = response.pageSize;
+    compact.total = response.total;
+    compact.totalPages = response.totalPages;
+  }
+  compact.data = response.data;
+  return compact;
+}
+
+/**
+ * 判断是否是标准响应结构（有 status + data 字段）
+ * cag.config.js 中的 responseConverter 可能返回裸 data（不含 status），需要区分处理
+ */
+function isStandardResponse(response) {
+  return response && typeof response === 'object' && typeof response.status === 'number' && 'data' in response;
+}
+
+/**
+ * 格式化 CLI 输出
+ * - verbose 模式：完整 JSON（含 trace、header 等全部字段）
+ * - summary 模式：只输出核心摘要字段（需要 --summary 显式指定）
+ * - 默认：精简 JSON（去掉 trace、header，保留完整 data）
+ * @param response 原始响应
+ * @param verbose 是否 verbose 模式
+ * @param summary 是否 summary 模式
+ * @param toolKey 当前 tool 标识，格式为 "module/tool"，用于匹配摘要配置
+ */
+function formatOutput(response, verbose, summary, toolKey) {
+  // --verbose 模式：输出完整原始信息
+  if (verbose) {
+    return JSON.stringify(response, null, 2);
+  }
+
+  // converter 可能返回裸 data（没有标准 {status, data} 结构），直接输出
+  if (!isStandardResponse(response)) {
+    if (summary) {
+      const summarized = (0, _shortcuts.summarizeResponse)(response, toolKey);
+      if (summarized !== null) {
+        return JSON.stringify(summarized, null, 2);
+      }
+    }
+    return JSON.stringify(response, null, 2);
+  }
+
+  // 精简响应
+  const compact = compactResponse(response);
+
+  // --summary 模式：对特定 tool 应用摘要提取（仅成功响应）
+  if (summary && compact.status >= 200 && compact.status < 300) {
+    const summarized = (0, _shortcuts.summarizeResponse)(compact.data, toolKey);
+    if (summarized !== null) {
+      compact.data = summarized;
+    }
+  }
+  return JSON.stringify(compact, null, 2);
+}
+
+/**
+ * 显示帮助文档
+ * - 无参数：显示顶层帮助（模块列表 + 参数说明 + 用法示例）
+ * - 指定 module：显示模块帮助（工具列表）
+ * - 指定 module + tool：显示工具帮助（参数详情 + 示例）
+ */
+function showHelp(moduleName, tool) {
+  if (moduleName && tool) {
+    (0, _tools.showToolHelp)(helpData, moduleName, tool);
+  } else if (moduleName) {
+    (0, _modules.showModuleHelp)(helpData, moduleName);
+  } else {
+    const cliCmd = "cnb" || 'cnb';
+
+    // 紧凑的模块列表
+    const moduleParts = [];
+    for (const [mod, count] of Object.entries(helpData.mainHelp)) {
+      moduleParts.push(`${mod}(${count})`);
+    }
+
+    // 每行放几个模块
+    const lines = [];
+    let currentLine = '  ';
+    for (const part of moduleParts) {
+      if (currentLine.length + part.length > 78) {
+        lines.push(currentLine);
+        currentLine = '  ' + part + ' ';
+      } else {
+        currentLine += part + ' ';
+      }
+    }
+    if (currentLine.trim()) lines.push(currentLine);
+    const helpMsg = `
+CNB OpenAPI CLI
+
+模块(tool数量):
+${lines.join('\n')}
+
+参数:
+  <module>          模块名称 (如: issues, pulls, git)
+  <tool>            工具名称 (如: list-issues, get-issue)
+  --key value       路径或查询参数，CLI 自动识别归类
+  --data 'JSON'     请求体参数，JSON 字符串
+  --verbose         输出完整响应（含 trace、header）
+  --help            显示帮助文档
+  --short           显示当前仓库的快捷命令
+
+用法: ${cliCmd} issues list-issues --repo my-org/my-repo --page 1 --pageSize 10
+      ${cliCmd} issues create-issue --repo my-org/my-repo --data '{"title":"Bug"}'
+帮助: ${cliCmd} <module> --help
+      ${cliCmd} <module> <tool> --help
+快捷: ${cliCmd} --short
+`;
+    console.log(helpMsg);
+  }
+}
+
+/**
+ * 主函数
+ */
+async function main() {
+  const params = parseArguments();
+
+  // 处理 --short
+  if (params.short) {
+    (0, _shortcuts.showShort)();
+    process.exit(0);
+  }
+
+  // 尝试解析快捷命令
+  const shortcut = (0, _shortcuts.resolveShortcut)(params.module, params.tool);
+  if (shortcut) {
+    params.tool = shortcut.tool;
+
+    // 自动注入 path 参数（兼容新旧格式）
+    // 新格式：用户可能直接传了 --repo xxx，检查扁平参数是否已存在
+    const autoPathKeys = Object.keys(shortcut.autoPath);
+    const hasPathAlready = params.path || autoPathKeys.some(k => params[k]);
+    if (!hasPathAlready) {
+      if (autoPathKeys.length > 0) {
+        // 新格式：直接注入为扁平参数
+        for (const [key, value] of Object.entries(shortcut.autoPath)) {
+          if (!params[key]) {
+            params[key] = value;
+          }
+        }
+      } else {
+        const envHint = params.module === 'issues' ? 'CNB_REPO_SLUG 和 CNB_ISSUE_IID' : 'CNB_REPO_SLUG 和 CNB_PULL_REQUEST_IID';
+        console.error(`快捷命令需要环境变量 ${envHint}，或手动传参数。\n` + `提示：运行 ${"cnb" || 'cnb'} --short 查看快捷命令详情。`);
+        process.exit(1);
+      }
+    }
+
+    // 自动注入 data 参数
+    if (shortcut.autoData && !params.data) {
+      params.data = JSON.stringify(shortcut.autoData);
+    }
+  }
+
+  // 验证必须参数
+  if (!validateRequiredParams(params)) {
+    showHelp(params.module, params.tool);
+    process.exit(0);
+  }
+
+  // 格式化参数
+  const formattedParams = formatParams(params);
+
+  // 参数预检：缺少必填 path 参数时自动输出 tool help
+  const toolHelpData = helpData.modulesHelp?.[formattedParams.module]?.[formattedParams.tool];
+  if (toolHelpData) {
+    const pathDef = toolHelpData.help?.parameter?.path;
+    if (pathDef) {
+      const missingRequired = Object.entries(pathDef).filter(([, p]) => p.required && !formattedParams.path?.[p.name]).map(([k]) => `--${k}`);
+      if (missingRequired.length > 0) {
+        console.error(`缺少必填参数: ${missingRequired.join(', ')}\n`);
+        (0, _tools.showToolHelp)(helpData, formattedParams.module, formattedParams.tool);
+        process.exit(1);
+      }
+    }
+  }
+
+  // 动态引入模块
+  const toolPath = _path.default.join(__dirname, '../modules', `${formattedParams.module}/${formattedParams.tool}.js`);
+  if (!_fs.default.existsSync(toolPath)) {
+    console.error(`工具文件不存在: ${toolPath}`);
+    process.exit(1);
+  }
+  const toolModule = require(toolPath);
+  const toolFunction = toolModule.default;
+  if (!toolFunction) {
+    console.error(`工具函数不存在`);
+    process.exit(1);
+  }
+  const toolsParam = [];
+  let pathAndQueryParams = null;
+  if (formattedParams.path && Object.keys(formattedParams.path).length === 1 && !formattedParams.query) {
+    pathAndQueryParams = formattedParams.path[Object.keys(formattedParams.path)[0]];
+  } else {
+    if (formattedParams.path) {
+      pathAndQueryParams = {
+        ...formattedParams.path
+      };
+    }
+    if (formattedParams.query) {
+      pathAndQueryParams = {
+        ...(pathAndQueryParams && typeof pathAndQueryParams === 'object' ? pathAndQueryParams : {}),
+        ...formattedParams.query
+      };
+    }
+  }
+  if (pathAndQueryParams) {
+    toolsParam.push(pathAndQueryParams);
+  }
+  if (formattedParams.data) {
+    toolsParam.push(formattedParams.data);
+  }
+  const data = await toolFunction(...toolsParam);
+  const toolKey = `${formattedParams.module}/${formattedParams.tool}`;
+  console.log(formatOutput(data, !!formattedParams.verbose, !!formattedParams.summary, toolKey));
+}
+main();

package/skills/cnb-api/scripts/core/modules.help.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.showModuleHelp = showModuleHelp;
+exports.trimSummary = trimSummary;
+/**
+ * 去除 summary 中的英文部分（保留中文句号前的内容）
+ */
+function trimSummary(summary) {
+  if (!summary) return '';
+  // 匹配中文句号"。"后面跟英文的模式，只保留中文部分
+  const match = summary.match(/^(.*?[\u4e00-\u9fff].*?)[。.]\s*[A-Z]/);
+  if (match) return match[1];
+  // 没有匹配到则返回原文
+  return summary;
+}
+
+/**
+ * 显示模块帮助文档
+ * @param helpData 帮助数据
+ * @param moduleName 模块名称
+ */
+function showModuleHelp(helpData, moduleName) {
+  const moduleHelpData = helpData.modulesHelp[moduleName];
+  if (!moduleHelpData) {
+    console.error(`模块 ${moduleName} 不存在`);
+    process.exit(1);
+  }
+  const cliCmd = "cnb" || 'cnb';
+  let toolListMsg = '';
+  for (const [, info] of Object.entries(moduleHelpData)) {
+    const name = info.filename;
+    const summary = info.summary;
+    toolListMsg += `  ${name.padEnd(30)} ${summary}\n`;
+  }
+  const helpMsg = `
+${moduleName} 模块
+
+工具:
+${toolListMsg}
+用法: ${cliCmd} ${moduleName} <tool> --help
+`;
+  console.log(helpMsg);
+}

package/skills/{cnb-skill → cnb-api}/scripts/core/shortcuts.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.detectEventContext = detectEventContext;
 exports.resolveShortcut = resolveShortcut;
 exports.showShort = showShort;
+exports.summarizeResponse = summarizeResponse;
 /**
  * 快捷命令模块
  *
@@ -160,6 +161,7 @@ function showShort() {
 ${list}
 
 提示: 以上命令自动使用环境变量 CNB_REPO_SLUG 和 CNB_ISSUE_IID，无需手动传 --path
+      添加 --summary 可只输出核心摘要字段
 `);
   } else if (ctx === 'pull_request') {
     const number = getPRNumber();
@@ -172,6 +174,7 @@ ${list}
 ${list}
 
 提示: 以上命令自动使用环境变量 CNB_REPO_SLUG 和 CNB_PULL_REQUEST_IID，无需手动传 --path
+      添加 --summary 可只输出核心摘要字段
 `);
   } else {
     // 未知上下文，两组都显示
@@ -191,6 +194,8 @@ ${prList}
   CNB_REPO_SLUG          - 仓库路径
   CNB_ISSUE_IID          - Issue 编号 (Issue 事件)
   CNB_PULL_REQUEST_IID   - PR 编号 (PR 事件)
+
+  添加 --summary 可只输出核心摘要字段
 `);
   }
 }
@@ -244,4 +249,69 @@ function resolveShortcut(moduleName, toolName) {
     autoPath: autoPath || {},
     autoData: matched.autoData || null
   };
+}
+
+// ============================================================
+// 摘要输出
+// 对返回数据量大的快捷命令，默认只输出核心字段，减少 token 消耗
+// ============================================================
+
+/**
+ * 摘要提取器配置
+ * key: "module/tool"，value: 摘要提取函数
+ * - 对象响应：直接对 data 应用提取函数
+ * - 数组响应：对 data 中每个元素应用提取函数
+ */
+const SUMMARY_EXTRACTORS = {
+  // Issue 详情摘要：只保留标题和正文
+  'issues/get-issue': item => ({
+    title: item.title,
+    body: item.body
+  }),
+  // Issue 更新摘要：只保留状态变更结果
+  'issues/update-issue': item => ({
+    number: item.number,
+    state: item.state,
+    state_reason: item.state_reason
+  }),
+  // Issue 添加处理人摘要：只保留处理人列表
+  'issues/post-issue-assignees': item => ({
+    number: item.number,
+    assignees: item.assignees?.map?.(a => a.username).filter(Boolean) || []
+  }),
+  // PR 详情摘要：只保留标题、状态、正文和分支信息
+  'pulls/get-pull': item => ({
+    title: item.title,
+    state: item.state,
+    base: item.base?.ref,
+    head: item.head?.ref,
+    body: item.body
+  }),
+  // PR 文件列表摘要：只保留文件名、变更状态和增删行数
+  'pulls/list-pull-files': item => ({
+    filename: item.filename,
+    status: item.status,
+    additions: item.additions,
+    deletions: item.deletions
+  }),
+  // PR 提交列表摘要：只保留 sha 前 8 位和 commit message
+  'pulls/list-pull-commits': item => ({
+    sha: typeof item.sha === 'string' ? item.sha.substring(0, 8) : item.sha,
+    message: item.commit?.message
+  })
+};
+
+/**
+ * 对响应数据应用摘要提取（如果当前 tool 配置了摘要提取器）
+ * @param data 原始 data（对象或数组）
+ * @param toolKey 当前 tool 标识，格式为 "module/tool"
+ * @returns 摘要后的 data，如果无匹配提取器则返回 null
+ */
+function summarizeResponse(data, toolKey) {
+  const extractor = SUMMARY_EXTRACTORS[toolKey];
+  if (!extractor) return null;
+  if (Array.isArray(data)) {
+    return data.map(extractor);
+  }
+  return extractor(data);
 }