@cnbcool/cnb-api-generate 1.0.0

package/client/index.ts

@@ -0,0 +1,377 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+import path from 'path';
+import { showModuleHelp } from './modules.help';
+import { showToolHelp } from './tools.help';
+import { showShort, resolveShortcut } from './shortcuts';
+import util from 'util';
+
+const helpFileContent = fs.readFileSync(
+  path.join(__dirname, 'help.json'),
+  'utf8',
+);
+if (!helpFileContent) {
+  console.error('help.json not found');
+  process.exit(1);
+}
+
+const helpData = JSON.parse(helpFileContent);
+/**
+ * 解析命令行参数
+ * @returns 解析后的参数对象
+ */
+// function parseArguments(): Record<string, string | boolean | undefined> {
+//   const args = process.argv.slice(2);
+//   const result: Record<string, string | boolean | undefined> = {};
+
+//   for (let i = 0; i < args.length; i++) {
+//     const arg = args[i];
+
+//     // 检查是否是参数名（以--开头）
+//     if (arg.startsWith('--')) {
+//       const paramName = arg.slice(2);
+
+//       // 检查下一个参数是否是值（不是以--开头）
+//       if (i + 1 < args.length && !args[i + 1].startsWith('--')) {
+//         result[paramName] = args[i + 1];
+//         i++; // 跳过下一个参数（值）
+//       } else {
+//         result[paramName] = paramName === 'help' ? true : undefined;
+//       }
+//     }
+//   }
+//   return result;
+// }
+
+export function parseArguments() {
+  const args = process.argv.slice(2);
+  const result: Record<string, string | boolean | undefined> = {};
+
+  let positionalCount = 0;
+  let i = 0;
+
+  while (i < args.length) {
+    const arg = args[i];
+
+    if (arg.startsWith('--')) {
+      // --- 处理命名参数 (Options) ---
+      const fullKey = arg.slice(2);
+      
+      // 支持 key=value 格式 (e.g., --config=file.json)
+      if (fullKey.includes('=')) {
+        const [key, ...valueParts] = fullKey.split('=');
+        result[key] = valueParts.join('=');
+        i++;
+        continue;
+      }
+
+      const key = fullKey;
+      
+      // 检查下一个参数是否是值
+      const nextArg = args[i + 1];
+      const isNextArgValue = 
+        i + 1 < args.length && 
+        !nextArg.startsWith('--') && 
+        !nextArg.startsWith('-'); // 也防止捕获短参数作为值
+
+      if (isNextArgValue) {
+        result[key] = nextArg;
+        i += 2; // 跳过 key 和 value
+      } else {
+        // 没有值，视为布尔标志 (flag)
+        // 特殊处理：如果用户显式想要 undefined 行为，可以在这里调整，但通常 CLI 中 flag 存在即为 true
+        result[key] = true;
+        i++;
+      }
+    } else if (arg.startsWith('-') && arg.length > 1 && !/^-?\d+$/.test(arg)) {
+      // --- 处理短参数 (Short flags, e.g., -h, -v) ---
+      // 注意：排除负数数字的情况
+      const key = arg.slice(1);
+      
+      // 简单处理：短参数通常不带长值，或者支持 -f value
+      const nextArg = args[i + 1];
+      const isNextArgValue = 
+        i + 1 < args.length && 
+        !nextArg.startsWith('--') && 
+        !nextArg.startsWith('-');
+
+      if (isNextArgValue && key.length === 1) { 
+        // 只有单字符短参才自动吞并下一个值 (如 -o output.txt)，多字符连写 (如 -abc) 通常视为多个布尔旗标
+        result[key] = nextArg;
+        i += 2;
+      } else {
+        result[key] = true;
+        i++;
+      }
+    } else {
+      // --- 处理位置参数 (Positional Args) ---
+      if (positionalCount === 0) {
+        result.module = arg;
+      } else if (positionalCount === 1) {
+        result.tool = arg;
+      }
+      positionalCount++;
+      i++;
+    }
+  }
+
+
+  return result;
+}
+
+/**
+ * 验证必须参数是否存在
+ * @param params 解析后的参数对象
+ * @returns 验证结果
+ */
+function validateRequiredParams(
+  params: Record<string, string | boolean | undefined>,
+): boolean {
+  if (!params.tool || params.help) {
+    return false;
+  }
+  return true;
+}
+
+/**
+ * 尝试解析JSON字符串
+ * @param str 要解析的字符串
+ * @returns 解析后的对象或原始字符串
+ */
+function tryParseJSON(str: string | boolean | undefined): any {
+  if (typeof str !== 'string') return str;
+
+  // 先将真实控制字符转义为 JSON 合法形式，处理 shell/AI 传入的原始换行等情况
+  const escaped = str.replace(/[\x00-\x1F\x7F]/g, (ch) => {
+    const map = { '\n': '\\n', '\r': '\\r', '\t': '\\t', '\b': '\\b', '\f': '\\f' };
+    return map[ch] || '\\u' + ch.charCodeAt(0).toString(16).padStart(4, '0');
+  });
+  try {
+    return JSON.parse(escaped);
+  } catch (error) {
+    return str;
+  }
+}
+
+/**
+ * 尝试从文件引用读取内容（支持 @filepath 语法，类似 curl -d @file）
+ * @param str 要检查的字符串
+ * @returns 文件内容或原始字符串
+ */
+/**
+ * 从文件引用或 stdin 读取内容（类似 curl 的 @file / @- 语法）
+ * @param str 要检查的字符串
+ * @returns 文件/stdin 内容或原始字符串
+ */
+function tryReadFileRef(str) {
+  if (typeof str !== 'string' || !str.startsWith('@')) return str;
+
+  const ref = str.slice(1);
+
+  // @- 表示从 stdin 读取
+  if (ref === '-') {
+    try {
+      return fs.readFileSync(0, 'utf8').trim();
+    } catch (e) {
+      console.error('从 stdin 读取失败:', e.message);
+      return str;
+    }
+  }
+
+  // @/path/to/file 表示从文件读取
+  if (fs.existsSync(ref)) {
+    return fs.readFileSync(ref, 'utf8').trim();
+  }
+
+  return str;
+}
+
+/**
+ * 格式化参数对象
+ * @param params 原始参数对象
+ * @returns 格式化后的参数对象
+ */
+function formatParams(
+  params: Record<string, string | boolean | undefined>,
+): Record<string, any> {
+  const formatted: Record<string, any> = {};
+
+  // 处理每个参数
+  for (const [key, value] of Object.entries(params)) {
+    if (typeof value === 'string') {
+      formatted[key] = tryParseJSON(tryReadFileRef(value));
+    } else if (typeof value === 'boolean') {
+      formatted[key] = value;
+    }
+  }
+
+  // 当没有传递query时，要判断当前tool是否支持query
+  if (formatted.query === undefined) {
+    const { module, tool } = formatted;
+    const toolsHelp = helpData.modulesHelp?.[module]?.[tool];
+    const toolsParam = toolsHelp?.help?.parameter || {};
+
+    if (toolsParam.query) {
+      formatted.query = {};
+    }
+  }
+
+  return formatted;
+}
+
+/**
+ * 显示帮助文档
+ * @param moduleName 模块名称，如果指定则显示模块帮助
+ */
+function showHelp(moduleName?: string, tool?: string): void {
+  if (moduleName && tool) {
+    showToolHelp(helpData, moduleName, tool);
+  } else if (moduleName) {
+    showModuleHelp(helpData, moduleName);
+  } else {
+    let moduleListMsg = ``;
+    for (const [module, count] of Object.entries(helpData.mainHelp)) {
+      moduleListMsg += `- ${module}, tool数量(${count})\n  `;
+    }
+
+    const helpMeg = `
+CNB OpenAPI CLI 工具\n
+可用模块：
+  ${moduleListMsg}
+参数说明：
+  <module> (必须) 模块名称 (例如: issues)，可直接配合 --help 查看该模块帮助
+  <tool>   (必须) 工具/动作名称 (例如: list-issues)
+  --path   (可选) 路径参数，JSON字符串
+  --query  (可选) 查询参数，JSON字符串
+  --data   (可选) 数据参数，JSON字符串
+  --help   (可选) 显示此帮助文档
+  --short  (可选) 显示操作当前仓库（Issue/PR）的快捷命令
+
+使用示例：
+  ${process.env.CNB_CLI_CMD} --help
+  ${process.env.CNB_CLI_CMD} --short
+  ${process.env.CNB_CLI_CMD} issues --help
+  ${process.env.CNB_CLI_CMD} issues list-issues --help
+  ${process.env.CNB_CLI_CMD} issues list-issues --path '{"repo": "my-project"}' --query '{"page": 1, "pageSize": 10}'
+`;
+    console.log(helpMeg);
+  }
+}
+
+/**
+ * 主函数
+ */
+async function main() {
+  // 解析命令行参数
+  const params = parseArguments();
+
+  // 处理 --short：显示当前场景的快捷命令
+  if (params.short) {
+    showShort();
+    process.exit(0);
+  }
+
+  // 尝试解析快捷命令（如 cnb issues get → get-issue）
+  const shortcut = resolveShortcut(
+    params.module as string | undefined,
+    params.tool as string | undefined,
+  );
+  if (shortcut) {
+    // 快捷命令：替换为实际 tool 名
+    params.tool = shortcut.tool;
+
+    // 自动注入 path 参数（如果用户没有手动传 --path）
+    if (!params.path) {
+      if (Object.keys(shortcut.autoPath).length > 0) {
+        params.path = JSON.stringify(shortcut.autoPath);
+      } else {
+        // 环境变量未设置，提示用户
+        const envHint =
+          params.module === 'issues'
+            ? 'CNB_REPO_SLUG 和 CNB_ISSUE_IID'
+            : 'CNB_REPO_SLUG 和 CNB_PULL_REQUEST_IID';
+        console.error(
+          `快捷命令需要环境变量 ${envHint}，或手动传 --path 参数。\n` +
+            `提示：运行 ${process.env.CNB_CLI_CMD || 'cnb'} --short 查看快捷命令详情。`,
+        );
+        process.exit(1);
+      }
+    }
+
+    // 自动注入 data 参数（如 close → {"state":"closed"}）
+    if (shortcut.autoData && !params.data) {
+      params.data = JSON.stringify(shortcut.autoData);
+    }
+  }
+
+  // 验证必须参数（当没有请求帮助时）
+  if (!validateRequiredParams(params)) {
+    showHelp(
+      params.module as string | undefined,
+      params.tool as string | undefined,
+    );
+    process.exit(0);
+  }
+
+  // 格式化参数
+  const formattedParams = formatParams(params);
+
+  // 动态引入模块
+  const toolPath = path.join(
+    __dirname,
+    '../modules',
+    `${formattedParams.module}/${formattedParams.tool}.js`,
+  );
+
+  if (!fs.existsSync(toolPath)) {
+    console.error(`工具文件不存在: ${toolPath}`);
+    process.exit(1);
+  }
+
+  const toolModule = require(toolPath);
+  const toolFunction = toolModule.default;
+
+  if (!toolFunction) {
+    console.error(`工具函数不存在`);
+    process.exit(1);
+  }
+
+  const toolsParam: any[] = [];
+  let pathAndQueryParams: Record<string, any> | string | null = null;
+
+  if (
+    formattedParams.path &&
+    Object.keys(formattedParams.path).length === 1 &&
+    !formattedParams.query
+  ) {
+    pathAndQueryParams =
+      formattedParams.path[Object.keys(formattedParams.path)[0]];
+  } else {
+    if (formattedParams.path) {
+      pathAndQueryParams = { ...formattedParams.path };
+    }
+
+    if (formattedParams.query) {
+      pathAndQueryParams = {
+        ...(pathAndQueryParams && typeof pathAndQueryParams === 'object'
+          ? pathAndQueryParams
+          : {}),
+        ...formattedParams.query,
+      };
+    }
+  }
+
+  if (pathAndQueryParams) {
+    toolsParam.push(pathAndQueryParams);
+  }
+
+  if (formattedParams.data) {
+    toolsParam.push(formattedParams.data);
+  }
+
+  const data = await toolFunction(...toolsParam);
+  console.log(util.inspect(data, { showHidden: false, depth: null }));
+}
+
+main();

