feat: apifox support, incremental change support, cli concurrency and timeout support, uniquekey filpath support, openapi-ts merge to openapi (#153)

* feat: cli concurrency and timeout support and uniquekey filpath support

* feat: add merge rebase openapi-ts and openapi modify function name

* fix: merge sort

* feat: option full replacement

* docs: docs modify

---------

Co-authored-by: Json_Lee <[email protected]>

Author: JsonLee12138

.changeset/happy-foxes-sip.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+feat: cli concurrency and timeout support and uniquekey filpath support

.changeset/smooth-lights-greet.md

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

README-en_US.md

@@ -13,6 +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
 
 docs：[use docs](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
@@ -25,6 +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
 
 ## Usage
 
@@ -181,8 +183,10 @@ $ openapi --help
 
   Options:
     -V, --version                       output the version number
-    -i, --input <string>                OpenAPI specification, can be a path, url (required)
-    -o, --output <string>               output directory (required)
+    -i, --input <string>                OpenAPI specification, can be a path, url
+    -o, --output <string>               output directory
+    -cfn, --configFileName <string>     config file name
+    -cfp, --configFilePath <string>     config file path
     --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
@@ -205,6 +209,7 @@ $ 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
 ```
 
@@ -243,6 +248,8 @@ openapi -i ./spec.json -o ./apis
 | 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
 
@@ -255,6 +262,17 @@ openapi -i ./spec.json -o ./apis
 | customType | ({<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string, schemas?: ComponentsObject['schemas']) => string,<br>schemas?: ComponentsObject['schemas'],<br>}) => string | custom type <br> _returning a non-string will use the default method to get the type_ |
 | customFileNames | (<br>operationObject: OperationObject,<br>apiPath: string,<br>apiMethod: string,<br>) => string[] | custom generate request client controller file name, can return multiple: generate multiple files. <br> _if the return value is empty, the default getFileNames is used_ |
 
+## Apifox-Config
+
+| attribute | type | description | required |
+| --- | --- | --- | --- |
+| projectId | string | project id | true |
+| local | string | language(default:zh-CN) | false |
+| apifoxVersion | string | default: 2024-03-28, [current apifox version](https://api.apifox.com/v1/versions) | false |
+| includeTags | \* or string[] | default: \* | false |
+| excludeTags | string[] | default: [] | false |
+| apifoxToken | string | [get](https://docs.apifox.com/doc-5723694) | true |
+
 ## JSON Schemas
 
 - default generate JSON Schemas based on [components.schemas](https://spec.openapis.org/oas/latest.html#components-object), JSON Schemas corresponding to [paths](https://spec.openapis.org/oas/latest.html#paths-object) currently need to be parsed by yourself
@@ -275,6 +293,33 @@ currently using [mockjs](http://mockjs.com) to generate mock data, the mocks fil
 
 it is recommended to use a custom request function to adapt to uniapp. you can also use the `@uni-helper/axios-adapter` adapter. for details, see [【use docs 2.2】](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
+## Notes on Upgrading Older Versions
+
+- Current naming convention changes
+- Incremental changes have been made to the current version and will not affect previous versions.
+- The `openapi-ts` command can be deprecated to use `openapi`
+
+### The configuration follows the naming convention of the old version as follows
+
+```typescript
+import type { APIDataType } from 'openapi-ts-request/dist/generator/type';
+import {
+  genDefaultFunctionName,
+  resolveFunctionName,
+  stripDot,
+} from 'openapi-ts-request/dist/generator/util';
+
+export default {
+  hook: {
+    customFunctionName(data: APIDataType, prefix: string) {
+      if (data.operationId)
+        return resolveFunctionName(stripDot(data.operationId), data.method);
+      return data.method + genDefaultFunctionName(data.path, prefix);
+    },
+  },
+};
+```
+
 ## Contribute
 
 ### Development Environment

README.md

@@ -1,3 +1,5 @@
+<!-- TODO:需要修改文档, 添加参数, 添加apifox的配置支持 -->
+
 ## 介绍
 
 [![GitHub Repo stars](https://img.shields.io/github/stars/openapi-ui/openapi-ts-request?style=social)](https://github.com/openapi-ui/openapi-ts-request) [![npm (scoped)](https://img.shields.io/npm/v/openapi-ts-request)](https://www.npmjs.com/package/openapi-ts-request) ![GitHub tag](https://img.shields.io/github/v/tag/openapi-ui/openapi-ts-request?include_prereleases)
@@ -13,6 +15,7 @@
 - react-query/vue-query
 - 类型字段翻译
 - JSON Schemas
+- Apifox
 
 文档：[使用手册](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
@@ -25,6 +28,7 @@
 - 支持通过 tags 过滤生成结果
 - 支持 JSON/YAML 定义文件
 - 支持将中文 tag 名称翻译为英文 tag 名称
+- 支持直接配置`apifox`的`token`和`projectId`直接生成
 
 ## 使用
 
@@ -181,8 +185,10 @@ $ openapi --help
 
   Options:
     -V, --version                       output the version number
-    -i, --input <string>                OpenAPI specification, can be a path, url (required)
-    -o, --output <string>               output directory (required)
+    -i, --input <string>                OpenAPI specification, can be a path, url
+    -o, --output <string>               output directory
+    -cfn, --configFileName <string>     config file name
+    -cfp, --configFilePath <string>     config file path
     --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
@@ -205,6 +211,7 @@ $ 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
 ```
 
@@ -243,6 +250,8 @@ openapi --i ./spec.json --o ./apis
 | 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
 
@@ -255,6 +264,17 @@ openapi --i ./spec.json --o ./apis
 | customType | ({<br>schemaObject: SchemaObject \| ReferenceObject,<br>namespace: string,<br>originGetType:(schemaObject: SchemaObject \| ReferenceObject, namespace: string, schemas?: ComponentsObject['schemas']) => string,<br>schemas?: ComponentsObject['schemas'],<br>}) => string | 自定义类型 <br> _返回非字符串将使用默认方法获取type_ |
 | customFileNames | (<br>operationObject: OperationObject,<br>apiPath: string,<br>apiMethod: string,<br>) => string[] | 自定义生成的请求客户端文件名称，可以返回多个文件名称的数组(表示生成多个文件). <br> _返回为空，则使用默认的方法获取_ |
 
+## Apifox-Config
+
+| 属性 | 类型 | 说明 | 必填 |
+| --- | --- | --- | --- |
+| projectId | string | 项目id | true |
+| local | string | 语言(默认:zh-CN) | false |
+| apifoxVersion | string | 默认: 2024-03-28, [获取当前版本](https://api.apifox.com/v1/versions) | false |
+| includeTags | \* 或 string[] | 默认: \* | false |
+| excludeTags | string[] | 默认: [] | false |
+| apifoxToken | string | [获取](https://docs.apifox.com/doc-5723694) | true |
+
 ## JSON Schemas
 
 - 默认生成 [components.schemas](https://spec.openapis.org/oas/latest.html#components-object) 下面的 JSON Schemas，[paths](https://spec.openapis.org/oas/latest.html#paths-object) 对应的 JSON Schemas 目前需自行解析
@@ -275,6 +295,33 @@ export declare function patchSchema<T extends object>(
 
 适配 uniapp 推荐采用自定义 request 函数的方式，你也可以使用 `@uni-helper/axios-adapter` 适配器，详情见 [【使用手册 2.2】](https://github.com/openapi-ui/openapi-ts-request/issues/100)
 
+## 旧版本升级注意事项
+
+- 当前命名规范修改
+- 当前版本已完成增量修改, 不会影响以前
+- 可以弃用`openapi-ts`命令, 直接使用`openapi`
+
+### 沿用旧版本命名规范配置如下
+
+```typescript
+import type { APIDataType } from 'openapi-ts-request/dist/generator/type';
+import {
+  genDefaultFunctionName,
+  resolveFunctionName,
+  stripDot,
+} from 'openapi-ts-request/dist/generator/util';
+
+export default {
+  hook: {
+    customFunctionName(data: APIDataType, prefix: string) {
+      if (data.operationId)
+        return resolveFunctionName(stripDot(data.operationId), data.method);
+      return data.method + genDefaultFunctionName(data.path, prefix);
+    },
+  },
+};
+```
+
 ## 贡献
 
 ### 环境要求

package.json

@@ -31,6 +31,7 @@
     "lint": "eslint ./src --report-unused-disable-directives --max-warnings=0",
     "lint:fix": "eslint ./src --report-unused-disable-directives --max-warnings=0 --fix",
     "test": "rm -rf ./test/apis/ ./test/mocks && npm run build && cd ./test && node ./test.js && cd ..",
+    "test:new": "npm run build && cd ./test && node ./test.js && cd ..",
     "test:windows": "rimraf ./test/apis/ ./test/mocks && npm run build && cd ./test && node ./test.js && cd ..",
     "prepare": "husky",
     "openapi-ts-request": "openapi-ts"
@@ -56,6 +57,7 @@
     "rimraf": "^6.0.1",
     "swagger2openapi": "^7.0.8",
     "tiny-pinyin": "^1.3.2",
+    "ts-morph": "^25.0.1",
     "tslib": "^2.6.3"
   },
   "devDependencies": {

pnpm-lock.yaml

@@ -1,29 +1,53 @@
 #!/usr/bin/env node
 import chalk from 'chalk';
-import { cosmiconfigSync } from 'cosmiconfig';
-import { TypeScriptLoaderSync } from 'cosmiconfig-typescript-loader';
+import { program } from 'commander';
 
 import { GenerateServiceProps, generateService } from '../index';
+import { readConfig } from '../readConfig';
 
-const explorerSync = cosmiconfigSync('openapi-ts-request', {
-  loaders: {
-    '.ts': TypeScriptLoaderSync(),
-  },
-});
+program
+  .option('-u, --unique-key <uniqueKey>', '唯一标识 uniqueKey')
+  .option('-fn, --fileName <fileName>', '文件名 fileName')
+  .option('-fp, --filePath <filePath>', '文件路径 filePath');
 
-const config = explorerSync.search()?.config as
-  | GenerateServiceProps
-  | GenerateServiceProps[];
+program.parse();
+const options = program.opts();
 
 async function run() {
+  const config = await readConfig<
+    GenerateServiceProps | GenerateServiceProps[]
+  >({
+    fallbackName: 'openapi-ts-request',
+    filePath: options.filePath as string,
+    fileName: options.fileName as undefined,
+  });
+
   try {
+    const tasks = [];
     if (config) {
-      const configs: GenerateServiceProps[] = Array.isArray(config)
+      let configs: GenerateServiceProps[] = Array.isArray(config)
         ? config
         : [config];
-
+      if (options.uniqueKey) {
+        configs = configs.filter(
+          (config) => config.uniqueKey === options.uniqueKey
+        );
+      }
       for (const config of configs) {
-        await generateService(config);
+        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);
       }
     } else {
       throw new Error('config is not found');