feat: add isSplitTypesByModule func (#602)

* feat: add splitTypesByModule func

* chore: clean code

* fix: fix splitTypesByModule func

* chore: clean code

* perf: perf serviceGenarator code

* chore: clean code

* perf: rename splitTypesByModule => isSplitTypesByModule

Author: rookie-luochao

.changeset/common-bears-design.md

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

README-en_US.md

@@ -187,6 +187,7 @@ $ openapi --help
     -cfn, --configFileName <string>     config file name
     -cfp, --configFilePath <string>     config file path
     --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
+    --isSplitTypesByModule <boolean>      split types by module, generates {module}.type.ts, common.type.ts, enum.ts, types.ts (default: false)
     -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
@@ -227,6 +228,7 @@ openapi -i ./spec.json -o ./apis
 | schemaPath | yes | string | - | Swagger2/OpenAPI3 URL |
 | serversPath | no | string | './src/apis' | the folder path for the run results |
 | requestLibPath | no | string | 'axios' | custom request lib path, for example: '@/request', 'node-fetch' |
+| isSplitTypesByModule | no | boolean | false | split types by module, generates {module}.type.ts (module types), common.type.ts (common types), enum.ts (enum types), types.ts (unified export) |
 | full | no | boolean | true | full replacement |
 | describe | no | string | - | description information, which will be used when using cli interactive operation mode |
 | enableLogging | no | boolean | false | open the log |

README.md

@@ -187,6 +187,7 @@ $ openapi --help
     -cfn, --configFileName <string>     config file name
     -cfp, --configFilePath <string>     config file path
     --requestLibPath <string>           custom request lib path, for example: "@/request", "node-fetch" (default: "axios")
+    --isSplitTypesByModule <boolean>      split types by module, generates {module}.type.ts, common.type.ts, enum.ts, types.ts (default: false)
     -f, --full <boolean>                full replacement (default: true)
     --enableLogging <boolean>           open the log (default: false)
     --priorityRule <string>             priority rule, include/exclude/both (default: "include")
@@ -227,6 +228,7 @@ openapi --i ./spec.json --o ./apis
 | schemaPath | 是 | string | - | Swagger2/OpenAPI3 地址 |
 | serversPath | 否 | string | './src/apis' | 运行结果文件夹路径 |
 | requestLibPath | 否 | string | 'axios' | 自定义请求方法路径，例如：'@/request'、'node-fetch' |
+| isSplitTypesByModule | 否 | boolean | false | 按模块拆分类型文件，开启后会生成：{module}.type.ts（各模块类型）、common.type.ts（公共类型）、enum.ts（枚举类型）、types.ts（统一导出） |
 | full | 否 | boolean | true | 是否全量替换 |
 | describe | 否 | string | - | 描述信息，在用 cli 可交互运行方式时会用到 |
 | enableLogging | 否 | boolean | false | 是否开启日志 |

agents.md

@@ -70,6 +70,7 @@ else if (isNodeProject) {
 | `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 |
+| `isSplitTypesByModule` | boolean | `false` | Split types by module, generates {module}.type.ts, common.type.ts, enum.ts, types.ts | Large projects with many types |
 
 #### Request Customization
 
@@ -122,6 +123,7 @@ else if (isNodeProject) {
 | "自定义枚举解析正则" | `supportParseEnumDescByReg: /pattern/g` | Custom enum description parsing |
 | "生成JSON验证" | `isGenJsonSchemas: true` | Schema validation |
 | "前缀API路径" | `apiPrefix: "'api'"` | Add prefix to paths |
+| "按模块拆分类型" | `isSplitTypesByModule: true` | Large projects, better code organization |
 
 ## 📋 Common Configuration Scenarios
 
@@ -277,6 +279,24 @@ else if (isNodeProject) {
 }
 ```
 
+### Scenario 11: Large Project with Module-Based Type Splitting
+
+```typescript
+{
+  schemaPath: "./openapi.json",
+  serversPath: "./src/apis",
+  isSplitTypesByModule: true, // Split types by module
+  isGenReactQuery: true,
+  isDisplayTypeLabel: true,
+  isCamelCase: true,
+  // Generates:
+  // - {module}.type.ts (module-specific types)
+  // - common.type.ts (shared types)
+  // - enum.ts (all enums)
+  // - types.ts (unified export)
+}
+```
+
 ## ⚠️ Configuration Conflicts & Rules
 
 ### ❌ Incompatible Combinations
@@ -304,6 +324,7 @@ else if (isNodeProject) {
 - **Development**: `mockFolder + enableLogging + full: false`
 - **International**: `isTranslateToEnglishTag + isDisplayTypeLabel + isSupportParseEnumDesc`
 - **Type-only libraries**: `isOnlyGenTypeScriptType + isGenJsonSchemas + namespace`
+- **Large projects**: `isSplitTypesByModule: true + isGenReactQuery + isDisplayTypeLabel`
 
 ## 🔧 Advanced Customization Hooks
 
@@ -546,6 +567,8 @@ export const ${api.functionName} = async (${api.params}) => {
 
 ## 📁 Generated File Structure
 
+### Default Structure (isSplitTypesByModule: false)
+
 ```
 src/apis/
 ├── index.ts           # Main entry point with all exports
@@ -560,6 +583,25 @@ src/apis/
     └── ...
 ```
 
+### Module-Based Structure (isSplitTypesByModule: true)
+
+```
+src/apis/
+├── index.ts           # Main entry point with all exports
+├── types.ts           # Unified type exports
+├── enum.ts            # All enum type definitions
+├── common.type.ts     # Shared/common types used by multiple modules
+├── [module].type.ts   # Module-specific types (e.g., user.type.ts, order.type.ts)
+├── [controller].ts    # API functions grouped by tags
+├── displayTypeLabel.ts # Chinese field labels (if enabled)
+├── displayEnumLabel.ts # Enum translations (if enabled)
+├── schema.ts          # JSON Schemas (if enabled)
+├── reactquery.ts      # React Query hooks (if enabled)
+└── mocks/             # Mock data files (if enabled)
+    ├── [endpoint].mock.ts
+    └── ...
+```
+
 ## 🚀 Performance Optimization Tips
 
 ### For Large APIs (100+ endpoints)

src/bin/openapi.ts

@@ -23,6 +23,11 @@ const params = program
     '--requestLibPath <string>',
     'custom request lib path, for example: "@/request", "node-fetch" (default: "axios")'
   )
+  .option(
+    '--isSplitTypesByModule <boolean>',
+    'split types by module, generates {module}.type.ts, common.type.ts, enum.ts, types.ts',
+    false
+  )
   .option('-f, --full <boolean>', 'full replacement', true)
   .option('--enableLogging <boolean>', 'open the log', false)
   .option(
@@ -151,6 +156,8 @@ const baseGenerate = (_params_: OptionValues): GenerateServiceProps => {
     supportParseEnumDescByReg: _params_.supportParseEnumDescByReg as
       | string
       | RegExp,
+    isSplitTypesByModule:
+      JSON.parse(_params_.isSplitTypesByModule as string) === true,
   };
 
   return options;

src/generator/config.ts

@@ -12,6 +12,10 @@ export const displayTypeLabelFileName = 'displayTypeLabel';
 
 export const schemaFileName = 'schema';
 
+export const enumFileName = 'enum';
+
+export const commonTypeFileName = 'common.type';
+
 export const displayReactQueryFileName = (reactQueryMode: IReactQueryMode) => {
   return {
     react: 'reactquery',
@@ -27,6 +31,9 @@ export enum TypescriptFileType {
   displayTypeLabel = 'displayTypeLabel',
   schema = 'schema',
   reactQuery = 'reactQuery',
+  moduleType = 'moduleType',
+  typeIndex = 'typeIndex',
+  enum = 'enum',
 }
 
 export const DEFAULT_SCHEMA: SchemaObject = {