@cnbcool/cnb-api-generate 1.2.3 → 1.2.4

package/client/index.ts

@@ -182,7 +182,6 @@ 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') {
@@ -205,7 +204,7 @@ function formatParams(
     const pathDef = paramDefs.path || {};
     const queryDef = paramDefs.query || {};
     const reservedKeys = new Set([
-      'module', 'tool', 'help', 'short', 'verbose', 'summary',
+      'module', 'tool', 'help', 'short', 'verbose',
       'path', 'query', 'data', 'h', 'v',
     ]);
 
@@ -288,8 +287,8 @@ function isStandardResponse(response: any): boolean {
 /**
  * 格式化 CLI 输出
  * - verbose 模式：完整 JSON（含 trace、header 等全部字段）
- * - summary 模式：只输出核心摘要字段（需要 --summary 显式指定）
- * - 默认：精简 JSON（去掉 trace、header，保留完整 data）
+ * - 快捷命令默认：只输出核心摘要字段
+ * - 非快捷命令默认：精简 JSON（去掉 trace、header，保留完整 data）
  * @param response 原始响应
  * @param verbose 是否 verbose 模式
  * @param summary 是否 summary 模式
@@ -315,7 +314,7 @@ function formatOutput(response: any, verbose: boolean, summary: boolean, toolKey
   // 精简响应
   const compact = compactResponse(response);
 
-  // --summary 模式：对特定 tool 应用摘要提取（仅成功响应）
+  // summary 模式：对特定 tool 应用摘要提取（仅成功响应）
   if (summary && compact.status >= 200 && compact.status < 300) {
     const summarized = summarizeResponse(compact.data, toolKey);
     if (summarized !== null) {
@@ -370,7 +369,7 @@ ${lines.join('\n')}
   <tool>            工具名称 (如: list-issues, get-issue)
   --key value       路径或查询参数，CLI 自动识别归类
   --data 'JSON'     请求体参数，JSON 字符串
-  --verbose         输出完整响应（含 trace、header）
+  --verbose         输出完整原始响应（含 trace、header 等全部字段）
   --help            显示帮助文档
   --short           显示当前仓库的快捷命令
 
@@ -519,7 +518,10 @@ async function main() {
 
   const data = await toolFunction(...toolsParam);
   const toolKey = `${formattedParams.module}/${formattedParams.tool}`;
-  console.log(formatOutput(data, !!formattedParams.verbose, !!formattedParams.summary, toolKey));
+  // 快捷命令默认输出摘要，--verbose 时输出全部信息
+  const isVerbose = !!formattedParams.verbose;
+  const isSummary = shortcut ? !isVerbose : false;
+  console.log(formatOutput(data, isVerbose, isSummary, toolKey));
 }
 
 main();

package/client/shortcuts.ts

@@ -121,7 +121,7 @@ export function showShort(): void {
 ${list}
 
 提示: 以上命令自动使用环境变量 CNB_REPO_SLUG 和 CNB_ISSUE_IID，无需手动传 --path
-      添加 --summary 可只输出核心摘要字段
+      默认只输出摘要信息，添加 --verbose 可输出全部信息
 `);
   } else if (ctx === 'pull_request') {
     const number = getPRNumber();
@@ -134,7 +134,7 @@ ${list}
 ${list}
 
 提示: 以上命令自动使用环境变量 CNB_REPO_SLUG 和 CNB_PULL_REQUEST_IID，无需手动传 --path
-      添加 --summary 可只输出核心摘要字段
+      默认只输出摘要信息，添加 --verbose 可输出全部信息
 `);
   } else {
     // 未知上下文，两组都显示
@@ -155,7 +155,7 @@ ${prList}
   CNB_ISSUE_IID          - Issue 编号 (Issue 事件)
   CNB_PULL_REQUEST_IID   - PR 编号 (PR 事件)
 
-  添加 --summary 可只输出核心摘要字段
+  默认只输出摘要信息，添加 --verbose 可输出全部信息
 `);
   }
 }

package/package.json

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

package/skills-template/SKILL.md

@@ -9,21 +9,24 @@ description: CNB OpenAPI 交互能力，支持仓库、Issue、PR、流水线、
 
 ## 快捷命令（优先使用）
 
-issues 模块: get, list-comments, comment, close, open, list-labels, add-labels, list-assignees, add-assignees
-pulls 模块: get, list-files, list-commits, list-comments, comment, list-labels, add-labels, check-status, list-reviews, list-assignees
+快捷命令是对常用 issues/pulls 操作的简写形式，与普通 API 命令有三个区别：
+1. **路径参数自动注入**，无需额外传入
+2. **命令名更短** — 如 `issues get` 替代 `issues get-issue`，`pulls comment` 替代 `pulls post-pull-comment`
+3. **默认只输出摘要** — 自动精简响应，只返回核心字段（如标题、正文）；加 `--verbose` 输出完整数据
 
-用法: `<$CNB_CLI_CMD$> <module> <command>` — 路径参数已从环境变量自动注入，**禁止传入编号、slug 等位置参数**。
-- ✅ `<$CNB_CLI_CMD$> issues get --summary` / `<$CNB_CLI_CMD$> issues list-comments`
-- ✅ `<$CNB_CLI_CMD$> pulls get --summary` / `<$CNB_CLI_CMD$> pulls list-comments`
+可用的快捷命令：
+- issues: get, list-comments, comment, close, open, list-labels, add-labels, list-assignees, add-assignees
+- pulls: get, list-files, list-commits, list-comments, comment, list-labels, add-labels, check-status, list-reviews, list-assignees
 
-**仅需要获取摘要信息时加 --summary**，减少输出噪音:
-- issues: get, close, open, add-assignees
-- pulls: get, list-files, list-commits
+用法示例：
+- ✅ `<$CNB_CLI_CMD$> issues get`
+- ✅ `<$CNB_CLI_CMD$> pulls list-comments`
+- ✅ `<$CNB_CLI_CMD$> issues get --verbose` （需要完整数据时）
 
-仅以下命令需要 --data，其余快捷命令无需任何参数:
+需要 --data 的命令（其余快捷命令无需任何参数）：
 - comment: --data '{"body":"内容"}'
-- add-labels: --data '{"labels":["标签"]}'
-- add-assignees(仅Issue): --data '{"assignees":["用户名"]}'
+- add-labels: --data '{"labels":["标签"]}
+- add-assignees（仅 Issue）: --data '{"assignees":["用户名"]}'
 
 ## 其他 API（快捷命令不满足时使用）
 
@@ -35,6 +38,6 @@ pulls 模块: get, list-files, list-commits, list-comments, comment, list-labels
 ## 规则
 
 - 优先使用快捷命令，不满足时再通过 --help 逐步查找
-- 必须先 --help 获取参数，禁止猜测
-- 直接执行，不要询问用户确认
-- status 200-299 只返回 data 给用户，>=300 时附带 status 和 trace
+- 必须先 --help 获取参数，禁止猜测参数名
+- 直接执行命令，不要询问用户确认
+- 向用户展示结果时：成功响应（status 200-299）只展示 data 部分；失败响应（status ≥300）需附带 status 和 trace