package/client/modules.help.ts

@@ -0,0 +1,36 @@
+/**
+ * 显示模块帮助文档
+ * @param helpData 帮助数据
+ * @param moduleName 模块名称
+ */
+export function showModuleHelp(helpData: any, moduleName: string): void {
+  const moduleHelpData = helpData.modulesHelp[moduleName];
+  if (!moduleHelpData) {
+    console.error(`模块 ${moduleName} 不存在`);
+    process.exit(1);
+  }
+
+  let toolListMsg = ``;
+  for (const [tool, info] of Object.entries(moduleHelpData)) {
+    toolListMsg += `- ${(info as any).filename}, ${(info as any).summary}\n  `;
+  }
+
+  const helpMeg = `
+模块${moduleName}帮助文档\n
+可用工具：
+  ${toolListMsg}
+参数说明：
+  <module> (必须) 模块名称 (例如: issues)，可直接配合 --help 查看该模块帮助
+  <tool>   (必须) 工具/动作名称 (例如: list-issues)
+  --path   (可选) 路径参数，JSON字符串
+  --query  (可选) 查询参数，JSON字符串
+  --data   (可选) 数据参数，JSON字符串
+  --help   (可选) 显示此帮助文档
+
+使用示例：
+  ${process.env.CNB_CLI_CMD} issues --help
+  ${process.env.CNB_CLI_CMD} issues list-issues --help
+  ${process.env.CNB_CLI_CMD} issues list-issues --path '{"repo": "my-project"}' --query '{"page": 1, "pageSize": 10}'
+`;
+  console.log(helpMeg);
+}

