@cnbcool/cnb-api-generate 1.2.8 → 2.0.0

package/client/tools.help.ts

@@ -1,124 +0,0 @@
-import { trimSummary } from './modules.help';
-
-/**
- * 显示工具帮助文档
- * - path 和 query 参数混合展示为统一的 --key value 格式（LLM 不需要区分来源）
- * - body 参数展示顶层字段列表，从 schema.required 数组读取必填标记
- * - 权限直接读 help.json 中预提取的 permission 字段
- * @param helpData 帮助数据
- * @param moduleName 模块名称
- * @param tool 工具名称
- */
-export function showToolHelp(
-  helpData: any,
-  moduleName: string,
-  tool: string,
-): void {
-  const toolHelpData = helpData.modulesHelp[moduleName][tool];
-  if (!toolHelpData) {
-    console.error(`工具 ${tool} 不存在`);
-    process.exit(1);
-  }
-
-  const cliCmd = process.env.CNB_CLI_CMD || 'cnb';
-  const { summary, permission, help } = toolHelpData;
-  const { parameter } = help;
-  const { path, query, body } = parameter;
-
-  // 收集所有扁平参数（path + query 混合展示）
-  const paramLines: string[] = [];
-  const exampleParts: string[] = [];
-
-  // path 参数
-  if (path) {
-    for (const [key, param] of Object.entries(path) as any) {
-      const req = param.required ? ',必填' : '';
-      paramLines.push(`  --${key.padEnd(14)} (${param.type}${req}) ${param.description || ''}`);
-      if (param.required) {
-        exampleParts.push(`--${key} <${param.type}>`);
-      }
-    }
-  }
-
-  // query 参数
-  if (query) {
-    for (const [key, param] of Object.entries(query) as any) {
-      const req = param.required ? ',必填' : '';
-      const enumStr = param.enum ? ` [${param.enum.join(',')}]` : '';
-      paramLines.push(`  --${key.padEnd(14)} (${param.type}${req}) ${param.description || ''}${enumStr}`);
-      if (param.required) {
-        exampleParts.push(`--${key} <${param.type}>`);
-      }
-    }
-  }
-
-  // body 参数
-  let bodyMsg = '';
-  let bodyExample = '';
-  if (body) {
-    const { schema } = body;
-    if (schema) {
-      const bodyLines: string[] = [];
-      const bodyExampleObj: Record<string, string> = {};
-      const props = schema.type === 'array'
-        ? schema.items?.properties
-        : schema.properties;
-
-      // Swagger 的 required 是父级数组，不在每个 property 上
-      const requiredFields = new Set<string>(
-        schema.required || schema.items?.required || []
-      );
-
-      if (props) {
-        for (const [key, prop] of Object.entries(props) as any) {
-          const type = prop.type || 'object';
-          const isRequired = requiredFields.has(key);
-          const req = isRequired ? ',必填' : '';
-          // body 属性的 description 在生成时未 trim，运行时 trim
-          const desc = trimSummary(prop.description || '');
-          bodyLines.push(`  ${key.padEnd(16)} (${type}${req}) ${desc}`);
-          if (isRequired) {
-            bodyExampleObj[key] = `<${type}>`;
-          }
-        }
-      }
-
-      if (bodyLines.length > 0) {
-        bodyMsg = `\nBody (--data JSON):\n${bodyLines.join('\n')}`;
-      }
-      if (Object.keys(bodyExampleObj).length > 0) {
-        bodyExample = ` --data '${JSON.stringify(bodyExampleObj)}'`;
-      } else if (bodyLines.length > 0) {
-        // 没有 required 标记时，取前两个字段作为示例
-        const sampleKeys = Object.keys(props).slice(0, 2);
-        const sampleObj: Record<string, string> = {};
-        for (const k of sampleKeys) {
-          sampleObj[k] = `<${props[k].type || 'string'}>`;
-        }
-        if (sampleKeys.length > 0) {
-          bodyExample = ` --data '${JSON.stringify(sampleObj)}'`;
-        }
-      }
-    }
-  }
-
-  // 构建输出
-  let output = `${moduleName} ${tool} - ${summary}`;
-  if (permission) {
-    output += `\n权限: ${permission}`;
-  }
-
-  if (paramLines.length > 0) {
-    output += `\n\n参数:\n${paramLines.join('\n')}`;
-  }
-
-  if (bodyMsg) {
-    output += bodyMsg;
-  }
-
-  // 示例
-  const exampleCmd = `${cliCmd} ${moduleName} ${tool}${exampleParts.length > 0 ? ' ' + exampleParts.join(' ') : ''}${bodyExample}`;
-  output += `\n\n示例: ${exampleCmd}`;
-
-  console.log(output);
-}