Merge pull request #110 from long-woo/dev

v2.12.0

Author: long-woo

README.md

@@ -152,8 +152,8 @@ Create a `myPlugin.ts` file:
 
 ```ts
 // 引用模块
-// import { start } from 'https://deno.land/x/stc@2.11.0/mod.ts'
-import { start } from 'jsr:@lonu/stc@^2.11.0'
+// import { start } from 'https://deno.land/x/stc@2.12.0/mod.ts'
+import { start } from 'jsr:@lonu/stc@^2.12.0'
 
 // Defining plugins
 const myPlugin: IPlugin = {

deno.json

@@ -1,12 +1,12 @@
 {
   "name": "@lonu/stc",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "exports": "./mod.ts",
   "tasks": {
     "pack": "deno run -A src/pack.ts",
-    "dev": "deno task pack && deno run -A --watch=src src/main.ts --url='https://petstore3.swagger.io/api/v3/openapi.json'",
+    "dev": "deno task pack && deno run -A --watch=src src/main.ts --url='https://petstore3.swagger.io/api/v3/openapi.json' --clean=false",
     "serve": "deno run -A --watch=src src/service.ts",
-    "version": "echo '2.11.0' > release/version",
+    "version": "echo '2.12.0' > release/version",
     "build:npm": "deno run -A src/npm/build.ts",
     "build:mac": "deno compile -A --target x86_64-apple-darwin --output release/stc src/main.ts",
     "build:mac-m": "deno compile -A --target aarch64-apple-darwin --output release/stc-m src/main.ts",
@@ -52,6 +52,7 @@
   "imports": {
     "./": "./",
     "/": "./",
+    "x/": "https://deno.land/x/",
     "@deno-library/progress": "jsr:@deno-library/progress@^1.4.9",
     "@deno/dnt": "jsr:@deno/dnt@^0.41.3",
     "@eta-dev/eta": "jsr:@eta-dev/eta@^3.5.0",
@@ -60,6 +61,6 @@
     "@std/datetime": "jsr:@std/datetime@^0.225.1",
     "@std/fmt": "jsr:@std/fmt@^1.0.1",
     "@std/fs": "jsr:@std/fs@^1.0.2",
-    "x/": "https://deno.land/x/"
+    "diff": "npm:diff@^7.0.0"
   }
 }

src/app.ts

@@ -3,9 +3,11 @@ import type { IPluginContext } from "./plugins/typeDeclaration.ts";
 import Logs from "./console.ts";
 import { PluginManager } from "./plugins/index.ts";
 import { getApiPath, getDefinition } from "./core.ts";
-import { createFile, emptyDirectory, readFile, removeFile } from "./utils.ts";
+import { createDiffFile, createFile, readFile, removeFile } from "./utils.ts";
 import { getT } from "./i18n/index.ts";
 
+const LOCK_FILE = ".stc.lock";
+
 /**
  * 初始化插件管理器
  */
@@ -36,22 +38,49 @@ const createContext = (context: IPluginContext) => {
  * @param urlOrPath - 远程地址或本地
  * @returns
  */
-const getData = async (urlOrPath: string): Promise<ISwaggerResult> => {
-  if (!/^http(s?):\/\//.test(urlOrPath)) {
-    const content = await readFile(urlOrPath);
-
-    try {
-      return JSON.parse(content) as unknown as ISwaggerResult;
-    } catch (error) {
-      throw new Error(getT("$t(app.apiJsonFileError)", { error }));
-    }
-  }
+const getData = async (
+  urlOrPath: string,
+  _outDir: string,
+): Promise<ISwaggerResult> => {
+  try {
+    // const lockFile = await readFile(`${outDir}/${LOCK_FILE}`);
+    let data: ISwaggerResult;
 
-  // 从远程地址获取 Swagger 数据
-  const res = await fetch(urlOrPath);
+    // 从本地文件获取 Swagger 数据
+    if (!/^http(s?):\/\//.test(urlOrPath)) {
+      const content = await readFile(urlOrPath);
 
-  try {
-    const data = await res.json();
+      data = JSON.parse(content) as unknown as ISwaggerResult;
+    } else {
+      // 从远程地址获取 Swagger 数据
+      const res = await fetch(urlOrPath);
+
+      data = await res.json();
+    }
+
+    // 对比 path 和 definitions/schemas 数据是否有变化，有变化则使用新数据
+    // if (lockFile) {
+    //   const oldData = JSON.parse(lockFile) as unknown as ISwaggerResult;
+    //   createFile(
+    //     `${outDir}/.stc_new.lock`,
+    //     JSON.stringify(data, null, 2),
+    //     {
+    //       banner: false,
+    //     },
+    //   );
+    //   const isChange = diff["diffLines"](
+    //     JSON.stringify(oldData, null, 2),
+    //     JSON.stringify(data, null, 2),
+    //   );
+
+    //   createFile(
+    //     `${outDir}/.stc_diff.lock`,
+    //     JSON.stringify(isChange, null, 2),
+    //     {
+    //       banner: false,
+    //     },
+    //   );
+    // }
 
     return data;
   } catch (error) {
@@ -67,7 +96,7 @@ export const start = async (options: DefaultConfigOptions): Promise<void> => {
   // 创建上下文
   const context = createContext({ options });
 
-  const data = await getData(options.url);
+  const data = await getData(options.url, options.outDir);
 
   // 触发插件 onload 事件
   context.onLoad?.(data, context.options);
@@ -81,12 +110,15 @@ export const start = async (options: DefaultConfigOptions): Promise<void> => {
   // 触发插件 onAction 事件
   context.onAction?.(actionData, context.options);
 
-  if (options.shared) {
-    // 清空输出目录
-    await emptyDirectory(options.outDir);
-  } else {
+  if (options.clean) {
+    const exclude = [`${options.outDir}/${LOCK_FILE}`];
+
+    if (!options.shared) {
+      exclude.push(`${options.outDir}/shared/**/*`);
+    }
+
     await removeFile(`${options.outDir}/**/*.*`, {
-      exclude: [`${options.outDir}/shared/**/*`],
+      exclude,
     });
   }
 
@@ -99,22 +131,24 @@ export const start = async (options: DefaultConfigOptions): Promise<void> => {
 
   // 写入类型定义文件
   if (transformData?.definition?.content) {
-    createFile(
-      `${options.outDir}/${transformData.definition.filename}`,
-      transformData.definition.content,
-    );
+    const name = `${options.outDir}/${transformData.definition.filename}`;
+    const content = transformData.definition.content;
+
+    createDiffFile(name, content, options.clean);
   }
 
   // 写入 API 文件
   if (transformData?.action) {
     transformData.action.forEach((content, filename) => {
-      createFile(
-        `${options.outDir}/${filename}`,
-        content,
-      );
+      createDiffFile(`${options.outDir}/${filename}`, content, options.clean);
     });
   }
 
+  // 保存数据
+  createFile(`${options.outDir}/${LOCK_FILE}`, JSON.stringify(data, null, 2), {
+    banner: false,
+  });
+
   console.log("\n");
   Logs.success(`${getT("$t(app.generateFileDone)")}\n\t${options.outDir}\n`);
   // 触发插件 onEnd 事件

src/cli.ts

@@ -38,10 +38,11 @@ const checkUpdate = async () => {
     const _lastVersion = Number(latestVersion.replace(/\./g, "") ?? 0);
 
     if (version < _lastVersion) {
+      // 非 deno compile 的可执行文件，仅提示更新
       if (typeof confirm === "undefined") {
-        // 提示用户是否更新
+        // 提示有新版本
         console.log("\n");
-        Logs.info(getT("$t(cli.updatePrompt)", {
+        Logs.warn(getT("$t(cli.updatePrompt)", {
           version: denoJson.version,
           latestVersion,
         }));
@@ -173,6 +174,7 @@ ${getT("$t(cli.option)")}
   -c, --conjunction  ${getT("$t(cli.option_conjunction)")}
   --actionIndex      ${getT("$t(cli.option_actionIndex)")}
   --shared           ${getT("$t(cli.option_shared)")}
+  --clean            ${getT("$t(cli.option_clean)")}
   -v, --version      ${getT("$t(cli.option_version)")}
 
 ${getT("$t(cli.example)")}
@@ -188,7 +190,7 @@ ${getT("$t(cli.example)")}
 export const main = async (): Promise<DefaultConfigOptions> => {
   // 定义命令行参数和选项的配置
   const argsConfig: ParseOptions = {
-    boolean: ["help", "version", "shared"],
+    boolean: ["help", "version", "shared", "clean"],
     string: [
       "url",
       "outDir",
@@ -215,6 +217,7 @@ export const main = async (): Promise<DefaultConfigOptions> => {
       conjunction: "By",
       actionIndex: "-1",
       shared: true,
+      clean: true,
     },
     unknown: (arg: string) => {
       Logs.error(getT("$t(cli.unknownOption)", { arg }));
@@ -259,5 +262,6 @@ export const main = async (): Promise<DefaultConfigOptions> => {
     conjunction: args.conjunction,
     actionIndex: args.actionIndex,
     shared: args.shared,
+    clean: args.clean,
   };
 };

src/core.ts

@@ -384,17 +384,21 @@ const getPathVirtualProperty = (
       const _bodyContentRef = getRefType(
         _bodyContentSchema?.$ref ?? _bodyContentSchema?.items?.$ref ?? "",
       );
-      const _name = (_key === "application/octet-stream"
-        ? "file"
-        : lowerCase(_bodyContentRef)) || "body";
 
       // 处理 type 为 object 的情况，并且有 properties 属性
       if (
         _bodyContentSchema?.type === "object" &&
         !Object.keys(_bodyContentSchema?.properties ?? {}).length
-      ) {
-        return;
-      }
+      ) return;
+
+      const _name =
+        (["application/octet-stream", "multipart/form-data"].includes(_key)
+          ? "file"
+          : lowerCase(_bodyContentRef)) || "body";
+
+      const _type = _name === "file"
+        ? "FormData"
+        : _bodyContentSchema?.type ?? "";
 
       const _properties = getProperties(
         _bodyContentSchema?.properties ?? {},
@@ -403,7 +407,7 @@ const getPathVirtualProperty = (
 
       const _body: IDefinitionVirtualProperty = {
         name: _name,
-        type: _bodyContentSchema?.type ?? "",
+        type: _type,
         required: _requestBody.required ?? true,
         description: _requestBody.description,
         ref: _bodyContentRef,
@@ -412,9 +416,7 @@ const getPathVirtualProperty = (
 
       // body 存在相同 name 时，无需重复添加
       if (
-        !parameters.body.some((item) =>
-          item.name === _name
-        )
+        !parameters.body.some((item) => item.name === _name)
       ) {
         parameters.body.push(_body);
       }

src/i18n/locales/en.json

@@ -10,7 +10,7 @@
     "timeout": "Request timed out."
   },
   "def": {
-    "parserTypeError": "Cannot parse {{name}} type {{type}} as it is not an object type."
+    "parserTypeError": "{{name}} with type {{type}} is ignored as it is not an object type."
   },
   "path": {
     "notName": "{{url}} [{{method}}] cannot get the method name, so it will be ignored.",
@@ -42,7 +42,8 @@
     "option_version": "View version information.",
     "option_conjunction": "Conjunction of method name. [default: \"By\"].",
     "option_actionIndex": "Method name index. [default: -1].",
-    "option_shared": "Whether to generate the shared directory. [default: true]."
+    "option_shared": "Whether to generate the shared directory. [default: true].",
+    "option_clean": "Whether to clean the output directory before generating. [default: true]."
   },
   "plugin": {
     "name": "Load plugin {{name}}",
@@ -55,11 +56,11 @@
     "no_200_response": "Missing information for 200 status code.",
     "no_tag": "{{url}} does not specify a tag, skip parsing. Please use the --tag parameter.",
     "template": {
-      "enumRequired": "Missing enum.eta template file",
-      "actionImportRequired": "Missing actionImport.eta template file",
-      "definitionHeader": "Missing definitionHeader.eta template file",
-      "definitionBody": "Missing definitionBody.eta template file",
-      "definitionFooter": "Missing definitionFooter.eta template file"
+      "enumRequired": "Missing enum.eta template file.",
+      "actionImportRequired": "Missing actionImport.eta template file.",
+      "definitionHeader": "Missing definitionHeader.eta template file.",
+      "definitionBody": "Missing definitionBody.eta template file.",
+      "definitionFooter": "Missing definitionFooter.eta template file."
     }
   },
   "plugin_javascript": {

src/i18n/locales/zh-CN.json

@@ -10,7 +10,7 @@
     "timeout": "请求超时。"
   },
   "def": {
-    "parserTypeError": "{{name}} 类型 {{type}}，非 object 类型无法解析。"
+    "parserTypeError": "{{name}} 类型为 {{type}}，非 object 类型已忽略。"
   },
   "path": {
     "notName": "{{url}} 【{{method}}】 无法获取方法名称，故忽略。",
@@ -42,7 +42,8 @@
     "option_version": "显示版本信息。",
     "option_conjunction": "方法名的连接词。 [默认: \"By\"]。",
     "option_actionIndex": "方法名的索引。 [默认: -1]。",
-    "option_shared": "是否生成 shared 目录。 [默认: true]。"
+    "option_shared": "是否生成 shared 目录。 [默认: true]。",
+    "option_clean": "是否清空输出目录。 [默认: true]。"
   },
   "plugin": {
     "name": "加载插件 {{name}}",
@@ -55,11 +56,11 @@
     "no_200_response": "缺少 200 状态码的信息。",
     "no_tag": "{{url}} 未指定 tag，跳过解析。请使用 --tag 参数。",
     "template": {
-      "enumRequired": "缺失 enum.eta 模板文件",
-      "actionImportRequired": "缺失 actionImport.eta 模板文件",
-      "definitionHeader": "缺失 definitionHeader.eta 模板文件",
-      "definitionBody": "缺失 definitionBody.eta 模板文件",
-      "definitionFooter": "缺失 definitionFooter.eta 模板文件"
+      "enumRequired": "缺失 enum.eta 模板文件。",
+      "actionImportRequired": "缺失 actionImport.eta 模板文件。",
+      "definitionHeader": "缺失 definitionHeader.eta 模板文件。",
+      "definitionBody": "缺失 definitionBody.eta 模板文件。",
+      "definitionFooter": "缺失 definitionFooter.eta 模板文件。"
     }
   },
   "plugin_javascript": {

src/npm/pkg.json

@@ -1,6 +1,6 @@
 {
   "name": "@lonu/stc",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "description": "A tool for converting OpenApi/Swagger/Apifox into code.",
   "type": "module",
   "module": "esm/mod.js",

src/plugins/typescript/shared/apiClientBase.ts

@@ -24,7 +24,7 @@ export interface ApiClientConfig {
    * 忽略错误发生的 url 或 baseURL，不触发 error 回调函数。示例：/api/test
    */
   errorIgnore?: string[]
-  config?: Pick<ApiClientConfig, 'baseURL' | 'timeout' | 'signal'>
+  config?: Pick<ApiClientConfig, 'baseURL' | 'timeout' | 'signal'> & { headers?: IDefaultObject}
   /**
    * 错误回调函数
    */

src/plugins/typescript/shared/axios/index.ts

@@ -105,7 +105,7 @@ export const request = <T>(
     method: config.method,
     data: _data,
     params: config.params?.query,
-    headers: config.params?.header as AxiosHeaders,
+    headers: {...config.params?.header, ...config.config.headers} as AxiosHeaders,
     timeout: config.config?.timeout,
     signal: config.config?.signal,
     baseURL: config.config?.baseURL,