@cnbcool/cnb-api-generate 1.0.0

package/client/tools.help.ts

@@ -0,0 +1,104 @@
+import util from 'util';
+import { schemaToJson } from './schemaToJson';
+/**
+ * 显示工具帮助文档
+ * @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 { summary, description, help } = toolHelpData;
+  const { parameter } = help;
+  const { path, query, body } = parameter;
+
+  // path参数说明
+  let pathMsg = '';
+  const pathParamsExample: Record<string, string> = {};
+  if (path) {
+    pathMsg = `--path参数详细说明：
+${Object.keys(path)
+  .map((key) => {
+    if (path[key].required) {
+      pathParamsExample[key] = `<${path[key].type}>`;
+    }
+    return `  - ${key} (${path[key].type}) - ${path[key].description}(${path[key].required ? '必填' : '选填'})`;
+  })
+  .join('\n')}
+`;
+  }
+
+  // query参数说明
+  let queryMsg = '';
+  const queryParamsExample: Record<string, string> = {};
+  if (query) {
+    queryMsg = `--query详细参数：
+${Object.keys(query)
+  .map((key) => {
+    if (query[key].required) {
+      queryParamsExample[key] = `<${query[key].type}>`;
+    } else if (query[key].default !== undefined) {
+      queryParamsExample[key] = query[key].default;
+    }
+    return `  - ${key} (${query[key].type}) - ${query[key].description}(${query[key].required ? '必填' : '选填'})${query[key].enum ? `, [枚举: ${query[key].enum.join(', ')}]` : ''}`;
+  })
+  .join('\n')}
+`;
+  }
+
+  // data参数说明
+  let bodyMsg = '';
+  let bodyParamsExample: Record<string, string> = {};
+  if (body) {
+    const { type, description, required, schema } = body;
+    if (schema) {
+      bodyParamsExample = schemaToJson(schema, {});
+      bodyMsg = `--data参数详细说明：
+${util.inspect(schema, { showHidden: false, depth: null })}`;
+    } else {
+      bodyMsg = `--data参数详细说明：
+  - ${type} - ${description}(${required ? '必填' : '选填'})
+`;
+    }
+  }
+
+  const exampleMsg = [
+    `node ./skills/scripts/core ${moduleName} ${tool}`,
+  ];
+  if (Object.keys(pathParamsExample).length > 0) {
+    exampleMsg.push(`--path '${JSON.stringify(pathParamsExample)}'`);
+  }
+  if (Object.keys(queryParamsExample).length > 0) {
+    exampleMsg.push(`--query '${JSON.stringify(queryParamsExample)}'`);
+  }
+  if (Object.keys(bodyParamsExample).length > 0) {
+    exampleMsg.push(`--data '${JSON.stringify(bodyParamsExample)}'`);
+  }
+
+  const helpMeg = `
+工具${tool}帮助文档\n
+工具说明：
+  1. ${summary}
+  2. ${description}
+\n参数说明：
+  <module> (必须) 模块名称 (例如: issues)，可直接配合 --help 查看该模块帮助
+  <tool>   (必须) 工具/动作名称 (例如: list-issues)
+  --path   (可选) 路径参数，JSON字符串
+  --query  (可选) 查询参数，JSON字符串
+  --data   (可选) 数据参数，JSON字符串
+  --help   (可选) 显示此帮助文档
+${pathMsg && `\n${pathMsg}`}${queryMsg && `\n${queryMsg}`}${bodyMsg && `\n${bodyMsg}`}
+\n使用示例：
+  ${exampleMsg.join(' ')}
+`;
+  console.log(helpMeg);
+}

package/client/utils/convert-link.ts

@@ -0,0 +1,139 @@
+/**
+ * 把文本里的相对路径转换为绝对路径
+ * 与 src/helpers/convertLink.ts 逻辑一致
+ *
+ * @param {String} text 待转换的文本
+ * @param {String} repoSlug 仓库路径
+ * @param {String} branchOrSha 可选，分支或SHA
+ * @returns {String}
+ */
+export default function convertLink(text: string, repoSlug: string | undefined, branchOrSha: string | undefined) {
+  // 查询所有代码块的位置
+  let codeBlockPositions = [];
+  let index = 0;
+  while (index !== -1) {
+    const nextIndex = text.indexOf('```', index);
+    if (nextIndex === -1) break;
+    codeBlockPositions.push(nextIndex);
+    index = nextIndex + 3; // 跳过已匹配的三个反引号
+  }
+  if (codeBlockPositions.length % 2 !== 0) {
+    codeBlockPositions = codeBlockPositions.slice(0, codeBlockPositions.length - 1);
+  }
+
+  // 查询所有行内代码块的位置
+  let inlineCodeBlockPositions = [];
+  index = 0;
+  while (index < text.length) {
+    const nextIndex = text.indexOf('`', index);
+    if (nextIndex === -1) break;
+    // 检查是否是单独的反引号（不是代码块的一部分）
+    if (
+      (nextIndex === 0 || text.charAt(nextIndex - 1) !== '`') &&
+      (nextIndex === text.length - 1 || text.charAt(nextIndex + 1) !== '`')
+    ) {
+      inlineCodeBlockPositions.push(nextIndex);
+    }
+    index = nextIndex + 1;
+  }
+  if (inlineCodeBlockPositions.length % 2 !== 0) {
+    inlineCodeBlockPositions = inlineCodeBlockPositions.slice(0, inlineCodeBlockPositions.length - 1);
+  }
+
+  // 整理起始和结束位置
+  const excludedRanges = [...codeBlockPositions, ...inlineCodeBlockPositions].reduce((result: any[], item, index) => {
+    if (index % 2 === 0) {
+      return result.concat([[item]]);
+    } else {
+      result[result.length - 1].push(item);
+      return result;
+    }
+  }, []);
+
+  // Helper function to check if an index is within excluded ranges
+  const isInExcludedRange = (index: number) => {
+    return excludedRanges.some(([start, end]) => index >= start && index < end);
+  };
+
+  let match;
+
+  // Collect all replacements with their positions
+  const replacements = [];
+
+  // Match markdown links and images: [alt](url), [](url), ![alt](url) and ![](url)
+  const markdownLinkRegex = /!?\[([^\]]*)\]\(([^)]+)\)/g;
+  while ((match = markdownLinkRegex.exec(text)) !== null) {
+    if (!isInExcludedRange(match.index)) {
+      // Calculate URL position: match.index + length of "![" + match[1] + "]("
+      const prefixLength = (match[0].startsWith('!') ? 1 : 0) + 1 + match[1].length + 2;
+      const urlStart = match.index + prefixLength;
+      const urlEnd = urlStart + match[2].length;
+      const newUrl = normaliseLink(match[2], repoSlug, branchOrSha);
+      if (newUrl !== match[2]) {
+        replacements.push({ start: urlStart, end: urlEnd, newUrl });
+      }
+    }
+  }
+
+  // Match HTML tags: <img src="..."> and <a href="...">
+  const htmlTagRegex = /\s(src|href)=["']([^"']+)["']/gi;
+  while ((match = htmlTagRegex.exec(text)) !== null) {
+    if (!isInExcludedRange(match.index)) {
+      const urlStart = match.index + match[0].indexOf(match[2]);
+      const urlEnd = urlStart + match[2].length;
+      const newUrl = normaliseLink(match[2], repoSlug, branchOrSha);
+      if (newUrl !== match[2]) {
+        replacements.push({ start: urlStart, end: urlEnd, newUrl });
+      }
+    }
+  }
+
+  // Sort replacements by start position in descending order
+  replacements.sort((a, b) => b.start - a.start);
+
+  // Apply replacements from end to start to maintain correct indices
+  let result = text;
+  for (const { start, end, newUrl } of replacements) {
+    result = result.substring(0, start) + newUrl + result.substring(end);
+  }
+
+  return result;
+}
+
+/**
+ * 相对路径转换为绝对路径
+ * 与 src/helpers/convertLink.ts 逻辑一致
+ *
+ * @param {String} link 待转换的链接
+ * @param {String} repoSlug 仓库路径
+ * @param {String} branchOrSha 分支或SHA，默认为 HEAD
+ * @returns {String}
+ */
+function normaliseLink(link: string, repoSlug: string | undefined, branchOrSha = 'HEAD') {
+  const { CNB_WEB_ENDPOINT } = process.env;
+  const baseURL = `${CNB_WEB_ENDPOINT}/${repoSlug}`;
+
+  if (link.startsWith('/-/')) {
+    return `${baseURL}${link}`;
+  }
+
+  if (
+    link.indexOf('/-/') === -1 &&
+    (
+      link.startsWith('../') ||
+      link.startsWith('./') ||
+      (link.startsWith('/') && !link.startsWith('//'))
+    )
+  ) {
+    let chunks = link.split('/');
+    // 过滤掉空字符串和 . .. 这些无效路径
+    chunks = chunks.filter((chunk) => !!chunk && chunk !== '.' && chunk !== '..');
+    if (chunks.length === 0) {
+      return link;
+    }
+    chunks.unshift(branchOrSha);
+    return `${baseURL}/-/git/raw/${chunks.join('/')}`;
+  }
+
+  return link;
+}

