docs: add supportParseEnumDescByReg params

Author: rookie-luochao

.changeset/eight-donuts-rush.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': minor
+---
+
+feat: add supportParseEnumDescByReg func

README-en_US.md

@@ -210,6 +210,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)
+    --supportParseEnumDescByReg <string> custom regex for parsing enum description
     -h, --help                          display help for command
 ```
 
@@ -251,6 +252,7 @@ openapi -i ./spec.json -o ./apis
 | isOnlyGenTypeScriptType | no | boolean | false | only generate typescript type |
 | 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` |
+| supportParseEnumDescByReg | no | string \| RegExp | - | custom regex for parsing enum descriptions. If set, replaces default parseDescriptionEnum method. Example: `/([^\s=<>/&;]+(?:\s+[^\s=<>/&;]+)*)\s*=\s*(\d+)/g` matches "Normal = 0" or "SampleMaker = 1" |
 | binaryMediaTypes | no | string[] | - | custom binary media types list, default includes: ['application/octet-stream', 'application/pdf', 'image/*', 'video/*', 'audio/*'] |
 | hook | no | [Custom Hook](#Custom-Hook) | - | custom hook |
 

README.md

@@ -210,6 +210,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)
+    --supportParseEnumDescByReg <string> custom regex for parsing enum description
     -h, --help                          display help for command
 ```
 
@@ -251,6 +252,7 @@ openapi --i ./spec.json --o ./apis
 | isOnlyGenTypeScriptType | 否 | boolean | false | 仅生成 typescript 类型 |
 | isCamelCase | 否 | boolean | true | 小驼峰命名文件和请求函数 |
 | isSupportParseEnumDesc | 否 | boolean | false | 解析枚举描述生成枚举标签，格式参考：`系统用户角色:User(普通用户)=0,Agent(经纪人)=1,Admin(管理员)=2` |
+| supportParseEnumDescByReg | 否 | string \| RegExp | - | 自定义正则表达式，用于解析 description 中的枚举定义。如果设置了此参数，将使用此正则表达式替代默认的 parseDescriptionEnum 方法。例如：`/([^\s=<>/&;]+(?:\s+[^\s=<>/&;]+)*)\s*=\s*(\d+)/g` 可以匹配 "普通 = 0" 或 "SampleMaker = 1" 这样的格式 |
 | binaryMediaTypes | 否 | string[] | - | 自定义二进制媒体类型列表，默认包含：['application/octet-stream', 'application/pdf', 'image/*', 'video/*', 'audio/*'] |
 | hook | 否 | [Custom Hook](#Custom-Hook) | - | 自定义 hook |
 

agents.md

@@ -69,6 +69,7 @@ else if (isNodeProject) {
 | `isOnlyGenTypeScriptType` | boolean | `false` | Only types, no request functions | Type-only needs |
 | `isCamelCase` | boolean | `true` | Use camelCase naming | Consistent naming |
 | `isSupportParseEnumDesc` | boolean | `false` | Parse enum descriptions | Labeled enums |
+| `supportParseEnumDescByReg` | `string \| RegExp` | - | Custom regex for parsing enum descriptions. If set, replaces default parseDescriptionEnum method. Example: `/([^\s=<>/&;]+(?:\s+[^\s=<>/&;]+)*)\s*=\s*(\d+)/g` matches "普通 = 0" or "SampleMaker = 1" | Custom enum description formats |
 
 #### Request Customization
 
@@ -118,6 +119,7 @@ else if (isNodeProject) {
 | "支持文件上传" | Check OpenAPI for multipart | Auto-detects file uploads |
 | "翻译中文标签" | `isTranslateToEnglishTag: true` | Chinese to English tags |
 | "解析枚举描述" | `isSupportParseEnumDesc: true` | Enum with descriptions |
+| "自定义枚举解析正则" | `supportParseEnumDescByReg: /pattern/g` | Custom enum description parsing |
 | "生成JSON验证" | `isGenJsonSchemas: true` | Schema validation |
 | "前缀API路径" | `apiPrefix: "'api'"` | Add prefix to paths |
 
@@ -205,6 +207,8 @@ else if (isNodeProject) {
   isTranslateToEnglishTag: true,
   isDisplayTypeLabel: true,
   isSupportParseEnumDesc: true,
+  // Custom regex for parsing enum descriptions like "普通 = 0" or "SampleMaker = 1"
+  supportParseEnumDescByReg: /([^\s=<>/&;]+(?:\s+[^\s=<>/&;]+)*)\s*=\s*(\d+)/g,
   isCamelCase: true,
   filterCaseInsensitive: true,
 }

src/bin/openapi.ts

@@ -99,7 +99,7 @@ const params = program
   )
   .option(
     '--supportParseEnumDescByReg <string>',
-    'custom regex for parsing enum description, e.g., "(\\S+)\\s*=\\s*(\\S+)"'
+    'custom regex for parsing enum description'
   )
   .parse(process.argv)
   .opts();