feima-shortcuts 1.0.11 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feima-shortcuts",
-  "version": "1.0.11",
+  "version": "1.1.1",
   "description": "快捷指令",
   "main": "index.js",
   "directories": {

package/src/generateApi/index.js

@@ -2,9 +2,64 @@ const { Command } = require("commander");
 const { spawn } = require("child_process");
 const fs = require("fs");
 const path = require("path");
-const { deleteFolder } = require("../utils/deleteFolder");
-const { makeDir } = require("../utils/makeDir");
-const requestTemplate = require("./requestTemplate");
+
+const getTemplate = require("./orval.config.ts.template");
+
+
+/**
+ * 交换 Swagger JSON 中 tags 的 name 和 description，
+ * 并同步更新 paths 下引用的 tag。
+ *
+ * @param {object} swaggerJson Swagger JSON 对象
+ * @returns {object} 修改后的 Swagger JSON
+ */
+function swapSwaggerTags(swaggerJson) {
+  if (!swaggerJson || !Array.isArray(swaggerJson.tags)) {
+    throw new Error("无效的 Swagger JSON：缺少 tags 数组");
+  }
+
+  // 建立映射表：旧 name => 新 name（原来的 description）
+  const tagMap = {};
+
+  swaggerJson.tags = swaggerJson.tags.map(tag => {
+    const oldName = tag.name;
+    const newName = tag.description || oldName; // 防止 description 为空
+    const newDesc = oldName;
+
+    tagMap[oldName] = newName;
+
+    return {
+      ...tag,
+      name: newName,
+      description: newDesc,
+    };
+  });
+
+  // 更新 paths 下的 tags
+  if (swaggerJson.paths) {
+    for (const pathKey of Object.keys(swaggerJson.paths)) {
+      const pathObj = swaggerJson.paths[pathKey];
+      for (const methodKey of Object.keys(pathObj)) {
+        const method = pathObj[methodKey];
+        if (Array.isArray(method.tags)) {
+          method.tags = method.tags.map(tag => tagMap[tag] || tag);
+        }
+      }
+    }
+  }
+
+  return swaggerJson;
+}
+
+const handleSwaggerJson = async (url, filePath) => {
+  const res = await fetch(url);
+  if (!res.ok) throw new Error(`下载失败：${res.status}`);
+  console.log('🔗 下载成功');
+  const data = await res.json();
+  const swaggerJson = swapSwaggerTags(data);
+  fs.writeFileSync(filePath, JSON.stringify(swaggerJson, null, 2));
+  console.log('📝 已写入文件', filePath);
+};
 
 exports.run = () => {
   const program = new Command();
@@ -14,59 +69,47 @@ exports.run = () => {
     .description("从 Swagger/OpenAPI 文档地址生成 API 元数据")
     .option(
       "-i, --input <url>",
-      "Swagger/OpenAPI 文档地址，例如 http://192.168.0.74:9999/app/v3/api-docs"
-    )
-    .option(
-      "-o, --output <dir>",
-      "输出目录，默认 src/api",
-      "src/api"
-  )
-     .option(
-      "-bu, --base-url <dir>",
-      "基础URL，默认 空",
-      ""
+      "Swagger/OpenAPI 文档地址，例如 http://192.168.0.74:9999/admin/v3/api-docs"
     )
+    .option("-o, --output <dir>", "输出目录，默认 src/api")
+    .option("-bu, --base-url <dir>", "基础URL，默认 空")
     .allowUnknownOption(true) // 保持向后兼容，忽略未知参数
     .action(async (opts) => {
-      const input = opts?.input || "http://192.168.0.74:9999/app/v3/api-docs";
-      const output = opts?.output || "src/api";
+      const input = opts?.input || "";
+      const output = opts?.output || "";
       const baseUrl = opts?.baseUrl || "";
-      console.log(`📥 generate-api 输入地址: ${input}`);
-      console.log(`📦 输出目录: ${output}`);
-
-
-      // 生成前清空并重建输出目录，避免遗留文件
-      try {
-        const fullOutputDir = path.resolve(process.cwd(), output);
-        if (fs.existsSync(fullOutputDir)) {
-          deleteFolder(fullOutputDir);
-        }
-        makeDir(fullOutputDir);
-        console.log("🧹 已清空并初始化输出目录");
-      } catch (e) {
-        console.error("❌ 初始化输出目录失败:", e.message);
-        process.exit(1);
+      if (!input) {
+        console.error("请输入 Swagger/OpenAPI 文档地址");
+        return;
       }
+      if (!output) {
+        console.error("请输入输出目录");
+        return;
+      }
+      if (!baseUrl) {
+        console.error("请输入基础URL");
+        return;
+      }
+      
+      const tmpSwaggerFileName = "tmp-swagger.json";
+      await handleSwaggerJson(input, path.resolve(process.cwd(), tmpSwaggerFileName));
 
-      // 确保 ./tmpRequest.ts 使用内置的 requestStr（放在项目根目录）
-      const requestFile = path.resolve(process.cwd(), "tmpRequest.ts");
+      // 确保 ./orvalConfig.ts 使用内置的 requestStr（放在项目根目录）
+      const orvalConfig = path.resolve(process.cwd(), "orval.config.ts");
       try {
-        fs.writeFileSync(requestFile, requestTemplate, "utf8");
-        console.log("📝 已写入 ./tmpRequest.ts");
+        fs.writeFileSync(
+          orvalConfig,
+          getTemplate(`./${tmpSwaggerFileName}`, output, baseUrl),
+          "utf8"
+        );
+        console.log("📝 已写入 ./orvalConfig.ts");
       } catch (e) {
-        console.error("❌ 写入 ./tmpRequest.ts 失败:", e.message);
+        console.error("❌ 写入 ./orvalConfig.ts 失败:", e.message);
         process.exit(1);
       }
-      // 在当前执行目录生成到指定 output，并指定自定义 request 实现
-      const args = [
-        "openapi-typescript-codegen",
-        "--input",
-        input,
-        "--output",
-        output,
-        "--request",
-        "./tmpRequest.ts",
-      ];
+
+      // 在当前执行目录生成API代码
+      const args = ["orval"];
 
       const child = spawn("npx", ["--yes", ...args], {
         stdio: "inherit",
@@ -74,19 +117,27 @@ exports.run = () => {
         shell: false,
       });
 
-      const cleanupTempRequest = () => {
+      const cleanupTempFiles = () => {
         try {
-          if (fs.existsSync(requestFile)) {
-            fs.unlinkSync(requestFile);
-            console.log("🧹 已清理临时文件 ./tmpRequest.ts");
+          if (fs.existsSync(orvalConfig)) {
+            fs.unlinkSync(orvalConfig);
+            console.log("🧹 已清理临时文件 ./orval.config.ts");
           }
         } catch (e) {
           console.warn("⚠️ 清理临时文件失败:", e.message);
         }
+        try {
+          if (fs.existsSync(tmpSwaggerFileName)) {
+            fs.unlinkSync(tmpSwaggerFileName);
+            console.log("🧹 已清理临时文件 ./tmp-swagger.json");
+          }
+        } catch (error) {
+          console.warn("⚠️ 清理临时文件失败:", error.message);
+        }
       };
 
       child.on("close", (code) => {
-        cleanupTempRequest();
+        cleanupTempFiles();
         if (code === 0) {
           console.log(`✅ OpenAPI 代码已生成到 ${output}`);
           process.exit(0);
@@ -96,5 +147,6 @@ exports.run = () => {
         }
       });
     });
+
   program.parse(process.argv);
 };

package/src/generateApi/orval.config.ts.template.js

@@ -0,0 +1,26 @@
+const getTemplate = (input, output, baseUrl) => { 
+  return `export default {
+  admin: {
+    input: "${input}",
+    output: {
+      mode: "tags-split",
+      target: "${output}",
+      schemas: "${output}/model",
+      baseUrl: "${baseUrl}",
+      client: "axios-functions",
+      clean: true,
+      override: {
+        mutator: {
+          path: "src/utils/request.ts",
+          name: "request",
+        },
+      },
+    },
+    hooks: {
+      afterAllFilesWrite: "npx prettier --write",
+    },
+  },
+};`
+}
+
+module.exports = getTemplate;

package/src/generateApi/requestTemplate.js

@@ -1,371 +0,0 @@
-const template = `/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import axios from "axios";
-import service from "@/utils/request";
-import type {
-  AxiosError,
-  AxiosRequestConfig,
-  AxiosResponse,
-  AxiosInstance,
-} from "axios";
-import FormData from "form-data";
-
-import { ApiError } from "./ApiError";
-import type { ApiRequestOptions } from "./ApiRequestOptions";
-import type { ApiResult } from "./ApiResult";
-import { CancelablePromise } from "./CancelablePromise";
-import type { OnCancel } from "./CancelablePromise";
-import type { OpenAPIConfig } from "./OpenAPI";
-
-export const isDefined = <T>(
-  value: T | null | undefined
-): value is Exclude<T, null | undefined> => {
-  return value !== undefined && value !== null;
-};
-
-export const isString = (value: any): value is string => {
-  return typeof value === "string";
-};
-
-export const isStringWithValue = (value: any): value is string => {
-  return isString(value) && value !== "";
-};
-
-export const isBlob = (value: any): value is Blob => {
-  return (
-    typeof value === "object" &&
-    typeof value.type === "string" &&
-    typeof value.stream === "function" &&
-    typeof value.arrayBuffer === "function" &&
-    typeof value.constructor === "function" &&
-    typeof value.constructor.name === "string" &&
-    /^(Blob|File)$/.test(value.constructor.name) &&
-    /^(Blob|File)$/.test(value[Symbol.toStringTag])
-  );
-};
-
-export const isFormData = (value: any): value is FormData => {
-  return value instanceof FormData;
-};
-
-export const isSuccess = (status: number): boolean => {
-  return status >= 200 && status < 300;
-};
-
-export const base64 = (str: string): string => {
-  try {
-    return btoa(str);
-  } catch (err) {
-    // @ts-ignore
-    return Buffer.from(str).toString("base64");
-  }
-};
-
-export const getQueryString = (params: Record<string, any>): string => {
-  const qs: string[] = [];
-
-  const append = (key: string, value: any) => {
-    qs.push(\`\${encodeURIComponent(key)}=\${encodeURIComponent(String(value))}\`);
-  };
-
-  const process = (key: string, value: any) => {
-    if (isDefined(value)) {
-      if (Array.isArray(value)) {
-        value.forEach((v) => {
-          process(key, v);
-        });
-      } else if (typeof value === "object") {
-        Object.entries(value).forEach(([k, v]) => {
-          process(\`\${key}[\${k}]\`, v);
-        });
-      } else {
-        append(key, value);
-      }
-    }
-  };
-
-  Object.entries(params).forEach(([key, value]) => {
-    process(key, value);
-  });
-
-  if (qs.length > 0) {
-    return \`?\${qs.join("&")}\`;
-  }
-
-  return "";
-};
-
-const getUrl = (config: OpenAPIConfig, options: ApiRequestOptions): string => {
-  const encoder = config.ENCODE_PATH || encodeURI;
-
-  const path = options.url
-    .replace("{api-version}", config.VERSION)
-    .replace(/{(.*?)}/g, (substring: string, group: string) => {
-      if (options.path?.hasOwnProperty(group)) {
-        return encoder(String(options.path[group]));
-      }
-      return substring;
-    });
-
-  const url = \`\${config.BASE}\${path}\`;
-  if (options.query) {
-    return \`\${url}\${getQueryString(options.query)}\`;
-  }
-  return url;
-};
-
-export const getFormData = (
-  options: ApiRequestOptions
-): FormData | undefined => {
-  if (options.formData) {
-    const formData = new FormData();
-
-    const process = (key: string, value: any) => {
-      if (isString(value) || isBlob(value)) {
-        formData.append(key, value);
-      } else {
-        formData.append(key, JSON.stringify(value));
-      }
-    };
-
-    Object.entries(options.formData)
-      .filter(([_, value]) => isDefined(value))
-      .forEach(([key, value]) => {
-        if (Array.isArray(value)) {
-          value.forEach((v) => process(key, v));
-        } else {
-          process(key, value);
-        }
-      });
-
-    return formData;
-  }
-  return undefined;
-};
-
-type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
-
-export const resolve = async <T>(
-  options: ApiRequestOptions,
-  resolver?: T | Resolver<T>
-): Promise<T | undefined> => {
-  if (typeof resolver === "function") {
-    return (resolver as Resolver<T>)(options);
-  }
-  return resolver;
-};
-
-export const getHeaders = async (
-  config: OpenAPIConfig,
-  options: ApiRequestOptions,
-  formData?: FormData
-): Promise<Record<string, string>> => {
-  const [token, username, password, additionalHeaders] = await Promise.all([
-    resolve(options, config.TOKEN),
-    resolve(options, config.USERNAME),
-    resolve(options, config.PASSWORD),
-    resolve(options, config.HEADERS),
-  ]);
-
-  const formHeaders =
-    (typeof formData?.getHeaders === "function" && formData?.getHeaders()) ||
-    {};
-
-  const headers = Object.entries({
-    Accept: "application/json",
-    ...additionalHeaders,
-    ...options.headers,
-    ...formHeaders,
-  })
-    .filter(([_, value]) => isDefined(value))
-    .reduce(
-      (headers, [key, value]) => ({
-        ...headers,
-        [key]: String(value),
-      }),
-      {} as Record<string, string>
-    );
-
-  if (isStringWithValue(token)) {
-    headers["Authorization"] = \`Bearer \${token}\`;
-  }
-
-  if (isStringWithValue(username) && isStringWithValue(password)) {
-    const credentials = base64(\`\${username}:\${password}\`);
-    headers["Authorization"] = \`Basic \${credentials}\`;
-  }
-
-  if (options.body !== undefined) {
-    if (options.mediaType) {
-      headers["Content-Type"] = options.mediaType;
-    } else if (isBlob(options.body)) {
-      headers["Content-Type"] = options.body.type || "application/octet-stream";
-    } else if (isString(options.body)) {
-      headers["Content-Type"] = "text/plain";
-    } else if (!isFormData(options.body)) {
-      headers["Content-Type"] = "application/json";
-    }
-  }
-
-  return headers;
-};
-
-export const getRequestBody = (options: ApiRequestOptions): any => {
-  if (options.body) {
-    return options.body;
-  }
-  return undefined;
-};
-
-export const sendRequest = async <T>(
-  config: OpenAPIConfig,
-  options: ApiRequestOptions,
-  url: string,
-  body: any,
-  formData: FormData | undefined,
-  headers: Record<string, string>,
-  onCancel: OnCancel,
-  axiosClient: AxiosInstance
-): Promise<AxiosResponse<T>> => {
-  const source = axios.CancelToken.source();
-
-  const requestConfig: AxiosRequestConfig = {
-    url,
-    headers,
-    data: body ?? formData,
-    method: options.method,
-    withCredentials: config.WITH_CREDENTIALS,
-    withXSRFToken:
-      config.CREDENTIALS === "include" ? config.WITH_CREDENTIALS : false,
-    cancelToken: source.token,
-  };
-
-  onCancel(() => source.cancel("The user aborted a request."));
-
-  try {
-    return await axiosClient.request(requestConfig);
-  } catch (error) {
-    const axiosError = error as AxiosError<T>;
-    if (axiosError.response) {
-      return axiosError.response;
-    }
-    throw error;
-  }
-};
-
-export const getResponseHeader = (
-  response: AxiosResponse<any>,
-  responseHeader?: string
-): string | undefined => {
-  if (responseHeader) {
-    const content = response.headers[responseHeader];
-    if (isString(content)) {
-      return content;
-    }
-  }
-  return undefined;
-};
-
-export const getResponseBody = (response: AxiosResponse<any>): any => {
-  if (response.status !== 204) {
-    return response;
-  }
-  return undefined;
-};
-
-export const catchErrorCodes = (
-  options: ApiRequestOptions,
-  result: ApiResult
-): void => {
-  const errors: Record<number, string> = {
-    400: "Bad Request",
-    401: "Unauthorized",
-    403: "Forbidden",
-    404: "Not Found",
-    500: "Internal Server Error",
-    502: "Bad Gateway",
-    503: "Service Unavailable",
-    ...options.errors,
-  };
-
-  const error = errors[result.status];
-  if (error) {
-    throw new ApiError(options, result, error);
-  }
-  if (!result.ok) {
-    const errorStatus = result.status ?? "unknown";
-    const errorStatusText = result.statusText ?? "unknown";
-    const errorBody = (() => {
-      try {
-        return JSON.stringify(result.body, null, 2);
-      } catch (e) {
-        return undefined;
-      }
-    })();
-
-    throw new ApiError(
-      options,
-      result,
-      \`Generic Error: status: \${errorStatus}; status text: \${errorStatusText}; body: \${errorBody}\`
-    );
-  }
-};
-
-/**
- * Request method
- * @param config The OpenAPI configuration object
- * @param options The request options from the service
- * @param axiosClient The axios client instance to use
- * @returns CancelablePromise<T>
- * @throws ApiError
- */
-export const request = <T>(
-  config: OpenAPIConfig,
-  options: ApiRequestOptions,
-  axiosClient: AxiosInstance = service
-): CancelablePromise<T> => {
-  return new CancelablePromise(async (resolve, reject, onCancel) => {
-    try {
-      const url = getUrl(config, options);
-      const formData = getFormData(options);
-      const body = getRequestBody(options);
-      const headers = await getHeaders(config, options, formData);
-
-      if (!onCancel.isCancelled) {
-        const response: any = await sendRequest<T>(
-          config,
-          options,
-          url,
-          body,
-          formData,
-          headers,
-          onCancel,
-          axiosClient
-        );
-        const responseBody = getResponseBody(response);
-        const responseHeader = getResponseHeader(
-          response,
-          options.responseHeader
-        );
-        const result: ApiResult = {
-          url,
-          ok: response.ok,
-          status: response.code,
-          statusText: response.msg,
-          body: responseHeader ?? responseBody,
-        };
-
-        catchErrorCodes(options, result);
-
-        resolve(result.body);
-      }
-    } catch (error) {
-      reject(error);
-    }
-  });
-};
-`
-
-module.exports = template;