ts-openapi-codegen 2.1.0-beta.2 → 2.1.0-beta.4

package/README.md

@@ -28,6 +28,8 @@
 - Supports tsc and @babel/plugin-transform-typescript
 - Supports customization names of models
 - Supports external references using [`swagger-parser`](https://github.com/APIDevTools/swagger-parser/)
+- Supports strict OpenAPI diagnostics with JSON reports (`--strict-openapi`, `--report-file`)
+- Supports generator plugins (`plugins`) including built-in `x-typescript-type`
 - Supports binary request/response generation (`format: binary` -> `Blob`)
 
 ## Install
@@ -82,6 +84,8 @@ openapi generate --input ./spec.json --output ./dist
 | `--modelsMode` | - | string | `interfaces` | Models generation mode: `interfaces` or `classes` |
 | `--useHistory` | - | boolean | `false` | Apply diff report annotations during generation |
 | `--diffReport` | - | string | `./openapi-diff-report.json` | Path to diff report JSON |
+| `--useProjectPrettier` | - | boolean | `false` | Use the project’s Prettier config to format generated code |
+| `--useEslintFix` | - | boolean | `false` | Run ESLint `--fix` on generated files after write (requires `eslint` in the project) |
 
 **Examples:**
 ```bash
@@ -244,7 +248,9 @@ Instead of passing all options via CLI, you can use a configuration file. Create
         "enabled": true,
         "confidence": 1,
         "types": ["RENAME", "TYPE_COERCION"]
-    }
+    },
+    "plugins": ["./plugins/custom-type.plugin.cjs"],
+    "customExecutorPath": "./custom/createExecutorAdapter.ts"
 }
 ```
 
@@ -295,6 +301,7 @@ Instead of passing all options via CLI, you can use a configuration file. Create
 | `useUnionTypes` | boolean | `false` | Use union types instead of enums |
 | `excludeCoreServiceFiles` | boolean | `false` | Exclude core and service files generation |
 | `request` | string | - | Path to custom request file |
+| `plugins` | string[] | `[]` | Paths to generator plugins |
 | `customExecutorPath` | string | - | Path to custom `createExecutorAdapter` module |
 | `interfacePrefix` | string | `I` | Prefix for interface models |
 | `enumPrefix` | string | `E` | Prefix for enum models |
@@ -316,6 +323,14 @@ Instead of passing all options via CLI, you can use a configuration file. Create
 
 **Note:** You can use the `init` command to generate a template configuration file.
 
+### Plugins
+
+Generator plugins can override schema type mapping (for example via `x-typescript-type`) and extend generation behavior.
+
+- Configuration key: `plugins` (array of module paths)
+- Supported module formats: CJS, ESM, and TS (when runtime supports TS imports)
+- Full guide: [docs/plugins.md](./docs/plugins.md)
+
 ## Examples
 
 ### Using CLI commands

package/README.rus.md

@@ -28,6 +28,8 @@
 - Поддерживает tsc и @babel/plugin-transform-typescript
 - Поддерживает кастомизацию имен моделей
 - Поддерживает внешние ссылки с помощью [`swagger-parser`](https://github.com/APIDevTools/swagger-parser/)
+- Поддерживает strict-диагностику OpenAPI с JSON-отчетом (`--strict-openapi`, `--report-file`)
+- Поддерживает плагины генератора (`plugins`), включая встроенный `x-typescript-type`
 - Поддерживает генерацию бинарных request/response (`format: binary` -> `Blob`)
 
 ## Установка
@@ -81,6 +83,8 @@ openapi generate --input ./spec.json --output ./dist
 | `--modelsMode` | - | string | `interfaces` | Режим генерации моделей: `interfaces` или `classes` |
 | `--useHistory` | - | boolean | `false` | Применять diff-отчёт при генерации |
 | `--diffReport` | - | string | `./openapi-diff-report.json` | Путь к diff-отчёту |
+| `--useProjectPrettier` | - | boolean | `false` | Форматировать сгенерированный код конфигом Prettier проекта |
+| `--useEslintFix` | - | boolean | `false` | Запускать ESLint `--fix` для сгенерированных файлов после записи (нужен `eslint` в проекте) |
 
 **Примеры:**
 ```bash
@@ -243,7 +247,9 @@ openapi analyze-diff --input ./openapi/spec.yaml --git HEAD~1
         "enabled": true,
         "confidence": 1,
         "types": ["RENAME", "TYPE_COERCION"]
-    }
+    },
+    "plugins": ["./plugins/custom-type.plugin.cjs"],
+    "customExecutorPath": "./custom/createExecutorAdapter.ts"
 }
 ```
 
@@ -294,6 +300,7 @@ openapi analyze-diff --input ./openapi/spec.yaml --git HEAD~1
 | `useUnionTypes` | boolean | `false` | Использовать union типы вместо enums |
 | `excludeCoreServiceFiles` | boolean | `false` | Исключить генерацию core и сервисных файлов |
 | `request` | string | - | Путь к пользовательскому файлу запросов |
+| `plugins` | string[] | `[]` | Пути к плагинам генератора |
 | `customExecutorPath` | string | - | Путь к пользовательскому модулю `createExecutorAdapter` |
 | `interfacePrefix` | string | `I` | Префикс для интерфейсов моделей |
 | `enumPrefix` | string | `E` | Префикс для enum моделей |
@@ -315,6 +322,14 @@ openapi analyze-diff --input ./openapi/spec.yaml --git HEAD~1
 
 **Примечание:** Вы можете использовать команду `init` для генерации шаблона файла конфигурации.
 
+### Плагины
+
+Плагины генератора позволяют переопределять маппинг типов схем (например через `x-typescript-type`) и расширять поведение генерации.
+
+- Ключ конфигурации: `plugins` (массив путей к модулям)
+- Поддерживаемые форматы модулей: CJS, ESM и TS (если рантайм поддерживает импорт TS)
+- Подробная документация: [docs/plugins.md](./docs/plugins.md)
+
 ## Примеры
 
 ### Использование CLI команд

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "ts-openapi-codegen",
-    "version": "2.1.0-beta.2",
+    "version": "2.1.0-beta.4",
     "description": "Library that generates Typescript clients based on the OpenAPI specification. It bases on openapi-typescript-codegen",
     "author": "Alexey Zverev",
     "homepage": "https://github.com/ozonophore/openapi-codegen.git",