openapi-ts-request 0.11.1 → 0.12.0

package/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 |
 

package/dist/bin/openapi.js

@@ -23,6 +23,7 @@ const params = commander_1.program
     .option('--authorization <string>', 'docs authorization')
     .option('--nullable <boolean>', 'null instead of optional', false)
     .option('--isTranslateToEnglishTag <boolean>', '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', true)
     .parse(process.argv)
     .opts();
@@ -51,6 +52,7 @@ function run() {
                 authorization: params.authorization,
                 nullable: JSON.parse(params.nullable) === true,
                 isTranslateToEnglishTag: JSON.parse(params.isTranslateToEnglishTag) === true,
+                isOnlyGenTypeScriptType: JSON.parse(params.isOnlyGenTypeScriptType) === true,
                 isCamelCase: JSON.parse(params.isCamelCase) === true,
             });
             process.exit(0);

package/dist/generator/serviceGenarator.js

@@ -80,7 +80,7 @@ class ServiceGenerator {
         });
         // 生成枚举翻译
         const enums = (0, lodash_1.filter)(interfaceTPConfigs, (item) => item.isEnum);
-        if (!(0, lodash_1.isEmpty)(enums)) {
+        if (!this.config.isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums)) {
             this.genFileFromTemplate(`${config_1.displayEnumLabelFileName}.ts`, config_1.TypescriptFileType.displayEnumLabel, {
                 list: enums,
                 namespace: this.config.namespace,
@@ -89,23 +89,29 @@ class ServiceGenerator {
         }
         const displayTypeLabels = (0, lodash_1.filter)(interfaceTPConfigs, (item) => !item.isEnum);
         // 生成 type 翻译
-        if (this.config.isDisplayTypeLabel && !(0, lodash_1.isEmpty)(displayTypeLabels)) {
+        if (!this.config.isOnlyGenTypeScriptType &&
+            this.config.isDisplayTypeLabel &&
+            !(0, lodash_1.isEmpty)(displayTypeLabels)) {
             this.genFileFromTemplate(`${config_1.displayTypeLabelFileName}.ts`, config_1.TypescriptFileType.displayTypeLabel, {
                 list: displayTypeLabels,
                 namespace: this.config.namespace,
                 interfaceFileName: config_1.interfaceFileName,
             });
         }
-        const prettierError = [];
-        // 生成 service controller 文件
-        this.getServiceTPConfigs().forEach((tp) => {
-            const hasError = this.genFileFromTemplate((0, util_1.getFinalFileName)(`${tp.className}.ts`), config_1.TypescriptFileType.serviceController, Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_1.interfaceFileName }, tp));
-            prettierError.push(hasError);
-        });
-        if (prettierError.includes(true)) {
-            (0, log_1.default)('🚥 格式化失败，请检查 service controller 文件内可能存在的语法错误');
+        if (!this.config.isOnlyGenTypeScriptType) {
+            const prettierError = [];
+            // 生成 service controller 文件
+            this.getServiceTPConfigs().forEach((tp) => {
+                const hasError = this.genFileFromTemplate((0, util_1.getFinalFileName)(`${tp.className}.ts`), config_1.TypescriptFileType.serviceController, Object.assign({ namespace: this.config.namespace, requestOptionsType: this.config.requestOptionsType, requestImportStatement: this.config.requestImportStatement, interfaceFileName: config_1.interfaceFileName }, tp));
+                prettierError.push(hasError);
+            });
+            if (prettierError.includes(true)) {
+                (0, log_1.default)('🚥 格式化失败，请检查 service controller 文件内可能存在的语法错误');
+            }
         }
-        if (this.config.isGenJsonSchemas && !(0, lodash_1.isEmpty)(this.schemaList)) {
+        if (!this.config.isOnlyGenTypeScriptType &&
+            this.config.isGenJsonSchemas &&
+            !(0, lodash_1.isEmpty)(this.schemaList)) {
             // 处理重复的 schemaName
             (0, util_1.handleDuplicateTypeNames)(this.schemaList);
             // 生成 schema 文件
@@ -118,11 +124,15 @@ class ServiceGenerator {
             list: this.classNameList,
             namespace: this.config.namespace,
             interfaceFileName: config_1.interfaceFileName,
-            isGenJsonSchemas: this.config.isGenJsonSchemas && !(0, lodash_1.isEmpty)(this.schemaList),
+            isGenJsonSchemas: !this.config.isOnlyGenTypeScriptType &&
+                this.config.isGenJsonSchemas &&
+                !(0, lodash_1.isEmpty)(this.schemaList),
             schemaFileName: config_1.schemaFileName,
-            isDisplayEnumLabel: !(0, lodash_1.isEmpty)(enums),
+            isDisplayEnumLabel: !this.config.isOnlyGenTypeScriptType && !(0, lodash_1.isEmpty)(enums),
             displayEnumLabelFileName: config_1.displayEnumLabelFileName,
-            isDisplayTypeLabel: this.config.isDisplayTypeLabel && !(0, lodash_1.isEmpty)(displayTypeLabels),
+            isDisplayTypeLabel: !this.config.isOnlyGenTypeScriptType &&
+                this.config.isDisplayTypeLabel &&
+                !(0, lodash_1.isEmpty)(displayTypeLabels),
             displayTypeLabelFileName: config_1.displayTypeLabelFileName,
         });
         // 打印日志

package/dist/index.d.ts

@@ -68,6 +68,10 @@ export type GenerateServiceProps = {
      * 是否将中文 tag 名称翻译成英文 tag 名称
      */
     isTranslateToEnglishTag?: boolean;
+    /**
+     * 仅仅生成类型，不生成请求函数
+     */
+    isOnlyGenTypeScriptType?: boolean;
     /**
      * 模板文件、请求函数采用小驼峰命名
      */

package/dist/index.js

@@ -21,7 +21,7 @@ function generateService(_a) {
             yield (0, util_1.translateChineseModuleNodeToEnglish)(openAPI);
         }
         const requestImportStatement = (0, util_1.getImportStatement)(requestLibPath);
-        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', nullable: false, isCamelCase: true, isDisplayTypeLabel: false, isGenJsonSchemas: false, allowedTags: allowedTags
+        const serviceGenerator = new serviceGenarator_1.default(Object.assign({ schemaPath, serversPath: './src/apis', requestImportStatement, requestOptionsType: '{[key: string]: unknown}', namespace: 'API', nullable: false, isCamelCase: true, isDisplayTypeLabel: false, isGenJsonSchemas: false, isOnlyGenTypeScriptType: false, allowedTags: allowedTags
                 ? (0, lodash_1.map)(allowedTags, (item) => item.toLowerCase())
                 : null }, rest), openAPI);
         serviceGenerator.genFile();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-ts-request",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "description": "Swagger2/OpenAPI3 to TypeScript, request client, request mock service, enum, type field label, JSON Schemas",
   "engines": {
     "node": ">=18.0.0",