perf: perf docs and code style

Author: rookie-luochao

.changeset/smooth-lights-greet.md

@@ -2,4 +2,4 @@
 'openapi-ts-request': minor
 ---
 
-新增增量修改，方法命名规范，合并openapi-ts和openapi命令
+feat: 新增增量修改，方法命名规范，合并openapi-ts和openapi命令

README-en_US.md

@@ -13,7 +13,7 @@ based on [Swagger2/OpenAPI3/Apifox](https://swagger.io/blog/news/whats-new-in-op
 - react-query/vue-query
 - type field label
 - JSON Schemas
-- Apifox
+- Apifox Config
 
 docs：[use docs](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
@@ -26,7 +26,7 @@ docs：[use docs](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 - support filter generate result by tags
 - support JSON/YAML specification
 - support translate chinese tag name to english tag name
-- Support direct configuration of `apifox` `token` and `projectId` direct generation
+- support direct configuration of `apifox` `token` and `projectId` direct generation
 
 ## Usage
 
@@ -187,7 +187,9 @@ $ openapi --help
     -o, --output <string>               output directory
     -cfn, --configFileName <string>     config file name
     -cfp, --configFilePath <string>     config file path
+    -u, --uniqueKey <string>            unique key
     --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
+    -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
     --includeTags <(string|RegExp)[]>   generate code from include tags
@@ -209,7 +211,6 @@ $ openapi --help
     --isOnlyGenTypeScriptType <boolean> only generate typescript type (default: false)
     --isCamelCase <boolean>             camelCase naming of controller files and request client (default: true)
     --isSupportParseEnumDesc <boolean>  parse enum description to generate enum label (default: false)
-    -f, --full                          full replacement
     -h, --help                          display help for command
 ```
 
@@ -226,6 +227,7 @@ openapi -i ./spec.json -o ./apis
 | schemaPath | yes | string | - | Swagger2/OpenAPI3 URL |
 | serversPath | no | string | './src/apis' | the folder path for the run results |
 | requestLibPath | no | string | 'axios' | custom request lib path, for example: '@/request', 'node-fetch' |
+| full | no | boolean | true | full replacement |
 | enableLogging | no | boolean | false | open the log |
 | priorityRule | no | string | 'include' | priority rule, include/exclude/both |
 | includeTags | no | (string\|RegExp)[] | - | generate code from include tags, priorityRule=include required |
@@ -242,14 +244,13 @@ openapi -i ./spec.json -o ./apis
 | isGenJsonSchemas | no | boolean | false | generate JSON Schemas |
 | mockFolder | no | string | - | mock file path, for example: './mocks' |
 | authorization | no | string | - | docs authorization |
+| apifoxConfig | no | [Apifox Config](#Apifox-Config) | - | apifox configs |
 | nullable | no | boolean | false | null instead of optional |
 | isTranslateToEnglishTag | no | boolean | false | translate chinese tag name to english tag name |
 | isOnlyGenTypeScriptType | no | boolean | false | only generate typescript type |
 | isCamelCase | no | boolean | true | camelCase naming of controller files and request client |
 | isSupportParseEnumDesc | no | boolean | false | parse enum description to generate enum label, format example: `UserRole:User(Normal User)=0,Agent(Agent)=1,Admin(Administrator)=2` |
 | hook | no | [Custom Hook](#Custom-Hook) | - | custom hook |
-| apifoxConfig | no | [Apifox Config](#Apifox-Config) | - | apifox configs |
-| full | no | boolean | false | full replacement |
 
 ## Custom Hook
 

README.md

@@ -15,7 +15,7 @@
 - react-query/vue-query
 - 类型字段翻译
 - JSON Schemas
-- Apifox
+- Apifox Config
 
 文档：[使用手册](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
@@ -189,7 +189,9 @@ $ openapi --help
     -o, --output <string>               output directory
     -cfn, --configFileName <string>     config file name
     -cfp, --configFilePath <string>     config file path
+    -u, --uniqueKey <string>            unique key
     --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
+    -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
     --includeTags <(string|RegExp)[]>   generate code from include tags
@@ -211,7 +213,6 @@ $ openapi --help
     --isOnlyGenTypeScriptType <boolean> only generate typescript type (default: false)
     --isCamelCase <boolean>             camelCase naming of controller files and request client (default: true)
     --isSupportParseEnumDesc <boolean>  parse enum description to generate enum label (default: false)
-    -f, --full                          full replacement
     -h, --help                          display help for command
 ```
 
@@ -228,6 +229,7 @@ openapi --i ./spec.json --o ./apis
 | schemaPath | 是 | string | - | Swagger2/OpenAPI3 地址 |
 | serversPath | 否 | string | './src/apis' | 运行结果文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
+| full | 否 | boolean | true | 是否全量替换 |
 | enableLogging | 否 | boolean | false | 是否开启日志 |
 | priorityRule | 否 | string | 'include' | 模式规则，可选include/exclude/both |
 | includeTags | 否 | (string\|RegExp)[] | - | 根据指定的 tags 生成代码, priorityRule=include则必填 |
@@ -244,14 +246,13 @@ openapi --i ./spec.json --o ./apis
 | isGenJsonSchemas | 否 | boolean | false | 是否生成 JSON Schemas |
 | mockFolder | 否 | string | - | mock文件路径，例如：'./mocks' |
 | authorization | 否 | string | - | 文档权限凭证 |
+| apifoxConfig | 否 | [Apifox Config](#Apifox-Config) | - | apifox 配置 |
 | nullable | 否 | boolean | false | 使用 null 代替可选 |
 | isTranslateToEnglishTag | 否 | boolean | false | 将中文 tag 名称翻译成英文 tag 名称 |
 | isOnlyGenTypeScriptType | 否 | boolean | false | 仅生成 typescript 类型 |
 | isCamelCase | 否 | boolean | true | 小驼峰命名文件和请求函数 |
 | isSupportParseEnumDesc | 否 | boolean | false | 解析枚举描述生成枚举标签，格式参考：`系统用户角色:User(普通用户)=0,Agent(经纪人)=1,Admin(管理员)=2` |
 | hook | 否 | [Custom Hook](#Custom-Hook) | - | 自定义 hook |
-| apifoxConfig | 否 | [Apifox Config](#Apifox-Config) | - | apifox 配置 |
-| full | 否 | boolean | false | 是否全量替换 |
 
 ## 自定义 Hook
 

src/bin/cli.ts

@@ -6,9 +6,9 @@ import { GenerateServiceProps, generateService } from '../index';
 import { readConfig } from '../readConfig';
 
 program
-  .option('-u, --unique-key <uniqueKey>', '唯一标识 uniqueKey')
-  .option('-fn, --fileName <fileName>', '文件名 fileName')
-  .option('-fp, --filePath <filePath>', '文件路径 filePath');
+  .option('-cfn, --configFileName <string>', 'config file name')
+  .option('-cfp, --configFilePath <string>', 'config file path')
+  .option('-u, --uniqueKey <string>', 'unique key');
 
 program.parse();
 const options = program.opts();
@@ -28,24 +28,29 @@ async function run() {
       let configs: GenerateServiceProps[] = Array.isArray(config)
         ? config
         : [config];
+
       if (options.uniqueKey) {
         configs = configs.filter(
           (config) => config.uniqueKey === options.uniqueKey
         );
       }
+
       for (const config of configs) {
         tasks.push(generateService(config));
       }
+
       const results = await Promise.allSettled(tasks);
       const errors: PromiseRejectedResult[] = results.filter(
         (result) => result.status === 'rejected'
       );
       let errorMsg = '';
+
       for (let i = 0; i < errors.length; i++) {
         const error = errors[i];
         const cnf = configs[i];
         errorMsg += `${cnf.uniqueKey}${cnf.uniqueKey && ':'}${error.reason}\n`;
       }
+
       if (errorMsg) {
         throw new Error(errorMsg);
       }

src/bin/openapi.ts

@@ -13,19 +13,16 @@ const params = program
   .name('openapi')
   .usage('[options]')
   .version(pkg.version)
-  // .requiredOption(
-  //   '-i, --input <string>',
-  //   'OpenAPI specification, can be a path, url (required)'
-  // )
-  // .requiredOption('-o, --output <string>', 'output directory (required)')
   .option('-i, --input <string>', 'OpenAPI specification, can be a path, url')
   .option('-o, --output <string>', 'output directory')
-  .option('-cfn, --configFileName <configFileName>', 'config file name')
-  .option('-cfp, --configFilePath <configFilePath>', 'config file path')
+  .option('-cfn, --configFileName <string>', 'config file name')
+  .option('-cfp, --configFilePath <string>', 'config file path')
+  .option('-u, --uniqueKey <string>', 'unique key')
   .option(
     '--requestLibPath <string>',
     'custom request lib path, for example: "@/request", "node-fetch" (default: "axios")'
   )
+  .option('-f, --full <boolean>', 'full replacement', true)
   .option('--enableLogging <boolean>', 'open the log', false)
   .option(
     '--priorityRule <string>',
@@ -94,8 +91,6 @@ const params = program
     'parse enum description to generate enum label',
     false
   )
-  .option('-u, --unique-key <uniqueKey>', 'unique key')
-  .option('-f, --full <boolean>', 'full replacement', false)
   .parse(process.argv)
   .opts();
 
@@ -116,6 +111,7 @@ const baseGenerate = (_params_: OptionValues): GenerateServiceProps => {
     schemaPath: input,
     serversPath: output,
     requestLibPath: _params_.requestLibPath as string,
+    full: JSON.parse(_params_.full as string) === true,
     enableLogging: JSON.parse(_params_.enableLogging as string) === true,
     priorityRule: _params_.priorityRule as IPriorityRule,
     includeTags: _params_.includeTags as string[],
@@ -141,6 +137,7 @@ const baseGenerate = (_params_: OptionValues): GenerateServiceProps => {
     isSupportParseEnumDesc:
       JSON.parse(_params_.isSupportParseEnumDesc as string) === true,
   };
+
   return options;
 };
 
@@ -155,33 +152,40 @@ async function run() {
     );
     process.exit(0);
   }
+
   const cnf = await readConfig<GenerateServiceProps | GenerateServiceProps[]>({
     fallbackName: 'openapi-ts-request',
     filePath: params.configFilePath as string,
     fileName: params.configFileName as undefined,
   });
+
   try {
     if (cnf) {
       const tasks = [];
       let configs: GenerateServiceProps[] = Array.isArray(cnf) ? cnf : [cnf];
+
       if (params.uniqueKey) {
         configs = configs.filter(
           (config) => config.uniqueKey === params.uniqueKey
         );
       }
+
       for (const config of configs) {
         tasks.push(generateService(config));
       }
+
       const results = await Promise.allSettled(tasks);
       const errors: PromiseRejectedResult[] = results.filter(
         (result) => result.status === 'rejected'
       );
       let errorMsg = '';
+
       for (let i = 0; i < errors.length; i++) {
         const error = errors[i];
         const cnf = configs[i];
         errorMsg += `${cnf.uniqueKey}${cnf.uniqueKey && ':'}${error.reason}\n`;
       }
+
       if (errorMsg) {
         logError(errorMsg);
         process.exit(1);
@@ -193,6 +197,7 @@ async function run() {
         );
         process.exit(1);
       }
+
       const options = baseGenerate(params);
       await generateService(
         pickBy(

src/generator/serviceGenarator.ts

@@ -781,6 +781,7 @@ export default class ServiceGenerator {
         ...params,
       });
       let mergerProps: MergeOption = {} as MergeOption;
+
       if (existsSync(destPath)) {
         mergerProps = {
           srcPath: destPath,
@@ -790,10 +791,13 @@ export default class ServiceGenerator {
           source: '',
         };
       }
+
       if (this.config.full) {
         return writeFile(this.config.serversPath, fileName, destCode);
       }
+
       const merger = new Merger(mergerProps);
+
       return writeFile(
         this.config.serversPath,
         fileName,

src/index.ts

@@ -39,6 +39,10 @@ export type GenerateServiceProps = {
    * 方式二: import request from '@/request';
    */
   requestLibPath?: string;
+  /**
+   * 是否全量替换, 默认: true, 如果为false, 则进行增量替换
+   */
+  full?: boolean;
   /**
    * 开启日志
    */
@@ -117,6 +121,10 @@ export type GenerateServiceProps = {
    * 文档权限凭证
    */
   authorization?: string;
+  /**
+   * apifox 配置
+   */
+  apifoxConfig?: GetSchemaByApifoxProps;
   /**
    * 默认为false，true时使用null代替可选值
    */
@@ -146,9 +154,13 @@ export type GenerateServiceProps = {
    */
   templatesFolder?: string;
   /**
-   * apifox 配置
+   * 请求超时时间
    */
-  apifoxConfig?: GetSchemaByApifoxProps;
+  timeout?: number;
+  /**
+   * 多网关唯一标识
+   */
+  uniqueKey?: string;
   /**
    * 自定义 hook
    */
@@ -222,18 +234,6 @@ export type GenerateServiceProps = {
       apiMethod: string
     ) => string[] | null;
   };
-  /**
-   * 请求超时时间
-   */
-  timeout?: number;
-  /**
-   * 唯一标识
-   */
-  uniqueKey?: string;
-  /**
-   * 是否全量替换
-   */
-  full?: boolean;
 };
 
 export async function generateService({
@@ -248,16 +248,17 @@ export async function generateService({
   timeout = 60_000,
   reactQueryMode = ReactQueryMode.react,
   apifoxConfig,
-  full,
   ...rest
 }: GenerateServiceProps) {
   if (!schemaPath && !apifoxConfig) {
     return;
   }
+
   let openAPI: OpenAPIObject | null = null;
   if (apifoxConfig) {
     openAPI = (await getOpenAPIConfigByApifox(apifoxConfig)) as OpenAPIObject;
   }
+
   if (schemaPath) {
     openAPI = (await getOpenAPIConfig(
       schemaPath,
@@ -275,7 +276,6 @@ export async function generateService({
   }
 
   const requestImportStatement = getImportStatement(requestLibPath);
-
   const serviceGenerator = new ServiceGenerator(
     {
       schemaPath,
@@ -306,7 +306,7 @@ export async function generateService({
       isOnlyGenTypeScriptType: false,
       isCamelCase: true,
       isSupportParseEnumDesc: false,
-      full,
+      full: true,
       ...rest,
     },
     openAPI

src/readConfig.ts

@@ -10,9 +10,11 @@ export const readConfig = async <T = unknown>({
 }: ReadConfigOptions): Promise<T | undefined> => {
   try {
     let _fileName_: string | undefined = fileName;
+
     if (!_fileName_ && !filePath) {
       _fileName_ = fallbackName;
     }
+
     const explorerSync = cosmiconfigSync(_fileName_ || fallbackName, {
       loaders: {
         '.ts': TypeScriptLoader(),