@cnbcool/cnb-api-generate 1.1.0 → 1.2.0

package/client/index.ts

@@ -4,7 +4,7 @@ import fs from 'fs';
 import path from 'path';
 import { showModuleHelp } from './modules.help';
 import { showToolHelp } from './tools.help';
-import { showShort, resolveShortcut } from './shortcuts';
+import { showShort, resolveShortcut, summarizeResponse } from './shortcuts';
 
 const helpFileContent = fs.readFileSync(
   path.join(__dirname, 'help.json'),
@@ -182,6 +182,7 @@ function formatParams(
   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') {
@@ -204,7 +205,7 @@ function formatParams(
     const pathDef = paramDefs.path || {};
     const queryDef = paramDefs.query || {};
     const reservedKeys = new Set([
-      'module', 'tool', 'help', 'short', 'verbose',
+      'module', 'tool', 'help', 'short', 'verbose', 'summary',
       'path', 'query', 'data', 'h', 'v',
     ]);
 
@@ -248,114 +249,6 @@ function formatParams(
   return formatted;
 }
 
-/**
- * 将嵌套对象打平取主字段值
- * 用于表格输出时将嵌套字段（如 author: {username: "alice"}）展示为 "alice"
- * @param val 任意值
- * @returns 打平后的字符串
- */
-function flattenValue(val: any): string {
-  if (val === null || val === undefined) return '';
-  if (typeof val !== 'object') return String(val);
-  if (Array.isArray(val)) {
-    return val.map(v => typeof v === 'object' ? flattenValue(v) : String(v)).join(',');
-  }
-  // 对象：取第一个 string 类型的字段值（如 author.login）
-  for (const v of Object.values(val)) {
-    if (typeof v === 'string') return v;
-    if (typeof v === 'number') return String(v);
-  }
-  return JSON.stringify(val);
-}
-
-/**
- * 缩短时间戳：2026-04-05T15:50:35Z → 2026-04-05
- */
-function shortenTimestamp(str: string): string {
-  if (/^\d{4}-\d{2}-\d{2}T/.test(str)) {
-    return str.substring(0, 10);
-  }
-  return str;
-}
-
-/**
- * 格式化数组响应为紧凑表格
- * - 过滤低信号字段（url、avatar 等）和全空列
- * - 缩短时间戳为日期
- * - 嵌套对象打平取主字段值
- * - 格式：表头行 + 数据行，用 | 分隔
- */
-function formatArrayAsTable(response: any): string {
-  const { status, page, total, totalPages, data } = response;
-
-  if (!Array.isArray(data) || data.length === 0) {
-    return JSON.stringify(response);
-  }
-
-  // 收集所有出现的 key
-  const allKeys = new Set<string>();
-  for (const item of data) {
-    if (typeof item === 'object' && item !== null) {
-      for (const key of Object.keys(item)) {
-        allKeys.add(key);
-      }
-    }
-  }
-
-  if (allKeys.size === 0) {
-    return JSON.stringify(response);
-  }
-
-  // 低信号字段
-  const lowSignalPatterns = [
-    /url$/i, /avatar/i, /html_url/i, /href/i, /link/i,
-    /^_/, /updated_at/i, /^invisible$/i, /^state_reason$/i,
-    /^started_at$/i, /^ended_at$/i, /^last_acted_at$/i,
-    /^is_npc$/i, /^email$/i, /^nickname$/i,
-  ];
-
-  const filteredKeys = [...allKeys].filter(key =>
-    !lowSignalPatterns.some(p => p.test(key))
-  );
-
-  const keysList = filteredKeys.length >= 3 ? filteredKeys : [...allKeys];
-
-  // 构建列数据，同时过滤全空列
-  const columns: { key: string; values: string[] }[] = [];
-  for (const key of keysList) {
-    const values: string[] = [];
-    let hasNonEmpty = false;
-    for (const item of data) {
-      let str = flattenValue(item?.[key]);
-      str = shortenTimestamp(str);
-      str = str.replace(/\|/g, '/');
-      if (str.length > 80) str = str.substring(0, 77) + '...';
-      if (str !== '' && str !== 'false') hasNonEmpty = true;
-      values.push(str);
-    }
-    if (hasNonEmpty) {
-      columns.push({ key, values });
-    }
-  }
-
-  if (columns.length === 0) {
-    return JSON.stringify(response);
-  }
-
-  // 构建输出（紧凑格式，不对齐）
-  let output = `status:${status}`;
-  if (total != null) {
-    output += ` page:${page}/${totalPages} total:${total}`;
-  }
-  output += '\n';
-  output += columns.map(c => c.key).join('|') + '\n';
-  for (let r = 0; r < data.length; r++) {
-    output += columns.map(c => c.values[r]).join('|') + '\n';
-  }
-
-  return output.trimEnd();
-}
-
 /**
  * 精简响应对象（非 verbose 模式使用）
  * - 去掉 trace（仅错误时保留）
@@ -395,11 +288,14 @@ function isStandardResponse(response: any): boolean {
 /**
  * 格式化 CLI 输出
  * - verbose 模式：完整 JSON（含 trace、header 等全部字段）
- * - 非标准响应（converter 返回裸 data）：直接 JSON 输出
- * - 数组响应：紧凑表格格式
- * - 单对象响应：精简 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: any, verbose: boolean): string {
+function formatOutput(response: any, verbose: boolean, summary: boolean, toolKey: string): string {
   // --verbose 模式：输出完整原始信息
   if (verbose) {
     return JSON.stringify(response, null, 2);
@@ -407,19 +303,27 @@ function formatOutput(response: any, verbose: boolean): string {
 
   // converter 可能返回裸 data（没有标准 {status, data} 结构），直接输出
   if (!isStandardResponse(response)) {
-    return JSON.stringify(response);
+    if (summary) {
+      const summarized = summarizeResponse(response, toolKey);
+      if (summarized !== null) {
+        return JSON.stringify(summarized, null, 2);
+      }
+    }
+    return JSON.stringify(response, null, 2);
   }
 
   // 精简响应
   const compact = compactResponse(response);
 
-  // 数组响应 → 表格格式
-  if (compact && Array.isArray(compact.data)) {
-    return formatArrayAsTable(compact);
+  // --summary 模式：对特定 tool 应用摘要提取（仅成功响应）
+  if (summary && compact.status >= 200 && compact.status < 300) {
+    const summarized = summarizeResponse(compact.data, toolKey);
+    if (summarized !== null) {
+      compact.data = summarized;
+    }
   }
 
-  // 单对象响应 → 精简 JSON
-  return JSON.stringify(compact);
+  return JSON.stringify(compact, null, 2);
 }
 
 /**
@@ -614,7 +518,8 @@ async function main() {
   }
 
   const data = await toolFunction(...toolsParam);
-  console.log(formatOutput(data, !!formattedParams.verbose));
+  const toolKey = `${formattedParams.module}/${formattedParams.tool}`;
+  console.log(formatOutput(data, !!formattedParams.verbose, !!formattedParams.summary, toolKey));
 }
 
 main();

package/client/shortcuts.ts

@@ -121,6 +121,7 @@ export function showShort(): void {
 ${list}
 
 提示: 以上命令自动使用环境变量 CNB_REPO_SLUG 和 CNB_ISSUE_IID，无需手动传 --path
+      添加 --summary 可只输出核心摘要字段
 `);
   } else if (ctx === 'pull_request') {
     const number = getPRNumber();
@@ -133,6 +134,7 @@ ${list}
 ${list}
 
 提示: 以上命令自动使用环境变量 CNB_REPO_SLUG 和 CNB_PULL_REQUEST_IID，无需手动传 --path
+      添加 --summary 可只输出核心摘要字段
 `);
   } else {
     // 未知上下文，两组都显示
@@ -152,6 +154,8 @@ ${prList}
   CNB_REPO_SLUG          - 仓库路径
   CNB_ISSUE_IID          - Issue 编号 (Issue 事件)
   CNB_PULL_REQUEST_IID   - PR 编号 (PR 事件)
+
+  添加 --summary 可只输出核心摘要字段
 `);
   }
 }
@@ -206,3 +210,75 @@ export function resolveShortcut(
     autoData: matched.autoData || null,
   };
 }
+
+// ============================================================
+// 摘要输出
+// 对返回数据量大的快捷命令，默认只输出核心字段，减少 token 消耗
+// ============================================================
+
+type SummaryExtractor = (item: any) => any;
+
+/**
+ * 摘要提取器配置
+ * key: "module/tool"，value: 摘要提取函数
+ * - 对象响应：直接对 data 应用提取函数
+ * - 数组响应：对 data 中每个元素应用提取函数
+ */
+const SUMMARY_EXTRACTORS: Record<string, SummaryExtractor> = {
+  // 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: any) => 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
+ */
+export function summarizeResponse(data: any, toolKey: string): any | null {
+  const extractor = SUMMARY_EXTRACTORS[toolKey];
+  if (!extractor) return null;
+  if (Array.isArray(data)) {
+    return data.map(extractor);
+  }
+  return extractor(data);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cnbcool/cnb-api-generate",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "main": "./built/index.js",
   "module": "./src/index.ts",
   "types": "./src/index.ts",