feat: 完善枚举类型注释

Author: vsqq0

.changeset/odd-webs-cover.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+增加枚举注释

templates/enum.njk

@@ -4,6 +4,9 @@
 {%- if list.length > 0 %}
   {% for type in list -%}
     {%- if type.isEnum  %}
+      {%- if type.description%} 
+      /** {{ type.description }} */
+      {%- endif %}
       export enum {{ type.typeName | safe }} {{ type.type }};
 
       export type I{{ type.typeName | safe }} = keyof typeof {{ type.typeName }}

templates/interface.njk

@@ -43,7 +43,9 @@
       {%- endfor %}
     {%- else %}
       {%- if type.isEnum  %}
+        {%- if type.description%} 
         /** {{ type.description }} */
+        {%- endif %}
         export enum {{ type.typeName | safe }} {{ type.type }};
 
         export type I{{ type.typeName | safe }} = keyof typeof {{ type.typeName }}

test/__snapshots__/common/小驼峰命名文件和请求函数.snap

@@ -411,6 +411,7 @@ export type PetUsingPutResponses = {
   405: unknown;
 };
 
+/** Order Status */
 export enum StatusEnum {
   'placed' = 'placed',
   'approved' = 'approved',
@@ -419,6 +420,7 @@ export enum StatusEnum {
 
 export type IStatusEnum = keyof typeof StatusEnum;
 
+/** pet status in the store */
 export enum StatusEnum2 {
   'available' = 'available',
   'pending' = 'pending',

test/__snapshots__/common/支持 null 类型作为默认值.snap

@@ -411,6 +411,7 @@ export type PetUsingPutResponses = {
   405: unknown;
 };
 
+/** Order Status */
 export enum StatusEnum {
   'placed' = 'placed',
   'approved' = 'approved',
@@ -419,6 +420,7 @@ export enum StatusEnum {
 
 export type IStatusEnum = keyof typeof StatusEnum;
 
+/** pet status in the store */
 export enum StatusEnum2 {
   'available' = 'available',
   'pending' = 'pending',

test/__snapshots__/common/正常命名文件和请求函数.snap

@@ -411,6 +411,7 @@ export type PetUsingPutResponses = {
   405: unknown;
 };
 
+/** Order Status */
 export enum StatusEnum {
   'placed' = 'placed',
   'approved' = 'approved',
@@ -419,6 +420,7 @@ export enum StatusEnum {
 
 export type IStatusEnum = keyof typeof StatusEnum;
 
+/** pet status in the store */
 export enum StatusEnum2 {
   'available' = 'available',
   'pending' = 'pending',

test/__snapshots__/common/测试 number类型 枚举.snap

@@ -154,6 +154,7 @@ export type CityGetRes = {
 };
 
 export type CityPutRes = {
+  /** Poi2CategoryEnum poi2分类 */
   city: Poi2CategoryEnum;
 };
 
@@ -162,6 +163,7 @@ export type HTTPValidationError = {
   detail?: ValidationError[];
 };
 
+/** poi2分类 */
 export enum Poi2CategoryEnum {
   'STRING_NUMBER_-1' = '-1',
   'STRING_NUMBER_-1000' = '-1000',

test/__snapshots__/common/测试 number类型 枚举，使用 desc 解析枚举.snap

@@ -35,6 +35,7 @@ export type ResultOutputUserInfoOutput = {
   data?: UserInfoOutput;
 };
 
+/** 系统用户角色:User(普通用户)=0,Agent(经纪人)=1,Admin(管理员)=2 */
 export enum SysUserRole {
   User = 0,
   Agent = 1,
@@ -50,6 +51,7 @@ export type UserInfoOutput = {
   avatar?: string;
   /** 手机号 */
   phone?: string;
+  /** 系统用户角色:User(普通用户)=0,Agent(经纪人)=1,Admin(管理员)=2 */
   role?: SysUserRole;
 };
 /* eslint-disable */

test/__snapshots__/common/测试 tags 为 undefined.snap

@@ -70,6 +70,7 @@ export type PetFindByStatusUsingGetResponses = {
   400: unknown;
 };
 
+/** pet status in the store */
 export enum StatusEnum {
   'available' = 'available',
   'pending' = 'pending',

test/__snapshots__/common/测试 tags 为[].snap

@@ -70,6 +70,7 @@ export type PetFindByStatusUsingGetResponses = {
   400: unknown;
 };
 
+/** pet status in the store */
 export enum StatusEnum {
   'available' = 'available',
   'pending' = 'pending',