package/client/utils/generate-unique-id.ts

@@ -0,0 +1,3 @@
+export function generateUniqueId () {
+  return `${Date.now()}-${Math.random().toString(36).substring(2, 9)}`;
+};

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@cnbcool/cnb-api-generate",
+  "version": "1.0.0",
+  "main": "./built/index.js",
+  "module": "./src/index.ts",
+  "types": "./src/index.ts",
+  "license": "MIT",
+  "bin": {
+    "cag": "bin/cag.js",
+    "csg": "bin/csg.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://cnb.cool/cnb/skills/cnb-api-generate"
+  },
+  "scripts": {
+    "dev": "npx nodemon",
+    "dev:csg": "npx nodemon --config nodemon-skills.json",
+    "build": "rm -rf ./built && tsc --build tsconfig.build.json",
+    "lint": "eslint './src/**/*.{ts,tsx}' --quiet",
+    "lint:gen": "eslint './generated/**/*.{ts,tsx}' --quiet",
+    "ts:gen": "tsc --noEmit -p tsconfig.generated.json",
+    "check:gen": "yarn lint:gen && yarn ts:gen",
+    "lint:fix": "eslint src --fix",
+    "test": "jest",
+    "test:cover": "jest --coverage",
+    "gen:test": "npx swagger-typescript-api generate --path ./template/swagger.json --axios --extract-request-body --extract-response-body --extract-request-params --extract-response-error -o ./test"
+  },
+  "dependencies": {
+    "@babel/core": "^7.29.0",
+    "@babel/generator": "^7.29.1",
+    "@babel/parser": "^7.29.0",
+    "@babel/preset-env": "^7.29.0",
+    "@babel/preset-typescript": "^7.28.5",
+    "@babel/traverse": "^7.29.0",
+    "@types/cli-progress": "^3.11.6",
+    "@types/lodash": "4.17.20",
+    "babel-plugin-transform-define": "^2.1.4",
+    "cli-progress": "^3.12.0",
+    "debug": "4.4.1",
+    "glob": "^13.0.1",
+    "lodash": "^4.17.23",
+    "ora": "5.4.1",
+    "prettier": "3.4.2",
+    "rimraf": "6.0.1",
+    "typescript": "5.9.3"
+  },
+  "devDependencies": {
+    "@reduxjs/toolkit": "^1.9.5",
+    "@tencent/eslint-config-tencent": "^1.1.3",
+    "@types/debug": "4.1.12",
+    "@types/jest": "^29.5.3",
+    "@types/node": "24.0.12",
+    "@typescript-eslint/eslint-plugin": "8.48.1",
+    "@typescript-eslint/parser": "8.48.1",
+    "axios": "^1.13.6",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-config-turbo": "2.2.3",
+    "eslint-plugin-prettier": "5.2.1",
+    "jest": "^29.6.1",
+    "nodemon": "3.1.10",
+    "react-redux": "^8.0.7",
+    "ts-jest": "^29.1.1",
+    "ts-node": "10.9.2"
+  },
+  "files": [
+    "built",
+    "bin",
+    "package.json",
+    "skills-template",
+    "client",
+    "README.md"
+  ]
+}

