anl 26.123.0 → 26.201.0

package/README.md

@@ -1,6 +1,8 @@
-# an-cli
+## 🌐 Language / 语言
 
-[简体中文](./README.zh.md) | English | [Español](./README.es.md) | [العربية](./README.ar.md) | [Français](./README.fr.md) | [Русский](./README.ru.md) | [日本語](./README.jp.md)
+[English](https://bianliuzhu.github.io/an-cli/#/en/) | [简体中文](https://bianliuzhu.github.io/an-cli/#/zh-cn/) | [日本語](https://bianliuzhu.github.io/an-cli/#/jp/) | [Español](https://bianliuzhu.github.io/an-cli/#/es/) | [Français](https://bianliuzhu.github.io/an-cli/#/fr/) | [Русский](https://bianliuzhu.github.io/an-cli/#/ru/) | [العربية](https://bianliuzhu.github.io/an-cli/#/ar/)
+
+---
 
 # Overview
 
@@ -10,7 +12,7 @@
 > - `anl lint` command: Generates eslint, stylelint, prettier, commitLint, and VSCode related configurations for React or Vue projects
 > - `anl git` command: Generates git local configuration with optional features: gitflow standard branch creation, git commit messages subject, and git custom command configuration
 
-# Features
+## Features
 
 - `anl type`
   - 🚀 Automatically parses Swagger JSON documentation
@@ -38,1384 +40,230 @@
   - 🔄 Provides git custom command configuration and entry points
   - 📦 Automated generation with zero configuration
 
-# Installation
-
-> [!NOTE]
-> Requires global installation
-
-```bash
-$ npm install anl -g
-```
-
-```bash
-$ yarn global add anl
-```
-
-```bash
-$ pnpm add -g anl
-```
+---
 
-# Usage
+# 功能概述
 
-> [!TIP]
+> an-cli 是前端命令行工具，包含以下命令:
 >
-> 1. If you're using it for the first time and unsure about the results, it's recommended to execute the command first, observe what changes occur in the project, then combine with the documentation to further modify the configuration and regenerate until you achieve your ideal setup
-> 2. Or follow the steps below step by step for results
-> 3. Please execute `anl type`, `anl lint`, `anl git` commands in the project root directory
+> - `anl type` 命令：基于 Swagger JSON 自动生成 TypeScript 类型定义和 API 请求函数的命令行工具。
+> - `anl lint` 命令: 生成 react 或 vue 项目 eslint、stylelint、prettier、commitLint、VSCode相关配置
+> - `anl git` 命令: 生成 git 本地配置，并设有可选功能： gitflow 标准分支创建、git commit messages 主题、git 自定义命令配置
 
-## `anl type` Command Usage
+## 功能特点
 
-- **First time** executing the `anl type` command will automatically create a configuration file named `an.config.json` in the _project root directory_ (can also be created manually) to initialize the configuration template.
-
-- When executing the `anl type` command, it will look for the `an.config.json` configuration file in the user's project root directory, read its configuration information, and generate corresponding axios encapsulation, configuration, interface list, interface requests, and TS types for each interface request parameters and responses
-
-- Configuration items in the configuration file can be freely modified
-
-- About the `an.config.json` configuration file
-  - The configuration file must be in the project root directory
+- `anl type`
+  - 🚀 自动解析 Swagger JSON 文档
+  - 📦 生成 TypeScript 类型定义文件
+  - 🔄 生成类型安全的 API 请求函数
+  - 🎯 支持路径参数、查询参数和请求体
+  - 📝 自动生成枚举类型定义
+  - 🎨 支持代码格式化
+  - ⚡️ 支持文件上传
+  - 🛠 可配置的代码生成选项
+  - 🌐 支持多 Swagger 服务器配置
+  - 🔧 支持 OPTIONS、HEAD、SEARCH 等 HTTP 方法
 
-  - The configuration file name cannot be changed
+- `anl lint`
+  - 🔍 一键配置各种 lint 工具
+  - 🎨 ESLint 配置自动化
+  - 🎯Prettier 格式化配置
+  - 🔄 CommitLint 提交规范
+  - 📦 VSCode 编辑器配置
 
-  - For specific parameter descriptions, see [Configuration File Details](#configuration-file-details)
+- `anl git`
+  - 🔍 多种功能可选安装
+  - 🎨 标准 git flow 分支创建
+  - 🎯 符合 CommitLint 提交规范的主题自动设置
+  - 🔄 提供 git 自定义命令配置以及入口
+  - 📦 自动化生成 0 配置
 
-- Update the configuration file according to your needs, then execute the `anl type` command again, and it will generate corresponding type information according to the specified configuration information in the configuration file
+---
 
-- If files like 'config.ts', 'error-message.ts', 'fetch.ts', 'api-type.d.ts' exist, they will not be regenerated
+# نظرة عامة على الوظائف
 
-> [!NOTE]
+> an-cli هو أداة سطر أوامر للواجهة الأمامية، يتضمن الأوامر التالية:
 >
-> If you're unclear about these configurations, you can first execute the anl type command to generate the types, then check the project directory, combine with the configuration item descriptions, adjust the configuration items, and regenerate to gradually verify the role of configuration items and complete the final configuration
-
-### Usage Method
-
-```bash
-$ anl type
-```
-
-### Configuration File Details
-
-#### Configuration File Example
-
-**Single Swagger Server Configuration:**
-
-```json
-{
-	"saveTypeFolderPath": "apps/types",
-	"saveApiListFolderPath": "apps/api/",
-	"saveEnumFolderPath": "apps/enums",
-	"importEnumPath": "../../enums",
-	"requestMethodsImportPath": "./fetch",
-	"formatting": {
-		"indentation": "\t",
-		"lineEnding": "\n"
-	},
-	"enmuConfig": {
-		"erasableSyntaxOnly": false,
-		"varnames": "enum-varnames",
-		"comment": "enum-descriptions"
-	},
-	"swaggerConfig": {
-		"url": "https://generator3.swagger.io/openapi2.json",
-		"apiListFileName": "index.ts",
-		"publicPrefix": "/api",
-		"modulePrefix": "/gateway",
-		"dataLevel": "serve",
-		"parameterSeparator": "_",
-		"headers": {
-			"Authorization": "Bearer token"
-		},
-		"includeInterface": [
-			{
-				"path": "/api/user",
-				"method": "get",
-				"dataLevel": "data"
-			}
-		],
-		"excludeInterface": []
-	}
-}
-```
-
-**Multiple Swagger Servers Configuration:**
-
-```json
-{
-	"saveTypeFolderPath": "apps/types",
-	"saveApiListFolderPath": "apps/api/",
-	"saveEnumFolderPath": "apps/enums",
-	"importEnumPath": "../../enums",
-	"requestMethodsImportPath": "./fetch",
-	"dataLevel": "serve",
-	"formatting": {
-		"indentation": "\t",
-		"lineEnding": "\n"
-	},
-	"enmuConfig": {
-		"erasableSyntaxOnly": false,
-		"varnames": "enum-varnames",
-		"comment": "enum-descriptions"
-	},
-	"swaggerConfig": [
-		{
-			"url": "https://generator3.swagger.io/openapi1.json",
-			"apiListFileName": "op.ts",
-			"modulePrefix": "/forward",
-			"dataLevel": "serve",
-			"parameterSeparator": "_",
-			"headers": {},
-			"includeInterface": [
-				{
-					"path": "/generate",
-					"method": "post",
-					"dataLevel": "axios"
-				}
-			],
-			"excludeInterface": []
-		},
-		{
-			"url": "https://generator3.swagger.io/openapi2.json",
-			"apiListFileName": "index.ts",
-			"publicPrefix": "/api",
-			"dataLevel": "data",
-			"headers": {}
-		}
-	]
-}
-```
-
-#### Configuration Item Descriptions
-
-| Configuration Item                                   | Type                                                                            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                  |
-| ---------------------------------------------------- | ------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| saveTypeFolderPath                                   | string                                                                          | Yes      | Type definition file save path                                                                                                                                                                                                                                                                                                                                                                               |
-| saveApiListFolderPath                                | string                                                                          | Yes      | API request function file save path                                                                                                                                                                                                                                                                                                                                                                          |
-| saveEnumFolderPath                                   | string                                                                          | Yes      | Enum data file save path                                                                                                                                                                                                                                                                                                                                                                                     |
-| importEnumPath                                       | string                                                                          | Yes      | Enum import path (path referenced by enum files in apps/types/models/\*.ts)                                                                                                                                                                                                                                                                                                                                  |
-| swaggerJsonUrl                                       | string                                                                          | No       | Swagger JSON documentation address (migrated to `swaggerConfig`, retained for backward compatibility) **This field will be removed in future versions**                                                                                                                                                                                                                                                      |
-| swaggerConfig                                        | object \| Array<object>                                                         | No       | Swagger server configuration. Single server can be an object, multiple servers use an array. Each server can configure `url`, `publicPrefix`, `modulePrefix`, `apiListFileName`, `headers`, `dataLevel`, `parameterSeparator`, `includeInterface`, `excludeInterface`, `responseModelTransform`<br />See single and multiple Swagger server configuration examples above                                     |
-| swaggerConfig[].url                                  | string                                                                          | Yes      | Swagger JSON documentation address                                                                                                                                                                                                                                                                                                                                                                           |
-| swaggerConfig[].publicPrefix                         | string                                                                          | No       | Common prefix on url path, e.g.: api/users, api/users/{id}, api is the common prefix                                                                                                                                                                                                                                                                                                                         |
-| swaggerConfig[].apiListFileName                      | string                                                                          | No       | API list file name, defaults to `index.ts`. When using multiple servers, each server's file name must be unique                                                                                                                                                                                                                                                                                              |
-| swaggerConfig[].headers                              | object                                                                          | No       | Request header configuration for this server                                                                                                                                                                                                                                                                                                                                                                 |
-| swaggerConfig[].modulePrefix                         | string                                                                          | No       | Request path prefix (can be understood as module name), automatically added to the front of each API request path.<br />For example: when `modulePrefix: "/forward"`<br />`/publicPrefix/modulePrefix/user` becomes `/api/forward/user`                                                                                                                                                                      |
-| swaggerConfig[].dataLevel                            | 'data' \| 'serve' \| 'axios'                                                    | No       | Interface return data level for this server. If not set, uses global `dataLevel` configuration                                                                                                                                                                                                                                                                                                               |
-| swaggerConfig[].parameterSeparator                   | '$' \| '\_'                                                                     | No       | Separator used when generating API names and type names for this server. If not set, uses global `parameterSeparator` configuration                                                                                                                                                                                                                                                                          |
-| swaggerConfig[].includeInterface                     | Array<{path: string, method: string, dataLevel?: 'data' \| 'serve' \| 'axios'}> | No       | List of interfaces to include for this server. Each interface can configure `dataLevel` individually with the highest priority. If not set, uses global `includeInterface` configuration                                                                                                                                                                                                                     |
-| swaggerConfig[].excludeInterface                     | Array<{path: string, method: string}>                                           | No       | List of interfaces to exclude for this server. If not set, uses global `excludeInterface` configuration                                                                                                                                                                                                                                                                                                      |
-| swaggerConfig[].responseModelTransform               | object                                                                          | No       | Response model transformation configuration for this server. Supports three modes: `unwrap` (extract response model), `wrap` (add response model), `replace` (replace response model). If not set, uses global `responseModelTransform` configuration. See [Response Model Transform](#response-model-transform)                                                                                             |
-| swaggerConfig[].responseModelTransform.type          | `'unwrap'` \| `'wrap'` \| `'replace'`                                           | Yes      | Response model transformation type. `unwrap`: Extract data field from response wrapper; `wrap`: Add unified wrapper structure to original response; `replace`: Replace response with custom type. See [Scenario 1](#scenario-1-add-response-model-to-interfaces-without-one-wrap), [Scenario 2](#scenario-2-remove-existing-response-model-unwrap), [Scenario 3](#scenario-3-replace-response-model-replace) |
-| swaggerConfig[].responseModelTransform.dataField     | string                                                                          | No       | Data field name for `unwrap` and `wrap` modes, defaults to `"data"`                                                                                                                                                                                                                                                                                                                                          |
-| swaggerConfig[].responseModelTransform.wrapperFields | Record<string, string>                                                          | No       | Wrapper field definitions for `wrap` mode, key is field name, value is field type. Example: `{"success": "boolean", "code": "number", "message": "string", "data": "T"}`                                                                                                                                                                                                                                     |
-| swaggerConfig[].responseModelTransform.wrapperType   | string                                                                          | No       | Replacement type string for `replace` mode. Can be any TypeScript type, e.g.: `"ApiResponse<T>"`                                                                                                                                                                                                                                                                                                             |
-| requestMethodsImportPath                             | string                                                                          | Yes      | Request method import path                                                                                                                                                                                                                                                                                                                                                                                   |
-| dataLevel                                            | 'data' \| 'serve' \| 'axios'                                                    | No       | Global interface return data level configuration, default: `'serve'`. Each server can override individually                                                                                                                                                                                                                                                                                                  |
-| responseModelTransform                               | object                                                                          | No       | Global response model transformation configuration. Each server can override individually. Configuration items same as `swaggerConfig[].responseModelTransform`. See [Response Model Transform](#response-model-transform)                                                                                                                                                                                   |
-| formatting                                           | object                                                                          | No       | Code formatting configuration                                                                                                                                                                                                                                                                                                                                                                                |
-| formatting.indentation                               | string                                                                          | No       | Code indentation character, e.g.: `"\t"` or `"  "` (two spaces)                                                                                                                                                                                                                                                                                                                                              |
-| formatting.lineEnding                                | string                                                                          | No       | Line ending, e.g.: `"\n"` (LF) or `"\r\n"` (CRLF)                                                                                                                                                                                                                                                                                                                                                            |
-| headers                                              | object                                                                          | No       | Request header configuration (migrated to `swaggerConfig`, retained for backward compatibility)                                                                                                                                                                                                                                                                                                              |
-| includeInterface                                     | Array<{path: string, method: string, dataLevel?: 'data' \| 'serve' \| 'axios'}> | No       | Global included interfaces: The interface list file specified by `saveApiListFolderPath` will only include interfaces in the list, mutually exclusive with `excludeInterface` field. Each interface can configure `dataLevel` individually. Each server can override individually                                                                                                                            |
-| excludeInterface                                     | Array<{path: string, method: string}>                                           | No       | Global excluded interfaces: The interface list file specified by `saveApiListFolderPath` will not include interfaces in this list, mutually exclusive with `includeInterface`. Each server can override individually                                                                                                                                                                                         |
-| publicPrefix                                         | string                                                                          | No       | Global common prefix on url path (migrated to `swaggerConfig`, retained for backward compatibility)                                                                                                                                                                                                                                                                                                          |
-| modulePrefix                                         | string                                                                          | No       | Global request path prefix (each server can override individually)                                                                                                                                                                                                                                                                                                                                           |
-| apiListFileName                                      | string                                                                          | No       | Global API list file name, defaults to `index.ts` (migrated to `swaggerConfig`, retained for backward compatibility)                                                                                                                                                                                                                                                                                         |
-| enmuConfig                                           | object                                                                          | Yes      | Enum configuration object                                                                                                                                                                                                                                                                                                                                                                                    |
-| enmuConfig.erasableSyntaxOnly                        | boolean                                                                         | Yes      | Align with tsconfig.json `compilerOptions.erasableSyntaxOnly`. When `true`, generates const objects instead of enums (type-only syntax). Default: `false`                                                                                                                                                                                                                                                    |
-| enmuConfig.varnames                                  | string                                                                          | No       | Swagger schema field name for custom enum member names. Default: `enum-varnames`.                                                                                                                                                                                                                                                                                                                            |
-| enmuConfig.comment                                   | string                                                                          | No       | Swagger schema field name for custom enum descriptions (used for generating comments). Default: `enum-descriptions`.                                                                                                                                                                                                                                                                                         |
-| parameterSeparator                                   | '$' \| '\_'                                                                     | No       | Global separator used between path segments and parameters when generating API names and type names. For example, `/users/{userId}/posts` with separator `'_'` generates `users_userId_posts_GET`. Default: `'_'`. Each server can override individually                                                                                                                                                     |
-| enmuConfig.varnames                                  | string                                                                          | No       | Schema field name that stores custom enum member identifiers. Default: `enum-varnames`.                                                                                                                                                                                                                                                                                                                      |
-| enmuConfig.comment                                   | string                                                                          | No       | Schema field name that stores enum member descriptions (used for inline comments). Default: `enum-descriptions`.                                                                                                                                                                                                                                                                                             |
-
-#### Configuration Items and Generated Files Correspondence
-
-> File structure is generated based on configuration file, marked **uncontrolled** indicates: The folder and its files are automatically generated and not controlled by configuration items
-
-```
-project/
-├── apps/
-│   ├── types/               		# Specified by saveTypeFolderPath configuration item
-│   │   ├── models/          				# All type definition files (excluding enum types) uncontrolled
-│   │   ├── connectors/      				# API type definitions (interface definition files) uncontrolled
-│   └── api/                 		# Request files: Specified by saveApiListFolderPath configuration item
-│   │    └── index.ts        				# API request function list (single server or first server) uncontrolled
-│   │    └── op.ts           				# Other servers' API list files when using multiple servers uncontrolled
-│   │    └── api-type.d.ts      		# Request type definition file uncontrolled
-│   │    └── config.ts       				# Request, response interceptor, request configuration uncontrolled
-│   │    └── error-message.ts   		# System-level error messages uncontrolled
-│   │    ├── fetch.ts        				# Axios request encapsulation, can be replaced with fetch uncontrolled
-│   └── enums/               		# Enum data type definitions: Specified by saveEnumFolderPath configuration item
-```
-
-### Generated Code Examples
-
-#### Interface Type Definition
-
-```typescript
-declare namespace UserDetail_GET {
-	interface Query {
-		userId: string;
-	}
-
-	interface Response {
-		id: string;
-		name: string;
-		age: number;
-		role: UserRole;
-	}
-}
-```
-
-#### API Request Function
-
-```typescript
-import { GET } from './fetch';
-
-/**
- * Get user details
- */
-export const userDetailGet = (params: UserDetail_GET.Query) => GET<UserDetail_GET.Response>('/user/detail', params);
-```
-
-### Feature Descriptions
-
-#### Configuration Priority
+> - أمر `anl type`: أداة سطر أوامر لتوليد تعريفات أنواع TypeScript ودوال طلبات API تلقائيًا بناءً على Swagger JSON.
+> - أمر `anl lint`: توليد تكوينات eslint و stylelint و prettier و commitLint و VSCode ذات الصلة لمشاريع react أو vue
+> - أمر `anl git`: توليد تكوين git المحلي، مع وظائف اختيارية: إنشاء فروع gitflow القياسية، موضوعات رسائل git commit، تكوين أوامر git المخصصة
 
-The tool supports global configuration and server-level configuration, following these priority rules:
+## الميزات الرئيسية
 
-**Priority: Interface-level configuration > Server-level configuration > Global configuration > Default values**
-
-The following configuration items support multi-level priority override:
-
-- `dataLevel`: Interface return data level
-  - **Interface-level**: `includeInterface[].dataLevel` - Highest priority
-  - **Server-level**: `swaggerConfig[].dataLevel` - Secondary priority
-  - **Global configuration**: `dataLevel` - Base priority
-  - **Default value**: `'serve'`
-- `parameterSeparator`: Separator for API names and type names
-- `includeInterface`: List of included interfaces
-- `excludeInterface`: List of excluded interfaces
-- `modulePrefix`: Request path prefix
-- `publicPrefix`: URL common prefix
-- `headers`: Request header configuration
-
-**Example:**
-
-```json
-{
-	"dataLevel": "serve",
-	"parameterSeparator": "_",
-	"swaggerConfig": [
-		{
-			"url": "http://api1.example.com/swagger.json",
-			"dataLevel": "data",
-			"apiListFileName": "api1.ts"
-		},
-		{
-			"url": "http://api2.example.com/swagger.json",
-			"apiListFileName": "api2.ts"
-		}
-	]
-}
-```
-
-In the above configuration:
-
-- `api1.ts` uses `dataLevel: "data"` (server-level configuration)
-- `api2.ts` uses `dataLevel: "serve"` (global configuration)
-- Both servers use `parameterSeparator: "_"` (global configuration)
-
-#### Type Parsing
-
-- Supports all OpenAPI 3.0 specification data types
-- Automatically handles complex nested types
-- Supports arrays, objects, enums, and other types
-- Automatically generates interface comments
-
-#### Enum Generation
-
-The tool supports two enum generation modes, controlled by the `enmuConfig.erasableSyntaxOnly` configuration:
-
-**Traditional Enum Mode** (`enmuConfig.erasableSyntaxOnly: false`, default):
-
-```typescript
-export enum Status {
-	Success = 'Success',
-	Error = 'Error',
-	Pending = 'Pending',
-}
-```
-
-**Const Object Mode** (`enmuConfig.erasableSyntaxOnly: true`):
-
-```typescript
-export const Status = {
-	Success: 'Success',
-	Error: 'Error',
-	Pending: 'Pending',
-} as const;
-
-export type StatusType = (typeof Status)[keyof typeof Status];
-```
-
-> **Why use const object mode?**
-> When TypeScript's `compilerOptions.erasableSyntaxOnly` is set to `true`, the code can only use type-erasable syntax. Traditional `enum` generates runtime code, while const objects are type-only and get completely erased during compilation. This ensures compatibility with build tools that require type-only syntax.
-
-**Usage in types:**
-
-```typescript
-// Traditional enum mode
-interface User {
-	status: Status; // Use enum as type directly
-}
-
-// Const object mode
-interface User {
-	status: StatusType; // Use the generated type with 'Type' suffix
-}
-```
-
-#### Data Level Configuration (dataLevel)
-
-`dataLevel` is used to configure the extraction level of interface return data, supporting three options:
-
-1. **`'serve'` (default)**: Extracts the `data` field from server response
-
-   ```typescript
-   // Server returns: { code: 200, message: 'success', data: { id: 1, name: 'user' } }
-   // Function returns: { id: 1, name: 'user' }
-   ```
-
-2. **`'data'`**: Extracts the `data.data` field (for nested data scenarios)
-
-   ```typescript
-   // Server returns: { data: { code: 200, data: { id: 1, name: 'user' } } }
-   // Function returns: { id: 1, name: 'user' }
-   ```
-
-3. **`'axios'`**: Returns the complete axios response object
-   ```typescript
-   // Server returns: { code: 200, message: 'success', data: { id: 1, name: 'user' } }
-   // Function returns: { code: 200, message: 'success', data: { id: 1, name: 'user' } }
-   ```
-
-**Configuration Priority:**
-
-`dataLevel` supports three-level configuration priority:
-
-```
-Interface-level > Server-level > Global configuration > Default value
-```
+- `anl type`
+  - 🚀 تحليل مستندات Swagger JSON تلقائيًا
+  - 📦 توليد ملفات تعريف أنواع TypeScript
+  - 🔄 توليد دوال طلبات API آمنة من حيث الأنواع
+  - 🎯 دعم معاملات المسار ومعاملات الاستعلام وجسم الطلب
+  - 📝 توليد تعريفات أنواع التعداد تلقائيًا
+  - 🎨 دعم تنسيق الكود
+  - ⚡️ دعم تحميل الملفات
+  - 🛠 خيارات توليد كود قابلة للتكوين
+  - 🌐 دعم تكوين خوادم Swagger متعددة
+  - 🔧 دعم طرق HTTP مثل OPTIONS و HEAD و SEARCH
 
-**Configuration example:**
+- `anl lint`
+  - 🔍 تكوين أدوات lint المختلفة بنقرة واحدة
+  - 🎨 أتمتة تكوين ESLint
+  - 🎯 تكوين تنسيق Prettier
+  - 🔄 معيار التزام CommitLint
+  - 📦 تكوين محرر VSCode
 
-```json
-{
-	"dataLevel": "serve",
-	"swaggerConfig": [
-		{
-			"url": "http://api1.example.com/swagger.json",
-			"dataLevel": "data",
-			"includeInterface": [
-				{
-					"path": "/api/user/detail",
-					"method": "get",
-					"dataLevel": "axios"
-				},
-				{
-					"path": "/api/user/list",
-					"method": "get"
-				}
-			]
-		}
-	]
-}
-```
+- `anl git`
+  - 🔍 تثبيت اختياري لوظائف متعددة
+  - 🎨 إنشاء فروع git flow القياسية
+  - 🎯 تعيين موضوع تلقائي يتوافق مع معيار CommitLint
+  - 🔄 توفير تكوين أوامر git المخصصة ونقطة الدخول
+  - 📦 توليد تلقائي بدون تكوين
 
-In the above configuration:
+---
 
-- `/api/user/detail` interface uses `dataLevel: "axios"` (interface-level configuration, highest priority)
-- `/api/user/list` interface uses `dataLevel: "data"` (server-level configuration)
-- Other server interfaces use `dataLevel: "serve"` (global configuration)
+# Descripción General de Funciones
 
-> **Note**:
+> an-cli es una herramienta de línea de comandos para frontend que incluye los siguientes comandos:
 >
-> - Interface-level `dataLevel` configuration has the highest priority, suitable for scenarios where individual interfaces need special handling
-> - Server-level `dataLevel` configuration will override global configuration
-> - Uses default value `'serve'` when not configured
-
-#### Code Formatting
-
-The tool supports custom code formatting options, controlled by the `formatting` configuration:
-
-**Configuration example:**
-
-```json
-{
-	"formatting": {
-		"indentation": "\t",
-		"lineEnding": "\n"
-	}
-}
-```
-
-**Configuration description:**
-
-- `indentation`: Code indentation character
-  - `"\t"`: Use Tab indentation (default)
-  - `"  "`: Use 2 spaces indentation
-  - `"    "`: Use 4 spaces indentation
-- `lineEnding`: Line ending type
-  - `"\n"`: LF (Linux/macOS style, recommended)
-  - `"\r\n"`: CRLF (Windows style)
-
-**Note:** If Prettier is configured in the project, the generated code will automatically use Prettier for formatting, and the `formatting` configuration may be overridden by Prettier.
-
-#### File Upload
-
-When file upload types are detected, corresponding request headers are automatically added:
-
-```typescript
-export const uploadFile = (params: UploadFile.Body) =>
-	POST<UploadFile.Response>('/upload', params, {
-		headers: { 'Content-Type': 'multipart/form-data' },
-	});
-```
-
-#### Error Handling
-
-The tool has built-in comprehensive error handling mechanisms:
-
-- Parse error prompts
-- Type generation failure warnings
-- File write exception handling
-
-#### Interface Filtering
-
-The tool supports filtering interfaces to be generated through configuration:
-
-1. Include specific interfaces
-   - Specify interfaces to be generated through the `includeInterface` configuration item
-   - Only interfaces specified in the configuration will be generated
-   - Configuration format is an object array containing `path`, `method`, and optional `dataLevel`
-   - Each interface can configure `dataLevel` individually with the highest priority
-
-2. Exclude specific interfaces
-   - Specify interfaces to be excluded through the `excludeInterface` configuration item
-   - All interfaces except those specified in the configuration will be generated
-   - Configuration format is an object array containing `path` and `method`
-
-Example configuration: This configuration is in `an.config.json`
-
-```json
-{
-	"includeInterface": [
-		{
-			"path": "/api/user",
-			"method": "get",
-			"dataLevel": "data"
-		}
-	],
-	"excludeInterface": [
-		{
-			"path": "/api/admin",
-			"method": "post"
-		}
-	]
-}
-```
-
-Note: `includeInterface` and `excludeInterface` cannot be used simultaneously. If both are configured, `includeInterface` will be prioritized.
-
-#### Multiple Swagger Servers Support
-
-The tool supports configuring multiple Swagger servers, each server can be configured independently:
-
-- **Single server**: `swaggerConfig` can be directly filled with an object
-- **Multiple servers**: `swaggerConfig` uses an array format, each server must configure a unique `apiListFileName`
-
-**How it works:**
-
-- The first server's APIs will be generated to the specified `apiListFileName` (defaults to `index.ts`)
-- Subsequent servers' APIs will be appended to their respective `apiListFileName` files
-- Type definitions and enums will be merged into a unified folder to avoid duplication
-
-**Server-level configuration:**
-
-Each server supports independent configuration of the following options. If not set, global configuration will be used:
-
-- `dataLevel` - Interface return data level
-- `parameterSeparator` - Separator for API names and type names
-- `includeInterface` - List of included interfaces
-- `excludeInterface` - List of excluded interfaces
-- `modulePrefix` - Request path prefix
-
-#### Path Prefix (modulePrefix)
-
-`modulePrefix` is used to automatically add a prefix to all API request paths, which is particularly useful in the following scenarios:
-
-1. **Reverse proxy scenarios**: When backend services are forwarded through a reverse proxy
-2. **API Gateway**: Uniformly add gateway prefix to paths
-3. **Multi-environment configuration**: Use different path prefixes for different environments
-
-**Usage example:**
-
-```json
-{
-	"swaggerConfig": [
-		{
-			"url": "http://api.example.com/swagger.json",
-			"modulePrefix": "/forward",
-			"apiListFileName": "api.ts"
-		}
-	]
-}
-```
-
-**Effect:**
-
-The path `/api/user/list` defined in Swagger will be generated as:
-
-```typescript
-export const apiUserListGet = (params: ApiUserList_GET.Query) => GET<ApiUserList_GET.Response>('/forward/api/user/list', params);
-```
-
-**Difference from publicPrefix:**
-
-- `publicPrefix`: Used to remove common prefix from interface paths (only affects generated function names)
-- `modulePrefix`: Used to add prefix to actual request paths (affects runtime request URLs)
-
-**Configuration example:**
-
-```json
-{
-	"swaggerConfig": [
-		{
-			"url": "http://api1.example.com/swagger.json",
-			"apiListFileName": "api1.ts",
-			"publicPrefix": "/api/v1",
-			"modulePrefix": "/forward",
-			"dataLevel": "serve",
-			"parameterSeparator": "_",
-			"headers": {
-				"Authorization": "Bearer token1"
-			},
-			"includeInterface": [
-				{
-					"path": "/api/v1/users",
-					"method": "get"
-				}
-			]
-		},
-		{
-			"url": "http://api2.example.com/swagger.json",
-			"apiListFileName": "api2.ts",
-			"publicPrefix": "/api/v2",
-			"dataLevel": "data",
-			"headers": {
-				"Authorization": "Bearer token2"
-			}
-		}
-	]
-}
-```
-
-**Migration notes:**
-
-- Old configuration (`swaggerJsonUrl`, `publicPrefix`, `headers`) is still compatible
-- The tool will automatically detect old configuration and suggest migration methods
-- It's recommended to migrate to the new `swaggerConfig` configuration for better flexibility
-
-#### HTTP Method Support
-
-The tool supports the following HTTP methods:
-
-- `GET` - Get resources
-- `POST` - Create resources
-- `PUT` - Update resources (full replacement)
-- `PATCH` - Update resources (partial update)
-- `DELETE` - Delete resources
-- `OPTIONS` - Preflight requests
-- `HEAD` - Get response headers
-- `SEARCH` - Search requests
-
-All methods support type-safe parameter and response type definitions.
-
-#### Response Model Transform
-
-The response model transformation feature allows you to automatically transform Swagger/OpenAPI response types when generating TypeScript types. It supports three transformation modes:
-
-1. **unwrap (extract response model)**: Extract the data field from the response wrapper
-2. **wrap (add response model)**: Add a unified wrapper structure to the original response
-3. **replace (replace response model)**: Replace the response with a custom type
-
-##### Configuration Location
-
-Add `responseModelTransform` configuration in the `swaggerConfig` of your `an.config.json` file:
-
-```json
-{
-	"swaggerConfig": [
-		{
-			"url": "./data/api.json",
-			"apiListFileName": "api.ts",
-			"responseModelTransform": {
-				// configuration items
-			}
-		}
-	]
-}
-```
-
-##### Scenario 1: Add Response Model to Interfaces Without One (wrap)
-
-**Use Case**
-
-When Swagger definitions directly return data objects, but actual API responses contain a unified wrapper structure.
-
-**Problem Example**
-
-Swagger definition directly returns user data:
-
-```json
-{
-	"paths": {
-		"/api/user/current": {
-			"get": {
-				"responses": {
-					"200": {
-						"content": {
-							"application/json": {
-								"schema": {
-									"$ref": "#/components/schemas/UsersEntityDto"
-								}
-							}
-						}
-					}
-				}
-			}
-		}
-	}
-}
-```
-
-Generated type (without response model):
-
-```typescript
-declare namespace ApiUserCurrent_GET {
-	type Response = import('../models/users-entity-dto').UsersEntityDto;
-}
-```
-
-Actual API response:
-
-```json
-{
-	"success": true,
-	"code": 0,
-	"message": "success",
-	"data": {
-		"uid": "user123",
-		"username": "Zhang San",
-		"email": "zhangsan@example.com"
-	}
-}
-```
-
-**Solution**
-
-Add `wrap` type response model transformation in configuration:
+> - Comando `anl type`: Herramienta de línea de comandos que genera automáticamente definiciones de tipos TypeScript y funciones de solicitud API basadas en Swagger JSON.
+> - Comando `anl lint`: Genera configuraciones de eslint, stylelint, prettier, commitLint y VSCode para proyectos React o Vue.
+> - Comando `anl git`: Genera configuración local de git con funciones opcionales: creación de ramas estándar gitflow, temas de mensajes git commit y configuración de comandos personalizados de git.
 
-```json
-{
-	"swaggerConfig": [
-		{
-			"url": "./data/df.json",
-			"apiListFileName": "df.ts",
-			"responseModelTransform": {
-				"type": "wrap",
-				"dataField": "data",
-				"wrapperFields": {
-					"success": "boolean",
-					"code": "number",
-					"message": "string",
-					"data": "T"
-				}
-			}
-		}
-	]
-}
-```
+## Características
 
-**Configuration Description**
-
-| Field           | Type                     | Required | Description                                                       |
-| --------------- | ------------------------ | -------- | ----------------------------------------------------------------- |
-| `type`          | `"wrap"`                 | Yes      | Transformation type, fixed as `"wrap"`                            |
-| `dataField`     | `string`                 | No       | Field name where original data is placed, defaults to `"data"`    |
-| `wrapperFields` | `Record<string, string>` | Yes      | Wrapper field definitions, key is field name, value is field type |
-
-**Transformed Type**
-
-```typescript
-declare namespace ApiUserCurrent_GET {
-	interface Response {
-		success?: boolean;
-		code?: number;
-		message?: string;
-		data?: import('../models/users-entity-dto').UsersEntityDto;
-	}
-}
-```
-
-**Usage Example**
-
-```typescript
-import { apiUserCurrent_GET } from './api/df';
-
-const response = await apiUserCurrent_GET();
-// response type is:
-// {
-//   success?: boolean;
-//   code?: number;
-//   message?: string;
-//   data?: UsersEntityDto;
-// }
-
-if (response.success && response.data) {
-	console.log(response.data.username);
-}
-```
-
-##### Scenario 2: Remove Existing Response Model (unwrap)
-
-**Use Case**
-
-When Swagger definitions include a response wrapper, but you want to use the internal data type directly.
-
-**Problem Example**
-
-Swagger definition includes `ResultMessageBoolean` response wrapper:
-
-```json
-{
-	"paths": {
-		"/op/trade/refund_order/createOrder": {
-			"post": {
-				"responses": {
-					"200": {
-						"content": {
-							"*/*": {
-								"schema": {
-									"$ref": "#/components/schemas/ResultMessageBoolean"
-								}
-							}
-						}
-					}
-				}
-			}
-		}
-	},
-	"components": {
-		"schemas": {
-			"ResultMessageBoolean": {
-				"type": "object",
-				"properties": {
-					"success": { "type": "boolean" },
-					"msg": { "type": "string" },
-					"code": { "type": "integer" },
-					"timestamp": { "type": "integer" },
-					"data": { "type": "boolean" }
-				}
-			}
-		}
-	}
-}
-```
-
-Generated type (with response model):
-
-```typescript
-declare namespace OpTradeRefundOrderCreateorder_POST {
-	type Body = import('../models/refund-order-create-dto').RefundOrderCreateDTO;
-	type Response = import('../models/result-message-boolean').ResultMessageBoolean;
-}
-```
-
-Desired type (only data field):
-
-```typescript
-declare namespace OpTradeRefundOrderCreateorder_POST {
-	type Body = import('../models/refund-order-create-dto').RefundOrderCreateDTO;
-	type Response = boolean;
-}
-```
-
-**Solution**
-
-Add `unwrap` type response model transformation in configuration:
-
-```json
-{
-	"swaggerConfig": [
-		{
-			"url": "./data/op.json",
-			"apiListFileName": "op.ts",
-			"responseModelTransform": {
-				"type": "unwrap",
-				"dataField": "data"
-			}
-		}
-	]
-}
-```
-
-**Configuration Description**
-
-| Field       | Type       | Required | Description                                 |
-| ----------- | ---------- | -------- | ------------------------------------------- |
-| `type`      | `"unwrap"` | Yes      | Transformation type, fixed as `"unwrap"`    |
-| `dataField` | `string`   | No       | Field name to extract, defaults to `"data"` |
-
-**Transformed Type**
-
-```typescript
-declare namespace OpTradeRefundOrderCreateorder_POST {
-	type Body = import('../models/refund-order-create-dto').RefundOrderCreateDTO;
-	type Response = boolean;
-}
-```
-
-**More Examples**
-
-Example 1: Extract paginated data
-
-```typescript
-// Original type:
-type Response = import('../models/result-message-ipage-refund-order-query-vo').ResultMessageIPageRefundOrderQueryVO
-
-// Configuration:
-{
-  "responseModelTransform": {
-    "type": "unwrap",
-    "dataField": "data"
-  }
-}
-
-// Transformed:
-type Response = import('../models/ipage-refund-order-query-vo').IPageRefundOrderQueryVO
-```
-
-Example 2: Extract custom field
-
-If the response model's data field is not `data`, but `result`:
-
-```json
-{
-	"responseModelTransform": {
-		"type": "unwrap",
-		"dataField": "result"
-	}
-}
-```
-
-##### Scenario 3: Replace Response Model (replace)
-
-**Use Case**
-
-When you want to completely replace the original response type with a custom generic type or other types.
-
-**Problem Example**
-
-Original response type:
-
-```typescript
-type Response = import('../models/activity-response-dto-ilist-service-response').ActivityResponseDTOIListServiceResponse;
-```
-
-Desired type:
-
-```typescript
-type Response = ApiResponse<ActivityData>;
-```
-
-**Solution**
-
-Add `replace` type response model transformation in configuration:
-
-```json
-{
-	"swaggerConfig": [
-		{
-			"url": "./data/sau.json",
-			"apiListFileName": "sau.ts",
-			"responseModelTransform": {
-				"type": "replace",
-				"wrapperType": "ApiResponse<T>"
-			}
-		}
-	]
-}
-```
-
-**Configuration Description**
-
-| Field         | Type        | Required | Description                               |
-| ------------- | ----------- | -------- | ----------------------------------------- |
-| `type`        | `"replace"` | Yes      | Transformation type, fixed as `"replace"` |
-| `wrapperType` | `string`    | Yes      | Replacement type string                   |
-
-**Transformed Type**
-
-```typescript
-declare namespace ApiActivityServicevisitServiceVisitId_GET {
-	type Response = ApiResponse<T>;
-}
-```
-
-**Notes**
-
-- `wrapperType` can be any TypeScript type string
-- If using generic types (like `ApiResponse<T>`), ensure the type is defined in your project
-- Usually need to define custom types in `api-type.d.ts`:
-
-```typescript
-// apps/api/api-type.d.ts
-type ApiResponse<T> = {
-	code: number;
-	message: string;
-	data: T;
-	success: boolean;
-};
-```
-
-##### Complete Configuration Example
-
-```json
-{
-	"saveTypeFolderPath": "apps/types",
-	"saveApiListFolderPath": "apps/api/",
-	"saveEnumFolderPath": "apps/enums",
-	"importEnumPath": "../../enums",
-	"requestMethodsImportPath": "./fetch",
-	"formatting": {
-		"indentation": "\t",
-		"lineEnding": "\n"
-	},
-	"enmuConfig": {
-		"erasableSyntaxOnly": false,
-		"varnames": "enum-varnames",
-		"comment": "enum-descriptions"
-	},
-	"swaggerConfig": [
-		{
-			"url": "./data/op.json",
-			"apiListFileName": "op.ts",
-			"publicPrefix": "/forward",
-			"dataLevel": "serve",
-			"parameterSeparator": "_",
-			"responseModelTransform": {
-				"type": "unwrap",
-				"dataField": "data"
-			}
-		},
-		{
-			"url": "./data/df.json",
-			"apiListFileName": "df.ts",
-			"publicPrefix": "/api",
-			"dataLevel": "serve",
-			"parameterSeparator": "_",
-			"responseModelTransform": {
-				"type": "wrap",
-				"dataField": "data",
-				"wrapperFields": {
-					"success": "boolean",
-					"code": "number",
-					"message": "string",
-					"data": "T"
-				}
-			}
-		},
-		{
-			"url": "./data/sau.json",
-			"apiListFileName": "sau.ts",
-			"publicPrefix": "/api",
-			"dataLevel": "serve",
-			"parameterSeparator": "_",
-			"responseModelTransform": {
-				"type": "replace",
-				"wrapperType": "CustomApiResponse"
-			}
-		}
-	]
-}
-```
-
-##### Common Questions
-
-**Q1: Can different interfaces use different transformations?**
-
-A: Currently, transformation configuration is per Swagger service. If you need different transformations for different interfaces in the same Swagger file, you can:
-
-1. Split the Swagger into multiple files
-2. Use `includeInterface` and `excludeInterface` to configure different Swagger services for different interface groups
-
-**Q2: What if unwrap transformation fails?**
-
-A: unwrap transformation requires:
-
-1. Response type must be a `$ref` reference type (not an inline object)
-2. The referenced schema must contain the specified `dataField` (defaults to `data`)
-3. If transformation fails, the original type will be kept unchanged, and a warning will be logged
-
-**Q3: What if the original type is an object when using wrap transformation?**
-
-A: If the original response type is an inline object (with multiple fields), wrap transformation will use the entire object as the value of the `data` field.
-
-**Q4: What happens if responseModelTransform is not configured?**
-
-A: If not configured, the generated types will exactly match the Swagger definitions without any transformation.
-
-**Q5: Can I configure a default transformation globally?**
-
-A: Yes, you can configure `responseModelTransform` at the root level outside of `swaggerConfig`, and all services without configuration will inherit it:
-
-```json
-{
-	"responseModelTransform": {
-		"type": "unwrap",
-		"dataField": "data"
-	},
-	"swaggerConfig": [
-		{
-			"url": "./data/op.json",
-			"apiListFileName": "op.ts"
-			// Will use global configuration
-		},
-		{
-			"url": "./data/df.json",
-			"apiListFileName": "df.ts",
-			"responseModelTransform": {
-				"type": "wrap",
-				"dataField": "data",
-				"wrapperFields": {
-					"success": "boolean",
-					"data": "T"
-				}
-			}
-			// Will override global configuration
-		}
-	]
-}
-```
-
-##### Best Practices
-
-**1. Unified Response Model Standards**
-
-If your backend APIs use a unified response format, it's recommended to:
-
-- Use `wrap` transformation for Swagger without response models
-- Use `unwrap` transformation for Swagger with different response models
-- Ultimately maintain consistent response types for all APIs
-
-**2. Use with api-type.d.ts**
-
-Define unified response types in `apps/api/api-type.d.ts`:
-
-```typescript
-type ResponseModel<T> = {
-	code: number;
-	message: string;
-	data: T;
-	success: boolean;
-};
-```
-
-Then use consistently in code:
-
-```typescript
-export const apiUserCurrent_GET = (params?: IRequestFnParams) => GET<ResponseModel<UsersEntityDto>>(`/api/user/current`, { ...params }, 'serve');
-```
-
-**3. Progressive Migration**
-
-If the project is already using old type definitions, it's recommended to:
-
-1. First configure response model transformation for new Swagger services
-2. Gradually migrate old services
-3. Use version control tools to ensure changes are reversible
-
-##### Technical Details
-
-**Transformation Timing**
-
-Response model transformation occurs during the type generation phase, the specific process:
-
-1. Parse Swagger/OpenAPI documentation
-2. Parse response types
-3. Apply `responseModelTransform` configuration
-4. Generate final TypeScript type definition files
-
-**Supported Response Types**
-
-- ✅ `$ref` reference types (e.g., `#/components/schemas/ResultMessageBoolean`)
-- ✅ Inline object types (e.g., `{ type: 'object', properties: {...} }`)
-- ✅ Primitive types (e.g., `string`, `number`, `boolean`)
-- ✅ Array types (e.g., `Array<T>`)
-- ✅ Union types (e.g., `string | number`)
-
-**Unsupported Scenarios**
-
-- ❌ Unwrap transformation for inline object types (cannot extract fields from schema)
-- ❌ Dynamic field extraction (must explicitly specify `dataField`)
-
-### Notes
-
-1. Ensure the Swagger JSON documentation address is accessible
-2. Paths in the configuration file need to be relative to the project root directory
-3. Generated files will overwrite existing files with the same name (but `config.ts`, `error-message.ts`, `fetch.ts`, `api-type.d.ts` will not be overwritten if they already exist)
-4. It's recommended to add generated files to version control
-5. When using multiple Swagger servers, ensure each server's `apiListFileName` is unique to avoid file overwriting
-6. When configuring multiple servers, type definitions and enums will be merged. If different servers have types with the same name, conflicts may occur
-7. Server-level configuration (`dataLevel`, `parameterSeparator`, `includeInterface`, `excludeInterface`, `modulePrefix`, `responseModelTransform`) will override global configuration
-8. `includeInterface` and `excludeInterface` cannot be configured simultaneously. If both are configured, `includeInterface` will be prioritized
-9. When using `responseModelTransform`, ensure the configuration is correct, otherwise it may cause type generation errors
-10. `unwrap` transformation requires the response type to be a `$ref` reference type and contain the specified `dataField`
-
-### Common Issues
-
-1. **Generated type file formatting fails**
-   - Check if prettier is installed
-   - Confirm if there's a prettier configuration file in the project root directory
-   - Check if the `formatting` configuration is correct
-
-2. **Request function import path error**
-   - Check if the `requestMethodsImportPath` configuration is correct
-   - Confirm if the request method file exists
-
-3. **When to use `modulePrefix`?**
-   - When your APIs need to be accessed through a reverse proxy or gateway
-   - For example: Swagger defines `/api/user`, but the actual request needs to be `/gateway/api/user`
-   - Set `modulePrefix: "/gateway"` to achieve this
-
-4. **What's the difference between `publicPrefix` and `modulePrefix`?**
-   - `publicPrefix`: Removes prefix from interface paths, only affects generated function names
-     - Example: `/api/user/list` after removing `/api`, function name becomes `userListGet`
-   - `modulePrefix`: Adds prefix to request paths, affects actual request URLs
-     - Example: `/api/user/list` after adding `/forward`, request URL becomes `/forward/api/user/list`
-
-5. **How to configure different `dataLevel` for multiple servers?**
-
-   ```json
-   {
-   	"dataLevel": "serve",
-   	"swaggerConfig": [
-   		{
-   			"url": "http://old-api.com/swagger.json",
-   			"dataLevel": "axios",
-   			"apiListFileName": "old-api.ts"
-   		},
-   		{
-   			"url": "http://new-api.com/swagger.json",
-   			"apiListFileName": "new-api.ts"
-   		}
-   	]
-   }
-   ```
-
-   - `old-api.ts` uses `dataLevel: "axios"`
-   - `new-api.ts` uses the global `dataLevel: "serve"`
-
-6. **How to configure different `dataLevel` for individual interfaces?**
-
-   ```json
-   {
-   	"dataLevel": "serve",
-   	"swaggerConfig": [
-   		{
-   			"url": "http://api.com/swagger.json",
-   			"apiListFileName": "api.ts",
-   			"dataLevel": "data",
-   			"includeInterface": [
-   				{
-   					"path": "/api/user/detail",
-   					"method": "get",
-   					"dataLevel": "axios"
-   				},
-   				{
-   					"path": "/api/user/list",
-   					"method": "get"
-   				}
-   			]
-   		}
-   	]
-   }
-   ```
-
-   - `/api/user/detail` uses interface-level `dataLevel: "axios"` (highest priority)
-   - `/api/user/list` uses server-level `dataLevel: "data"`
-   - Other server interfaces use global `dataLevel: "serve"`
-
-7. **How to generate only specific interfaces?**
-   - Use `includeInterface` configuration:
-     ```json
-     {
-     	"swaggerConfig": [
-     		{
-     			"url": "http://api.com/swagger.json",
-     			"includeInterface": [
-     				{ "path": "/api/user", "method": "get" },
-     				{ "path": "/api/user/{id}", "method": "post" }
-     			]
-     		}
-     	]
-     }
-     ```
-   - Or use `excludeInterface` to exclude unwanted interfaces
-
-8. **What if generated files are overwritten?**
-   - Files like `config.ts`, `error-message.ts`, `fetch.ts`, `api-type.d.ts` are only generated when they don't exist
-   - API list files and type files are regenerated each time
-   - It's recommended to add generated files to version control for easy tracking of changes
+- `anl type`
+  - 🚀 Análisis automático de documentos Swagger JSON
+  - 📦 Generación de archivos de definición de tipos TypeScript
+  - 🔄 Generación de funciones de solicitud API con seguridad de tipos
+  - 🎯 Soporte para parámetros de ruta, parámetros de consulta y cuerpo de solicitud
+  - 📝 Generación automática de definiciones de tipos enum
+  - 🎨 Soporte para formateo de código
+  - ⚡️ Soporte para carga de archivos
+  - 🛠 Opciones de generación de código configurables
+  - 🌐 Soporte para configuración de múltiples servidores Swagger
+  - 🔧 Soporte para métodos HTTP como OPTIONS, HEAD, SEARCH
 
-9. **How to use response model transformation?**
-   - See [Response Model Transform](#response-model-transform) section
-   - Supports `unwrap` (extract), `wrap` (add), `replace` (replace) three transformation modes
-   - Can be configured globally or individually for each server
+- `anl lint`
+  - 🔍 Configuración de varias herramientas lint con un solo clic
+  - 🎨 Automatización de configuración ESLint
+  - 🎯 Configuración de formateo Prettier
+  - 🔄 Especificaciones de commits CommitLint
+  - 📦 Configuración del editor VSCode
 
-10. **What if response model transformation fails?**
-    - Check if configuration items are correct, especially the `type` field
-    - `unwrap` mode requires the response type to be a `$ref` reference type
-    - `wrap` mode requires configuration of `wrapperFields` field
-    - `replace` mode requires configuration of `wrapperType` field
-    - Check console logs, which usually output detailed error information
+- `anl git`
+  - 🔍 Instalación opcional de múltiples funciones
+  - 🎨 Creación de ramas estándar git flow
+  - 🎯 Configuración automática de temas que cumplen con las especificaciones CommitLint
+  - 🔄 Proporciona configuración de comandos personalizados de git y punto de entrada
+  - 📦 Generación automatizada con 0 configuración
 
-11. **Can different interfaces use different response model transformations?**
-    - Currently, transformation configuration is per Swagger service granularity
-    - If different transformations are needed for different interfaces in the same Swagger file, you can:
-      1. Split the Swagger into multiple files
-      2. Use `includeInterface` and `excludeInterface` to configure different Swagger services for different interface groups
+---
 
-# `anl lint` Command Usage
+# Aperçu des fonctionnalités
 
-> Provides **interactive multi-select** configuration for various lint tools in frontend projects, including:
+> an-cli est un outil de ligne de commande frontend qui inclut les commandes suivantes :
 >
-> - ESLint - JavaScript/TypeScript code linting
-> - Stylelint - CSS/SCSS/Less style linting
-> - Prettier - Code formatting
-> - CommitLint - Git commit message standards
-> - VSCode - Editor configuration
-
-### Usage Method
-
-```bash
-$ anl lint
-```
-
-After executing the command, an interactive multi-select interface will appear where you can choose the tools to install:
-
-```
-? Select the linting tools to install (multi-select):
-❯◯ ESLint - JavaScript/TypeScript linter
- ◯ Stylelint - CSS/SCSS/Less linter
- ◯ Commitlint - Git commit message linter
- ◯ Prettier - Code formatter
- ◯ VSCode - Editor settings
-```
-
-Use **spacebar** to select/deselect, **Enter** to confirm.
-
-### Configuration Details
-
-#### 1. ESLint Configuration
-
-- Automatically installs required dependencies
-- Supports React/Vue frameworks (you'll be prompted to choose a framework if selected)
-- Automatically generates `.eslintrc.js` and `.eslintignore`
-- Integrates TypeScript support
-
-#### 2. Stylelint Configuration
+> - Commande `anl type` : Un outil de ligne de commande qui génère automatiquement des définitions de types TypeScript et des fonctions de requête API basées sur Swagger JSON.
+> - Commande `anl lint` : Génère les configurations eslint, stylelint, prettier, commitLint et VSCode pour les projets React ou Vue
+> - Commande `anl git` : Génère la configuration locale Git avec des fonctionnalités optionnelles : création de branches selon le standard gitflow, thèmes de messages git commit, configuration de commandes git personnalisées
 
-- Automatically installs stylelint related dependencies
-- Supports Less/Sass preprocessors (you'll be prompted to choose a preprocessor if selected)
-- Generates `.stylelintrc.js` configuration file
-- Integrates Prettier support
+## Caractéristiques
 
-#### 3. Prettier Configuration
-
-- Automatically installs prettier related dependencies
-- Generates `.prettierrc.js` configuration file
-- Default configuration includes:
-  - Line width: 80
-  - Tab indentation
-  - Use single quotes
-  - Arrow function parentheses
-  - Other code style standards
-
-#### 4. CommitLint Configuration
-
-- Installs commitlint related dependencies
-- Configures husky git hooks
-- Generates `commitlint.config.js`
-- Standardizes git commit messages
-
-#### 5. VSCode Configuration
-
-- Creates `.vscode/settings.json`
-- Configures editor auto-formatting
-- Sets default formatting tools
-- Supports updating existing configuration files
+- `anl type`
+  - 🚀 Analyse automatique des documents Swagger JSON
+  - 📦 Génération de fichiers de définition de types TypeScript
+  - 🔄 Génération de fonctions de requête API type-safe
+  - 🎯 Support des paramètres de chemin, de requête et de corps
+  - 📝 Génération automatique de définitions de types enum
+  - 🎨 Support du formatage de code
+  - ⚡️ Support du téléchargement de fichiers
+  - 🛠 Options de génération de code configurables
+  - 🌐 Support de la configuration de plusieurs serveurs Swagger
+  - 🔧 Support des méthodes HTTP OPTIONS, HEAD, SEARCH, etc.
 
-### Usage Examples
+- `anl lint`
+  - 🔍 Configuration en un clic de divers outils lint
+  - 🎨 Configuration ESLint automatisée
+  - 🎯 Configuration de formatage Prettier
+  - 🔄 Normes de commit CommitLint
+  - 📦 Configuration de l'éditeur VSCode
 
-1. **Install ESLint and Prettier Only**
-   - Select ESLint and Prettier
-   - If ESLint is selected, you'll be prompted to choose a framework (React/Vue)
-   - After installation, your project will have `.eslintrc.js` and `.prettierrc.js`
+- `anl git`
+  - 🔍 Installation optionnelle de plusieurs fonctionnalités
+  - 🎨 Création de branches selon le standard git flow
+  - 🎯 Configuration automatique de thèmes conformes aux normes CommitLint
+  - 🔄 Fournit la configuration et le point d'entrée pour les commandes git personnalisées
+  - 📦 Génération automatisée avec configuration zéro
 
-2. **Full Configuration**
-   - Select all options
-   - Complete the framework and preprocessor selection prompts
-   - Your project will have a complete code standards system configured
+---
 
-# `anl git` Command
+# 機能概要
 
-### Feature Overview
+> an-cli はフロントエンド開発用コマンドラインツールで、以下のコマンドを含みます：
+>
+> - `anl type` コマンド：Swagger JSON に基づいて TypeScript 型定義と API リクエスト関数を自動生成するコマンドラインツール。
+> - `anl lint` コマンド：React または Vue プロジェクト用の eslint、stylelint、prettier、commitLint、VSCode 関連設定を生成
+> - `anl git` コマンド：Git ローカル設定を生成し、オプション機能として gitflow 標準ブランチ作成、git commit メッセージテーマ、git カスタムコマンド設定を提供
 
-- Through interactive multi-selection, applies the following Git capabilities to the current repository:
-  - gitflow standard branch creation
-    - Copies `.gitscripts/`, `.gitconfig`, `.commit-type.cjs` to the project (only when missing)
-    - Adds executable permissions to `.gitscripts/random-branch.sh`
-    - Executes `git config --local include.path ../.gitconfig`
-  - Automatic commit subject setting
-    - Copies `.githooks/commit-msg` and sets it as executable
-    - Executes `git config core.hooksPath .githooks`
-  - Custom git commands
-    - Adds `.gitattributes` to the project (only when missing)
+## 機能特徴
 
-### Usage Method
+- `anl type`
+  - 🚀 Swagger JSON ドキュメントの自動解析
+  - 📦 TypeScript 型定義ファイルの生成
+  - 🔄 型安全な API リクエスト関数の生成
+  - 🎯 パスパラメータ、クエリパラメータ、リクエストボディのサポート
+  - 📝 列挙型定義の自動生成
+  - 🎨 コードフォーマットのサポート
+  - ⚡️ ファイルアップロードのサポート
+  - 🛠 カスタマイズ可能なコード生成オプション
+  - 🌐 複数の Swagger サーバー設定のサポート
+  - 🔧 OPTIONS、HEAD、SEARCH などの HTTP メソッドのサポート
 
-```bash
-$ anl git
-```
+- `anl lint`
+  - 🔍 各種 lint ツールのワンクリック設定
+  - 🎨 ESLint 設定の自動化
+  - 🎯 Prettier フォーマット設定
+  - 🔄 CommitLint コミット規約
+  - 📦 VSCode エディタ設定
 
-Select one or more features in the prompts. Files are only created when they don't exist; existing files are preserved.
+- `anl git`
+  - 🔍 複数の機能を選択してインストール
+  - 🎨 標準的な git flow ブランチ作成
+  - 🎯 CommitLint 規約に準拠したテーマの自動設定
+  - 🔄 git カスタムコマンド設定とエントリーポイントの提供
+  - 📦 ゼロ設定の自動生成
 
-### Notes
+---
 
-- Please run within a Git repository.
-- If automatically executed git config fails, please execute manually:
+# Обзор функций
 
-```bash
-git config --local include.path ../.gitconfig
-git config core.hooksPath .githooks
-```
+> an-cli — это CLI-инструмент для фронтенда, включающий следующие команды:
+>
+> - Команда `anl type`: CLI-инструмент для автоматической генерации определений типов TypeScript и функций API-запросов на основе Swagger JSON.
+> - Команда `anl lint`: Генерирует конфигурации eslint, stylelint, prettier, commitLint, VSCode для проектов react или vue
+> - Команда `anl git`: Генерирует локальную конфигурацию git с опциональными функциями: создание стандартных веток gitflow, темы сообщений git commit, конфигурация пользовательских команд git
 
-# License
+## Особенности функций
 
-ISC License
+- `anl type`
+  - 🚀 Автоматически парсит Swagger JSON документы
+  - 📦 Генерирует файлы определений типов TypeScript
+  - 🔄 Генерирует типобезопасные функции API-запросов
+  - 🎯 Поддерживает параметры пути, запроса и тела запроса
+  - 📝 Автоматически генерирует определения типов enum
+  - 🎨 Поддерживает форматирование кода
+  - ⚡️ Поддерживает загрузку файлов
+  - 🛠 Настраиваемые опции генерации кода
+  - 🌐 Поддерживает конфигурации нескольких Swagger серверов
+  - 🔧 Поддерживает HTTP методы OPTIONS, HEAD, SEARCH и другие
 
-# Contributing
+- `anl lint`
+  - 🔍 Настройка различных инструментов линтинга в один клик
+  - 🎨 Автоматизация конфигурации ESLint
+  - 🎯 Конфигурация форматирования Prettier
+  - 🔄 Стандарты коммитов CommitLint
+  - 📦 Конфигурация редактора VSCode
 
-Welcome to submit [Issues](https://github.com/bianliuzhu/an-cli/issues) and [Pull Requests](https://github.com/bianliuzhu/an-cli/pulls)!
+- `anl git`
+  - 🔍 Множественные опциональные функции для установки
+  - 🎨 Создание стандартных веток git flow
+  - 🎯 Автоматическая настройка тем, соответствующих стандартам CommitLint
+  - 🔄 Предоставляет конфигурацию пользовательских команд git и точки входа
+  - 📦 Автоматическая генерация с нулевой конфигурацией