feat: support only generate typescript type

rookie-luochao · rookie-luochao · commit cb2dd366db46 · 2024-11-19T00:38:54.000+08:00
diff --git a/.changeset/pink-bikes-agree.md b/.changeset/pink-bikes-agree.md
@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': minor
+---
+
+feat: support only generate typescript type
diff --git a/README-en_US.md b/README-en_US.md
@@ -150,6 +150,7 @@ $ openapi --help
     --authorization <string>           docs authorization
     --nullable <boolean>               null instead of optional (default: false)
     --isTranslateToEnglishTag <boolean>translate chinese tag name to english tag name (default: false)
+    --isOnlyGenTypeScriptType <boolean>only generate typescript type (default: false)
     --isCamelCase <boolean>            camelCase naming of controller files and request client (default: true)
     -h, --help                         display help for command
 ```
@@ -177,6 +178,7 @@ openapi -i ./spec.json -o ./apis
 | authorization | 否 | string | - | docs authorization |
 | 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 |
 | hook | no | [Custom Hook](#Custom-Hook) | - | custom hook |
 
diff --git a/README.md b/README.md
@@ -150,6 +150,7 @@ $ openapi --help
     --authorization <string>           docs authorization
     --nullable <boolean>               null instead of optional (default: false)
     --isTranslateToEnglishTag <boolean>translate chinese tag name to english tag name (default: false)
+    --isOnlyGenTypeScriptType <boolean>only generate typescript type (default: false)
     --isCamelCase <boolean>            camelCase naming of controller files and request client (default: true)
     -h, --help                         display help for command
 ```
@@ -177,6 +178,7 @@ openapi --i ./spec.json --o ./apis
 | authorization | 否 | string | - | 文档权限凭证 |
 | nullable | 否 | boolean | false | 使用 null 代替可选 |
 | isTranslateToEnglishTag | 否 | boolean | false | 将中文 tag 名称翻译成英文 tag 名称 |
+| isOnlyGenTypeScriptType | 否 | boolean | false | 仅生成 typescript 类型 |
 | isCamelCase | 否 | boolean | true | 小驼峰命名文件和请求函数 |
 | hook | 否 | [Custom Hook](#Custom-Hook) | - | 自定义 hook |
 
diff --git a/src/bin/openapi.ts b/src/bin/openapi.ts
@@ -45,6 +45,11 @@ const params = program
     'translate chinese tag name to english tag name',
     false
   )
+  .option(
+    '--isOnlyGenTypeScriptType <boolean>',
+    'only generate typescript type',
+    false
+  )
   .option(
     '--isCamelCase <boolean>',
     'camelCase naming of controller files and request client',
@@ -83,6 +88,8 @@ async function run() {
       nullable: JSON.parse(params.nullable as string) === true,
       isTranslateToEnglishTag:
         JSON.parse(params.isTranslateToEnglishTag as string) === true,
+      isOnlyGenTypeScriptType:
+        JSON.parse(params.isOnlyGenTypeScriptType as string) === true,
       isCamelCase: JSON.parse(params.isCamelCase as string) === true,
     });
     process.exit(0);