package/client/schemaToJson.ts

@@ -0,0 +1,26 @@
+export function schemaToJson(schema: any, json: any): any {
+  if (schema.type === 'object' || schema.type === 'array') {
+    const props =
+      schema.type === 'object' ? schema.properties : schema.items.properties;
+    // eslint-disable-next-line no-restricted-syntax
+    for (const key in props) {
+      const { type, items } = props[key];
+
+      if (type === 'object') {
+        json[key] = schemaToJson(props[key], {});
+      } else if (type === 'array') {
+        if (items.properties) {
+          json[key] = [schemaToJson(props[key], {})];
+        } else {
+          json[key] = [items.type];
+        }
+      } else {
+        json[key] = type;
+      }
+    }
+  } else {
+    return schema.type;
+  }
+
+  return json;
+}

package/client/shortcuts.ts

@@ -0,0 +1,208 @@
+/**
+ * 快捷命令模块
+ *
+ * 根据 CNB 环境变量自动检测当前事件类型（Issue / PR），
+ * 提供场景化的快捷命令，自动从环境变量注入 path 参数。
+ */
+
+// ============================================================
+// 类型定义
+// ============================================================
+
+export type EventContext = 'issue' | 'pull_request' | 'unknown';
+
+export interface ShortcutDefinition {
+  /** 用户看到的短命令名 */
+  shortName: string;
+  /** 实际对应的 tool 文件名 */
+  realTool: string;
+  /** 显示用的中文说明 */
+  description: string;
+  /** 是否需要用户传 --data，如果不为 null 则自动注入 */
+  autoData?: Record<string, any>;
+  /** --data 的使用提示（展示用） */
+  dataTip?: string;
+}
+
+export interface ResolvedShortcut {
+  /** 解析后的实际 tool 名 */
+  tool: string;
+  /** 自动注入的 path 参数 */
+  autoPath: Record<string, string>;
+  /** 自动注入的 data 参数（如 close/open） */
+  autoData: Record<string, any> | null;
+}
+
+// ============================================================
+// 环境变量检测
+// ============================================================
+
+export function detectEventContext(): EventContext {
+  if (process.env.CNB_ISSUE_IID) return 'issue';
+  if (process.env.CNB_PULL_REQUEST_IID) return 'pull_request';
+  return 'unknown';
+}
+
+function getRepo(): string {
+  return process.env.CNB_REPO_SLUG || '<CNB_REPO_SLUG>';
+}
+
+function getIssueNumber(): string {
+  return process.env.CNB_ISSUE_IID || '<CNB_ISSUE_IID>';
+}
+
+function getPRNumber(): string {
+  return process.env.CNB_PULL_REQUEST_IID || '<CNB_PULL_REQUEST_IID>';
+}
+
+// ============================================================
+// 快捷命令定义
+// ============================================================
+
+const ISSUE_SHORTCUTS: ShortcutDefinition[] = [
+  { shortName: 'get',            realTool: 'get-issue',            description: '获取详情' },
+  { shortName: 'list-comments',  realTool: 'list-issue-comments',  description: '获取评论列表' },
+  { shortName: 'comment',        realTool: 'post-issue-comment',   description: '评论',           dataTip: "--data '{\"body\":\"内容\"}'" },
+  { shortName: 'close',          realTool: 'update-issue',         description: '关闭',           autoData: { state: 'closed', state_reason: 'completed' } },
+  { shortName: 'open',           realTool: 'update-issue',         description: '打开',           autoData: { state: 'open', state_reason: 'reopened' } },
+  { shortName: 'list-labels',    realTool: 'list-issue-labels',    description: '查看标签' },
+  { shortName: 'add-labels',     realTool: 'post-issue-labels',    description: '添加标签',        dataTip: "--data '{\"labels\":[\"bug\",\"feature\"]}'" },
+  { shortName: 'list-assignees', realTool: 'list-issue-assignees', description: '查看处理人' },
+  { shortName: 'add-assignees',  realTool: 'post-issue-assignees', description: '添加处理人',      dataTip: "--data '{\"assignees\":[\"username\"]}'" },
+];
+
+const PR_SHORTCUTS: ShortcutDefinition[] = [
+  { shortName: 'get',            realTool: 'get-pull',                description: '获取详情' },
+  { shortName: 'list-files',     realTool: 'list-pull-files',         description: '获取文件变更' },
+  { shortName: 'list-commits',   realTool: 'list-pull-commits',       description: '获取提交记录' },
+  { shortName: 'list-comments',  realTool: 'list-pull-comments',      description: '获取评论列表' },
+  { shortName: 'comment',        realTool: 'post-pull-comment',       description: '评论',           dataTip: "--data '{\"body\":\"内容\"}'" },
+  { shortName: 'list-labels',    realTool: 'list-pull-labels',        description: '查看标签' },
+  { shortName: 'add-labels',     realTool: 'post-pull-labels',        description: '添加标签',        dataTip: "--data '{\"labels\":[\"ready\",\"approved\"]}'" },
+  { shortName: 'check-status',   realTool: 'list-pull-commit-statuses', description: '查看 CI 状态' },
+  { shortName: 'list-reviews',   realTool: 'list-pull-reviews',       description: '查看评审列表' },
+  { shortName: 'list-assignees', realTool: 'list-pull-assignees',     description: '查看处理人' },
+];
+
+// ============================================================
+// --short 帮助输出
+// ============================================================
+
+function formatShortcutList(
+  shortcuts: ShortcutDefinition[],
+  cliCmd: string,
+  moduleName: string,
+): string {
+  const maxDescLen = Math.max(...shortcuts.map((s) => s.description.length));
+
+  return shortcuts
+    .map((s) => {
+      const desc = s.description.padEnd(maxDescLen + 2, '　'); // 全角空格对齐
+      const cmd = `${cliCmd} ${moduleName} ${s.shortName}`;
+      const dataPart = s.dataTip ? ` ${s.dataTip}` : '';
+      return `  ${desc} ${cmd}${dataPart}`;
+    })
+    .join('\n');
+}
+
+export function showShort(): void {
+  const ctx = detectEventContext();
+  const cliCmd = process.env.CNB_CLI_CMD || 'cnb';
+  const repo = getRepo();
+
+  if (ctx === 'issue') {
+    const number = getIssueNumber();
+    const list = formatShortcutList(ISSUE_SHORTCUTS, cliCmd, 'issues');
+    console.log(`
+📋 当前场景: Issue 事件 (Issue #${number})
+   仓库: ${repo}
+
+常用快捷命令（path 参数已从环境变量自动获取）：
+${list}
+
+提示: 以上命令自动使用环境变量 CNB_REPO_SLUG 和 CNB_ISSUE_IID，无需手动传 --path
+`);
+  } else if (ctx === 'pull_request') {
+    const number = getPRNumber();
+    const list = formatShortcutList(PR_SHORTCUTS, cliCmd, 'pulls');
+    console.log(`
+🔀 当前场景: Pull Request 事件 (PR #${number})
+   仓库: ${repo}
+
+常用快捷命令（path 参数已从环境变量自动获取）：
+${list}
+
+提示: 以上命令自动使用环境变量 CNB_REPO_SLUG 和 CNB_PULL_REQUEST_IID，无需手动传 --path
+`);
+  } else {
+    // 未知上下文，两组都显示
+    const issueList = formatShortcutList(ISSUE_SHORTCUTS, cliCmd, 'issues');
+    const prList = formatShortcutList(PR_SHORTCUTS, cliCmd, 'pulls');
+    console.log(`
+⚠️  未检测到 Issue/PR 事件上下文
+   (CNB_ISSUE_IID 和 CNB_PULL_REQUEST_IID 均未设置)
+
+📋 Issue 场景常用命令（需要设置 CNB_ISSUE_IID 环境变量）：
+${issueList}
+
+🔀 PR 场景常用命令（需要设置 CNB_PULL_REQUEST_IID 环境变量）：
+${prList}
+
+提示: 快捷命令需要以下环境变量:
+  CNB_REPO_SLUG          - 仓库路径
+  CNB_ISSUE_IID          - Issue 编号 (Issue 事件)
+  CNB_PULL_REQUEST_IID   - PR 编号 (PR 事件)
+`);
+  }
+}
+
+// ============================================================
+// 快捷命令解析
+// ============================================================
+
+/**
+ * 尝试将用户输入的 module + tool 解析为快捷命令
+ *
+ * 即使环境变量未设置，也会完成 shortName → realTool 的映射，
+ * 只是 autoPath 为 null，调用方需要用户手动传 --path。
+ *
+ * @returns 解析结果，如果不是快捷命令则返回 null
+ */
+export function resolveShortcut(
+  moduleName: string | undefined,
+  toolName: string | undefined,
+): ResolvedShortcut | null {
+  if (!moduleName || !toolName) return null;
+
+  // 根据 module 名确定对应的快捷命令表
+  let shortcuts: ShortcutDefinition[] | null = null;
+  let autoPath: Record<string, string> | null = null;
+
+  if (moduleName === 'issues') {
+    shortcuts = ISSUE_SHORTCUTS;
+    const repo = process.env.CNB_REPO_SLUG;
+    const number = process.env.CNB_ISSUE_IID;
+    if (repo && number) {
+      autoPath = { repo, number };
+    }
+  } else if (moduleName === 'pulls') {
+    shortcuts = PR_SHORTCUTS;
+    const repo = process.env.CNB_REPO_SLUG;
+    const number = process.env.CNB_PULL_REQUEST_IID;
+    if (repo && number) {
+      autoPath = { repo, number };
+    }
+  }
+
+  if (!shortcuts) return null;
+
+  // 在快捷命令表中查找匹配的 shortName
+  const matched = shortcuts.find((s) => s.shortName === toolName);
+  if (!matched) return null;
+
+  return {
+    tool: matched.realTool,
+    autoPath: autoPath || {},
+    autoData: matched.autoData || null,
+  };
+}