feat: 支持通过hooks处理enum types (#381)

* feat: 支持通过hooks处理enum types

* chore: add changelog

---------

Co-authored-by: 故城 <[email protected]>

Author: asins

.changeset/real-suns-move.md

@@ -0,0 +1,5 @@
+---
+"openapi-ts-request": minor
+---
+
+feat: 支持通过hooks处理enum types

src/generator/serviceGenarator.ts

@@ -359,11 +359,19 @@ export default class ServiceGenerator {
     // 生成枚举翻译
     const enums = filter(this.interfaceTPConfigs, (item) => item.isEnum);
     if (!isGenJavaScript && !isOnlyGenTypeScriptType && !isEmpty(enums)) {
+      const hookCustomTemplateService =
+        this.config.hook?.customTemplates?.[
+          TypescriptFileType.displayEnumLabel
+        ];
+
       this.genFileFromTemplate(
         `${displayEnumLabelFileName}.ts`,
         TypescriptFileType.displayEnumLabel,
         {
-          list: enums,
+          customTemplate: !!hookCustomTemplateService,
+          list: hookCustomTemplateService
+            ? hookCustomTemplateService(enums, this.config)
+            : enums,
           namespace: this.config.namespace,
           interfaceFileName: interfaceFileName,
         }
@@ -381,11 +389,19 @@ export default class ServiceGenerator {
       this.config.isDisplayTypeLabel &&
       !isEmpty(displayTypeLabels)
     ) {
+      const hookCustomTemplateService =
+        this.config.hook?.customTemplates?.[
+          TypescriptFileType.displayTypeLabel
+        ];
+
       this.genFileFromTemplate(
         `${displayTypeLabelFileName}.ts`,
         TypescriptFileType.displayTypeLabel,
         {
-          list: displayTypeLabels,
+          customTemplate: !!hookCustomTemplateService,
+          list: hookCustomTemplateService
+            ? hookCustomTemplateService(enums, this.config)
+            : enums,
           namespace: this.config.namespace,
           interfaceFileName: interfaceFileName,
         }
@@ -569,6 +585,7 @@ export default class ServiceGenerator {
               isEnum: enumObj.isEnum,
               displayLabelFuncName: camelCase(`display-${item.name}-Enum`),
               enumLabelType: enumObj.enumLabelType,
+              description: enumObj.description,
             });
           }
         });
@@ -1251,6 +1268,7 @@ export default class ServiceGenerator {
       isEnum: true,
       type: Array.isArray(enumArray) ? enumStr : 'string',
       enumLabelType: enumLabelTypeStr,
+      description: schemaObject.description,
     };
   }
 

src/generator/type.ts

@@ -39,6 +39,7 @@ export interface ITypeItem {
   isEnum: boolean;
   displayLabelFuncName?: string;
   enumLabelType?: string;
+  description?: string;
 }
 
 export type ICustomSchemaObject = SchemaObject & { isAllowed?: boolean };

src/index.ts

@@ -238,6 +238,21 @@ export type GenerateServiceProps = {
      * 自定义模板
      */
     customTemplates?: {
+      /**
+       * 自定义 displayTypeLabel 模板
+       */
+      [TypescriptFileType.displayTypeLabel]?: <T, U>(
+        types: T[],
+        config: U
+      ) => string;
+      /**
+       * 自定义 displayEnumLabel 模板
+       */
+      [TypescriptFileType.displayEnumLabel]?: <T, U>(
+        enums: T[],
+        config: U
+      ) => string;
+
       /**
        * 自定义 serviceController 模板
        */

templates/displayEnumLabel.njk

@@ -2,9 +2,14 @@
 // @ts-ignore
 import * as {{ namespace }} from './{{ interfaceFileName }}';
 
+{% if customTemplate %}
+  {{ list }}
+{% else %}
+
 {% for type in list -%}
 export function {{ type.displayLabelFuncName }}(field: {{ namespace }}.{{ type.typeName }}) {
   return ({{ type.enumLabelType }})[field]
 }
 
-{% endfor -%}
+{% endfor -%}
+{%- endif %}

templates/displayTypeLabel.njk

@@ -2,6 +2,10 @@
 // @ts-ignore
 import * as {{ namespace }} from './{{ interfaceFileName }}';
 
+{% if customTemplate %}
+  {{ list }}
+{% else %}
+
 {% for type in list -%}
   {%- if type.props.length %}
     export function display{{ type.typeName }}(field: keyof {{ namespace }}.{{ type.typeName }}) {
@@ -20,7 +24,7 @@ import * as {{ namespace }} from './{{ interfaceFileName }}';
               display{{ p.type | safe }}(field as keyof {{ namespace }}.{{ p.type }})
             {%- else %}
               {{ p.name }}: '{{ p.desc if p.desc else p.name }}',
-            {%- endif %}   
+            {%- endif %}
           {%- endfor %}
         {%- if prop.length > 1 %}
           }[field]
@@ -39,4 +43,5 @@ import * as {{ namespace }} from './{{ interfaceFileName }}';
   }
   {%- endif %}
 
-{% endfor -%}
+{% endfor -%}
+{%- endif %}