diff --git a/src/generator/serviceGenarator.ts b/src/generator/serviceGenarator.ts
@@ -183,7 +183,7 @@ export default class ServiceGenerator {
 
     // 生成枚举翻译
     const enums = filter(interfaceTPConfigs, (item) => item.isEnum);
-    if (!isEmpty(enums)) {
+    if (!this.config.isOnlyGenTypeScriptType && !isEmpty(enums)) {
       this.genFileFromTemplate(
         `${displayEnumLabelFileName}.ts`,
         TypescriptFileType.displayEnumLabel,
@@ -200,7 +200,11 @@ export default class ServiceGenerator {
       (item) => !item.isEnum
     );
     // 生成 type 翻译
-    if (this.config.isDisplayTypeLabel && !isEmpty(displayTypeLabels)) {
+    if (
+      !this.config.isOnlyGenTypeScriptType &&
+      this.config.isDisplayTypeLabel &&
+      !isEmpty(displayTypeLabels)
+    ) {
       this.genFileFromTemplate(
         `${displayTypeLabelFileName}.ts`,
         TypescriptFileType.displayTypeLabel,
@@ -212,30 +216,38 @@ export default class ServiceGenerator {
       );
     }
 
-    const prettierError = [];
-
-    // 生成 service controller 文件
-    this.getServiceTPConfigs().forEach((tp) => {
-      const hasError = this.genFileFromTemplate(
-        getFinalFileName(`${tp.className}.ts`),
-        TypescriptFileType.serviceController,
-        {
-          namespace: this.config.namespace,
-          requestOptionsType: this.config.requestOptionsType,
-          requestImportStatement: this.config.requestImportStatement,
-          interfaceFileName: interfaceFileName,
-          ...tp,
-        }
-      );
+    if (!this.config.isOnlyGenTypeScriptType) {
+      const prettierError = [];
+
+      // 生成 service controller 文件
+      this.getServiceTPConfigs().forEach((tp) => {
+        const hasError = this.genFileFromTemplate(
+          getFinalFileName(`${tp.className}.ts`),
+          TypescriptFileType.serviceController,
+          {
+            namespace: this.config.namespace,
+            requestOptionsType: this.config.requestOptionsType,
+            requestImportStatement: this.config.requestImportStatement,
+            interfaceFileName: interfaceFileName,
+            ...tp,
+          }
+        );
 
-      prettierError.push(hasError);
-    });
+        prettierError.push(hasError);
+      });
 
-    if (prettierError.includes(true)) {
-      log('🚥 格式化失败，请检查 service controller 文件内可能存在的语法错误');
+      if (prettierError.includes(true)) {
+        log(
+          '🚥 格式化失败，请检查 service controller 文件内可能存在的语法错误'
+        );
+      }
     }
 
-    if (this.config.isGenJsonSchemas && !isEmpty(this.schemaList)) {
+    if (
+      !this.config.isOnlyGenTypeScriptType &&
+      this.config.isGenJsonSchemas &&
+      !isEmpty(this.schemaList)
+    ) {
       // 处理重复的 schemaName
       handleDuplicateTypeNames(this.schemaList);
       // 生成 schema 文件
@@ -257,12 +269,17 @@ export default class ServiceGenerator {
         namespace: this.config.namespace,
         interfaceFileName: interfaceFileName,
         isGenJsonSchemas:
-          this.config.isGenJsonSchemas && !isEmpty(this.schemaList),
+          !this.config.isOnlyGenTypeScriptType &&
+          this.config.isGenJsonSchemas &&
+          !isEmpty(this.schemaList),
         schemaFileName: schemaFileName,
-        isDisplayEnumLabel: !isEmpty(enums),
+        isDisplayEnumLabel:
+          !this.config.isOnlyGenTypeScriptType && !isEmpty(enums),
         displayEnumLabelFileName: displayEnumLabelFileName,
         isDisplayTypeLabel:
-          this.config.isDisplayTypeLabel && !isEmpty(displayTypeLabels),
+          !this.config.isOnlyGenTypeScriptType &&
+          this.config.isDisplayTypeLabel &&
+          !isEmpty(displayTypeLabels),
         displayTypeLabelFileName: displayTypeLabelFileName,
       }
     );
diff --git a/src/index.ts b/src/index.ts
@@ -87,6 +87,10 @@ export type GenerateServiceProps = {
    * 是否将中文 tag 名称翻译成英文 tag 名称
    */
   isTranslateToEnglishTag?: boolean;
+  /**
+   * 仅仅生成类型，不生成请求函数
+   */
+  isOnlyGenTypeScriptType?: boolean;
   /**
    * 模板文件、请求函数采用小驼峰命名
    */
@@ -208,6 +212,7 @@ export async function generateService({
       isCamelCase: true,
       isDisplayTypeLabel: false,
       isGenJsonSchemas: false,
+      isOnlyGenTypeScriptType: false,
       allowedTags: allowedTags
         ? map(allowedTags, (item) => item.toLowerCase())
         : null,
diff --git a/test/genOpenapi.js b/test/genOpenapi.js
@@ -1,6 +1,7 @@
 const { generateService } = require('../dist/index');
 
 generateService({
-  schemaPath: `${__dirname}/example-files/openapi-schemas-enum-array.json`,
-  serversPath: './apis/schemas-enum-array',
+  schemaPath: `${__dirname}/example-files/openapi.json`,
+  serversPath: './apis/only-generate-typescript-type',
+  isOnlyGenTypeScriptType: true,
 });
diff --git a/test/test.js b/test/test.js
@@ -158,6 +158,15 @@ const gen = async () => {
     serversPath: './apis/schemas-enum-array'
   });
 
+  // 测试 只生成 typescript 类型，不生成请求函数
+  await openAPI.generateService({
+    schemaPath: `${__dirname}/example-files/openapi.json`,
+    serversPath: './apis/only-generate-typescript-type',
+    isOnlyGenTypeScriptType: true,
+    isDisplayTypeLabel: true,
+    isGenJsonSchemas: true,
+  });
+
   // check 文件生成
   const fileControllerStr = fs.readFileSync(
     path.join(__dirname, 'apis/file/fileController.ts'),

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'openapi-ts-request': minor
 +---
++
 +feat: support only generate typescript type