@cnbcool/cnb-api-generate 2.8.0 → 2.8.2

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

@@ -79,18 +79,14 @@ 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 supportsFileRef = !isArray && prop.type === 'string' && key === 'body';
-            const valuePlaceholder = supportsFileRef
-                ? '<string|@file>'
-                : (0, option_value_flag_1.optionValueFlag)(itemType);
+            const valuePlaceholder = (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}${fileRefHint}`
-                : `${rawDesc}${arrayHint}${fileRefHint}`;
+                ? `[必填] ${rawDesc}${arrayHint}`
+                : `${rawDesc}${arrayHint}`;
             const opt = {
                 optKey,
                 valuePlaceholder,
@@ -101,13 +97,26 @@ function flattenToolOptions(toolInfo) {
             };
             options.push(opt);
         }
+        // 若 body 中存在 string 类型的 `body` 字段，提供独立的 --body-file 选项，
+        // 从指定文件读取内容作为正文（适合多行/长文本，避免 shell 参数长度限制）。
+        const bodyProp = bodyDef.schema.properties.body;
+        if (bodyProp && bodyProp.type === 'string') {
+            options.push({
+                optKey: 'body-file',
+                valuePlaceholder: '<path>',
+                description: '从文件读取内容作为 body 正文',
+                required: false,
+                isArray: false,
+                source: 'body',
+            });
+        }
     }
     // body 存在时添加 --data fallback
     if (bodyDef) {
         options.push({
             optKey: 'data',
             valuePlaceholder: '<json>',
-            description: 'Request body (JSON 字符串或 @file 引用，可替代逐个 body 字段)',
+            description: 'Request body (JSON 字符串，可替代逐个 body 字段)',
             required: false,
             isArray: false,
             source: 'body',

package/client/lib/format-params.ts

@@ -1,5 +1,6 @@
+import { removeSlashes } from 'slashes';
 import { helpData } from './help-data';
-import { tryParseJSON, tryReadFileRef } from './parsers';
+import { tryParseJSON, readFileContent } 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';
@@ -16,12 +17,14 @@ export function getToolParamDefs(moduleName: string, toolName: string) {
 
 /**
  * 将 body 字段值按 schema 类型写入 target。
- *
- * 行为约定（无冲突分支与 d- 前缀分支共用）：
  *   - array 值：原样保留
- *   - string 字段：保留原始字符串，并支持 @file 语法（避免纯数字字符串被转 number、
- *     避免长文本因 shell 参数限制被截断）
+ *   - string 字段：还原 shell 字面转义（如 --body "a\n b" 中的 \n → 真换行），
+ *     并保留原始字符串（避免纯数字字符串被转 number）
  *   - 其他字段：走 tryParseJSON 以兼容嵌套 JSON
+ *
+ * 说明：shell 在单/双引号下不解释 `\n`，外部程序（包括本 CLI 经 commander）
+ * 收到的是字面的反斜杠 + n。这里用 slashes.removeSlashes 做一次反解析，
+ * 让 `--body "a\n b"` 与 `echo -e` 体验一致，正确还原为真实换行/制表符等。
  */
 function assignBodyValue(
   target: Record<string, any>,
@@ -32,7 +35,7 @@ function assignBodyValue(
   if (Array.isArray(value)) {
     target[key] = value;
   } else if (propType === 'string') {
-    target[key] = tryReadFileRef(value as string);
+    target[key] = typeof value === 'string' ? removeSlashes(value) : value;
   } else {
     target[key] = tryParseJSON(value as string);
   }
@@ -75,8 +78,20 @@ export function formatParams(
       'module', 'tool', 'help', 'short', 'verbose', 'h', 'v',
     ]);
 
+    // --body-file: 从指定文件读取内容作为 body 字段正文（适合多行/长文本）。
+    // 仅当 tool 存在 string 类型的 body 字段时，flatten-tool-options 才注册该选项。
+    // restoreOriginalKeys 已把 commander 的 camelCase（bodyFile）还原为 body-file，这里兼容两种形态。
+    // 读取到内容后在最后统一写入 formatted.data.body（优先级最高）。
+    reservedKeys.add('body-file');
+    reservedKeys.add('bodyFile');
+    let bodyFromFile: string | undefined;
+    const bodyFileRef = (params['body-file'] ?? (params as any).bodyFile);
+    if (typeof bodyFileRef === 'string' && bodyFileRef.length > 0) {
+      bodyFromFile = readFileContent(bodyFileRef);
+    }
+
     // --data 是 CLI 通用 fallback 选项（见 flatten-tool-options.ts，仅在 tool 有 body 时注册），
-    // 接收 JSON 字符串（或 @file 引用）作为 body 整体。
+    // 接收 JSON 字符串作为 body 整体。
     // 仅当 'data' 不是该 tool 真实的 path/query/body 字段名时才启用 fallback 语义，
     // 否则按 swagger 定义当业务字段处理（保留 commit 120d557 引入的能力）。
     //
@@ -92,7 +107,7 @@ export function formatParams(
     if (dataIsFallback) {
       reservedKeys.add('data');
       if (typeof params.data === 'string' && params.data.length > 0) {
-        const parsed = tryParseJSON(tryReadFileRef(params.data));
+        const parsed = tryParseJSON(params.data);
         if (bodyIsArrayType && Array.isArray(parsed)) {
           dataArrayFromFlag = parsed;
         } else if (!bodyIsArrayType && parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
@@ -302,6 +317,13 @@ export function formatParams(
     } else if (dataBaseFromFlag) {
       formatted.data = { ...dataBaseFromFlag, ...(formatted.data || {}) };
     }
+
+    // --body-file 优先级最高：覆盖 --body 逐字段值与 --data 中的 body，
+    // 确保「从文件读取正文」的显式意图最终生效。
+    if (bodyFromFile !== undefined) {
+      if (!formatted.data) formatted.data = {};
+      formatted.data.body = bodyFromFile;
+    }
   }
 
   // formatted.query 仅在用户真传了 query 值时才存在；toolFunction 第 1 形参形态

package/client/lib/parsers.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cnbcool/cnb-api-generate",
-  "version": "2.8.0",
+  "version": "2.8.2",
   "main": "./built/index.js",
   "module": "./src/index.ts",
   "types": "./src/index.ts",
@@ -45,6 +45,7 @@
     "ora": "5.4.1",
     "prettier": "3.4.2",
     "rimraf": "6.0.1",
+    "slashes": "^3.0.12",
     "typescript": "5.9.3"
   },
   "devDependencies": {