package/skills-template/SKILL.md

@@ -0,0 +1,100 @@
+---
+name: cnb-skill
+description: 提供与CNB（Cloud Native Build）OpenAPI的完整交互能力，支持项目、组织、代码仓库、Issue、PR、合并请求、流水线，制品库等核心功能的增删改查操作。适用于开发协作、代码管理和CI/CD流程管理场景。关键词：CNB、云原生构建、组织、代码仓库、Issue、PR、合并请求、流水线、制品库，查询、新增、修改、删除、评论、合并、审批。
+---
+
+# cnb-skill
+
+## 概括
+
+本Skill提供完整的CNB的Openapi完整交互能力，用户可以使用此skills对CNB上的资源进行操作。
+
+## 适用场景
+
+当用户描述对CNB上的资源进行操作时，应该使用此skills进行操作。例如：
+- 查询cnb上某个仓库的Issue列表
+- 对cnb上的某个仓库的Issue或者pr进行评论。
+- ...
+
+## 核心原则
+
+### 准确性原则
+- **CRITICAL**: 必须先执行 `<$CNB_CLI_CMD$> --help` 获取最新的使用方式
+- **CRITICAL**: 必须通过使用 `<$CNB_CLI_CMD$>`命令行工具，按照帮助信息执行操作
+- **CRITICAL**: 禁止推测或臆断使用方式，严格基于脚本返回的帮助信息进行操作
+- **CRITICAL**: 不要询问用户"是否需要我执行"，直接根据帮助信息执行脚本，并返回结果
+
+## 脚本使用指南
+
+### 第一步：获取帮助信息
+在执行任何任务前，必须先运行以下命令获取最新的使用方式：
+
+```bash
+<$CNB_CLI_CMD$> --help
+```
+
+这将显示所有可用的模块及其工具列表。
+
+### 第二步：查看具体模块帮助
+使用 `--module` 参数查看特定模块的详细帮助：
+
+```bash
+<$CNB_CLI_CMD$> --module <模块名> -help
+```
+
+### 第三步：查看工具详细使用
+使用 `--module` 和 `--tool` 参数查看工具的详细参数说明：
+
+```bash
+<$CNB_CLI_CMD$> --module <模块名> --tool <工具名> --help
+```
+
+### 第四步：执行工具
+根据第三步获取的参数说明，执行工具：
+
+```bash
+<$CNB_CLI_CMD$> --module <模块名> --tool <工具名> --path '{"参数": "值"}' --query '{"参数": "值"}' --data '{"参数": "值"}'
+```
+
+**参数说明：**
+- `--module`: 必须参数，模块名称
+- `--tool`: 必须参数，工具名称
+- `--path`: 可选参数，路径参数，JSON字符串格式
+- `--query`: 可选参数，查询参数，JSON字符串格式
+- `--data`: 可选参数，数据参数，JSON字符串格式
+- `--help`: 可选参数，显示帮助文档
+
+### 第五步：处理结果
+
+每一个工具调用都会返回一个标准的JSON结构:
+- status: 一个http状态码
+- trace: 本次调用的traceID
+- header: 本次调用的header
+- data: 本次调用的openapi返回的实体内容
+
+#### header说明
+当请求列表时，会在header中包含以下字段说明列表的情况：
+- `x-cnb-page`: 当前页数
+- `x-cnb-page-size`: 每页条数
+- `x-cnb-total`: 总条数
+
+从中可以获取到列表的总条数，以及当前页数和每页条数，避免循环请求。
+
+#### status说明
+API 返回标准的 JSON 格式响应。请根据 HTTP 状态码判断请求是否成功：
+
+- 200: 请求成功
+- 400: 请求参数错误
+- 401: 未授权
+- 403: 禁止访问
+- 404: 资源不存在
+- 500: 服务器内部错误
+
+当本地调用返回的 `status` 在 200 ~ 299 之间，只需要返回 `data` 内容给用户。只有当 `status >= 300` 时，才将 `status` 和 `trace` 返回给用户。
+
+#### 资源处理
+
+当尝试下载图片进行图片分析时，遇到图片下载异常时，请使用以下工具进行图片下载！
+  ```bash
+  node scripts/core/index.js assets get-imgs --help
+```