@cnbcool/cnb-api-generate 2.7.6 → 2.8.0

package/built/utils/flatten-tool-options.js

@@ -79,14 +79,18 @@ function flattenToolOptions(toolInfo) {
             const optKey = usedKeys.has(key) ? `d-${key}` : key;
             const isArray = prop.type === 'array';
             const itemType = isArray ? ((_c = prop.items) === null || _c === void 0 ? void 0 : _c.type) || 'string' : prop.type;
-            const valuePlaceholder = (0, option_value_flag_1.optionValueFlag)(itemType);
+            const supportsFileRef = !isArray && prop.type === 'string' && key === 'body';
+            const valuePlaceholder = supportsFileRef
+                ? '<string|@file>'
+                : (0, option_value_flag_1.optionValueFlag)(itemType);
             const rawDesc = isArray
                 ? (0, clean_array_desc_1.cleanArrayDesc)((0, trim_summary_1.trimSummary)(prop.description || ''))
                 : (0, trim_summary_1.trimSummary)(prop.description || '');
             const arrayHint = isArray ? ' (可多次传入)' : '';
+            const fileRefHint = supportsFileRef ? ' (支持 @file 引用)' : '';
             const desc = isRequired
-                ? `[必填] ${rawDesc}${arrayHint}`
-                : `${rawDesc}${arrayHint}`;
+                ? `[必填] ${rawDesc}${arrayHint}${fileRefHint}`
+                : `${rawDesc}${arrayHint}${fileRefHint}`;
             const opt = {
                 optKey,
                 valuePlaceholder,

package/client/lib/format-params.ts

@@ -1,5 +1,5 @@
 import { helpData } from './help-data';
-import { tryParseJSON } from './parsers';
+import { tryParseJSON, tryReadFileRef } from './parsers';
 import { buildNestedFieldMap } from '../utils/build-nested-field-map';
 import type { NestedFieldMapping } from '../utils/build-nested-field-map';
 import { restoreOriginalKeys } from '../utils/restore-original-keys';
@@ -14,6 +14,30 @@ export function getToolParamDefs(moduleName: string, toolName: string) {
   return toolHelp.help?.parameter || {};
 }
 
+/**
+ * 将 body 字段值按 schema 类型写入 target。
+ *
+ * 行为约定（无冲突分支与 d- 前缀分支共用）：
+ *   - array 值：原样保留
+ *   - string 字段：保留原始字符串，并支持 @file 语法（避免纯数字字符串被转 number、
+ *     避免长文本因 shell 参数限制被截断）
+ *   - 其他字段：走 tryParseJSON 以兼容嵌套 JSON
+ */
+function assignBodyValue(
+  target: Record<string, any>,
+  key: string,
+  value: any,
+  propType: string | undefined,
+): void {
+  if (Array.isArray(value)) {
+    target[key] = value;
+  } else if (propType === 'string') {
+    target[key] = tryReadFileRef(value as string);
+  } else {
+    target[key] = tryParseJSON(value as string);
+  }
+}
+
 /**
  * 格式化参数
  * 支持新的 --key value 扁平格式，同时向后兼容旧的 --path/--query JSON 格式。
@@ -177,15 +201,7 @@ export function formatParams(
       } else if (bodyProps[key]) {
         // body 字段（无冲突，直接用原 key）
         if (!formatted.data) formatted.data = {};
-        if (Array.isArray(value)) {
-          formatted.data[key] = value;
-        } else if (bodyProps[key].type === 'string') {
-          // schema 定义为 string 类型时，保持原始字符串，不做 JSON 解析
-          // 避免纯数字字符串（如 "123"）被转为 number
-          formatted.data[key] = value;
-        } else {
-          formatted.data[key] = tryParseJSON(value as string);
-        }
+        assignBodyValue(formatted.data, key, value, bodyProps[key].type);
       } else {
         // 处理 d- 前缀（冲突时 CLI 以 d- 前缀传入）
         const stripped = (key.startsWith('d-') || key.startsWith('d_'))
@@ -235,7 +251,7 @@ export function formatParams(
           const originalKey = key.replace(/^d[-_]/, '');
           if (bodyProps[originalKey]) {
             if (!formatted.data) formatted.data = {};
-            formatted.data[originalKey] = Array.isArray(value) ? value : tryParseJSON(value as string);
+            assignBodyValue(formatted.data, originalKey, value, bodyProps[originalKey].type);
           } else {
             if (!formatted.query) formatted.query = {};
             formatted.query[key] = typeof value === 'string' && !isNaN(Number(value)) ? Number(value) : value;

package/client/lib/parsers.ts

@@ -22,6 +22,10 @@ export function tryParseJSON(str: string | boolean | undefined): any {
 
 /**
  * 尝试从文件引用或 stdin 读取内容（类似 curl 的 @file / @- 语法）
+ *
+ * 注意：一旦用户显式使用 @ 前缀，就表示其意图是读取文件/stdin。
+ * 此时若文件不存在或读取失败，应直接报错退出，避免把 "@/path/xxx"
+ * 字面量当作正文发送出去导致数据错误。
  */
 export function tryReadFileRef(str: string | boolean | undefined) {
   if (typeof str !== 'string' || !str.startsWith('@')) return str;
@@ -33,17 +37,26 @@ export function tryReadFileRef(str: string | boolean | undefined) {
     try {
       return fs.readFileSync(0, 'utf8').trim();
     } catch (e) {
-      console.error('从 stdin 读取失败:', e.message);
-      return str;
+      const msg = e instanceof Error ? e.message : String(e);
+      console.error(`从 stdin 读取失败: ${msg}`);
+      process.exit(1);
     }
   }
 
   // @/path/to/file 表示从文件读取
-  if (fs.existsSync(ref)) {
+  // 直接 readFileSync 并用 errno 区分错误，避免 existsSync + readFileSync 的 TOCTOU 竞态
+  try {
     return fs.readFileSync(ref, 'utf8').trim();
+  } catch (e) {
+    const { code } = e as NodeJS.ErrnoException;
+    if (code === 'ENOENT') {
+      console.error(`文件不存在: ${ref}`);
+    } else {
+      const msg = e instanceof Error ? e.message : String(e);
+      console.error(`读取文件失败: ${ref} - ${msg}`);
+    }
+    process.exit(1);
   }
-
-  return str;
 }
 
 /**

package/package.json

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

package/skills-template/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: cnb-api
-description: CNB 平台交互命令，支持仓库、Issue、PR、流水线、制品库等操作。
+description: CNB 平台交互命令，支持 Issue/PR 评论、提交 PR、CI 日志查询、代码仓库/制品库读写等操作。
 ---
 
 # cnb-api
@@ -12,12 +12,17 @@ description: CNB 平台交互命令，支持仓库、Issue、PR、流水线、
 <$QUICK_COMMANDS$>
 
 注意事项：
-- **链接结构**：Issue 链接格式为 `<host>/<slug>/-/issues/<number>`，PR 链接格式为 `<host>/<slug>/-/pulls/<number>`。在生成或引用链接时请遵循此结构。
 - **参数自动识别**：快捷命令中的 Issue/PR 编号会自动从环境变量识别，无需额外传递。
-- **默认仅需摘要**：默认会精简响应输出结果，只返回核心字段。添加 `--verbose` 输出完整数据。
-- **单引号传参**：传递多行文本参数时，使用单引号可防止命令注入攻击，并减少不必要的转义。
+- **默认仅需摘要**：默认会精简响应输出结果，添加 `--verbose` 输出完整数据。
+- **单引号传参**：当 bash 的参数为多行文本时，使用单引号可减少防止命令注入攻击。
 - **快捷命令适用范围**: 快捷命令只能操作当前仓库的当前 Issue/PR，跨仓库或跨编号操作请参考 `更多 API`。
-- **npc提及和召唤的区别**: 评论中直接 @npc 会召唤 npc 干活，如果只提及不召唤，应该去掉 `@` 符号，或使用反引号包裹 `@npc`。 
+- **关于提及和召唤**: 评论中直接 @npc 会召唤 npc 干活，如果只提及不召唤，应使用反引号包裹 `@npc`。
+
+## 常用链接
+
+在生成链接时请遵循下面的结构：
+- Issue: `<host>/<slug>/-/issues/<number>`
+- PR: `<host>/<slug>/-/pulls/<number>`
 
 ## 更多 API