@openapi-qraft/cli 2.3.2 → 2.4.1

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @openapi-qraft/cli
 
+## 2.4.1
+
+### Patch Changes
+
+- @openapi-qraft/plugin@2.4.1
+- @openapi-qraft/tanstack-query-react-plugin@2.4.1
+- @openapi-qraft/openapi-typescript-plugin@1.2.14
+
+## 2.4.0
+
+### Minor Changes
+
+- cc314c3: Added support for Redocly configuration, allowing to generate multiple API clients in a single command.
+
+### Patch Changes
+
+- Updated dependencies [cc314c3]
+  - @openapi-qraft/plugin@2.4.0
+  - @openapi-qraft/openapi-typescript-plugin@1.2.13
+  - @openapi-qraft/tanstack-query-react-plugin@2.4.0
+
 ## 2.3.2
 
 ### Patch Changes

package/README.md

@@ -21,27 +21,29 @@ npm install -g @openapi-qraft/cli
 ```
 Usage: openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript [input] [options]
 
-Generate TypeScript types from OpenAPI 3.x Document. Based on "openapi-typescript" (https://github.com/drwpow/openapi-typescript/)
+Generate a type-safe TanStack Query client for React from an OpenAPI Document.
 
 Arguments:
-  input                                           Input OpenAPI Document file path, URL (json, yml) (default: null)
+  input                                            Input OpenAPI Document file path, URL (json, yml) (default: null)
 
 Options:
   -o, --output-dir <path>                          Output directory for generated services
   -rm, --clean                                     Clean output directory before generating services
-  --filter-services <glob-patterns...>             Filter services to be generated by glob pattern. Eg: "/user/**,/post/**". See NPM `micromatch` package for more details.
-  --operation-predefined-parameters <patterns...>  Predefined parameters for services. The specified services parameters will be optional. Eg: "/**:header.x-monite-version,query.x-api-key" or "get
-                                                   /**:header.x-monite-entity-id"
-  --operation-name-modifier <patterns...>          Modifies operation names using a pattern. Use the `==>` operator to separate the regular expression (left) and the substitution string (right). For
-                                                   example: "post /**:[A-Za-z]+Id ==> createOne"
+  --filter-services <glob-patterns...>             Filter services to be generated using glob patterns. Example: "/user/**,/post/**". For more details, see the NPM `micromatch` package documentation.
+  --operation-predefined-parameters <patterns...>  Predefined parameters for services. The specified service parameters will be optional. Example: "/**:header.x-monite-version,query.x-api-key" or "get /**:header.x-monite-entity-id"
+  --operation-name-modifier <patterns...>          Modifies operation names using a pattern. Use the `==>` operator to separate the regular expression (left) and the substitution string (right). For example: "post /**:[A-Za-z]+Id ==> createOne"
   --postfix-services <string>                      Postfix to be added to the generated service name (eg: Service)
   --service-name-base <endpoint[<index>] | tags>   Use OpenAPI Operation `endpoint[<index>]` path part (e.g.: "/0/1/2") or `tags` as the base name of the service. (default: "endpoint[0]")
   --file-header <string>                           Header to be added to the generated file (eg: /* eslint-disable */)
-  --openapi-types-import-path <path>               Path to schema types file (.d.ts), eg: "../schema.d.ts"
+  --redocly [config]                               Use the Redocly configuration to generate multiple API clients
+                                                   If the [config] parameter is not specified, the default Redocly configuration will be used: [redocly.yaml | redocly.yml | .redocly.yaml | .redocly.yml].
+                                                   For more information about this option, use the command: --redocly-help
+                                                   Examples: "openapi-qraft --redocly", "openapi-qraft my-api@v1 external-api --redocly", "openapi-qraft --redocly
+                                                   ./my-redocly-config.yaml"
+  --openapi-types-import-path <path>               Path to schema types file (.d.ts), e.g.: "../schema.d.ts"
   --explicit-import-extensions [extension]         All import statements will contain an explicit file extension. Ideal for projects using ECMAScript modules. (choices: ".js", ".ts", preset: ".js")
-  --export-openapi-types [bool]                    Export the OpenAPI schema types from the generated `./index.ts` file (default: true)
-  --operation-generics-import-path <path>          Path to operation generics file (default: "@openapi-qraft/react")
-  --openapi-types-file-name <path>                 OpenAPI Schema types file name, eg: "schema.d.ts" (default: "schema.ts")
+  --export-openapi-types [bool]                    Add an export statement of the generated OpenAPI document types from the `./index.ts' file. Useful for sharing types within your project. (default: true)
+  --openapi-types-file-name <path>                 OpenAPI Schema types file name, e.g.: "schema.d.ts" (default: "schema.ts")
   --enum                                           Export true TS enums instead of unions
   --enum-values                                    Export enum values as arrays.
   --dedupe-enums                                   Dedupe enum types when `--enum` is set
@@ -95,7 +97,8 @@ npx openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript http
       a colon, and a comma-separated list of **operation parameters** to be set as optional.
       More than one predefined parameter option can be specified.
 
-  This most wanted option 💎 allows you to **set default parameters** across multiple endpoints. However, if an endpoint doesn't contain a parameter specified in this option, an error will be displayed. For example:
+  This option 💎 is arguably one of the most awesome features, allowing you to **set default parameters** across multiple endpoints.
+  However, if an endpoint doesn't contain a parameter specified in this option, an error will be displayed. For example:
 
   ```text
   ⚠ Missing predefined parameter 'header' 'x-monite-version' in 'post /files' in '/**'
@@ -108,16 +111,11 @@ npx openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript http
   ```
 
   - Examples:
-
     - `--operation-predefined-parameters '/**:header.x-monite-version'` - set `header.x-monite-version`
       as optional parameters for all services.
     - `--operation-predefined-parameters '/**,!/auth/token:header.x-entity-id'` - set `header.x-entity-id` as optional parameters for all services except `/auth/token`.
     - `--operation-predefined-parameters 'post,put /**:header.x-entity-id'` - set the `Header` record `x-entity-id` as an optional parameter for the `POST` and `PUT` methods.
 
-  > **Note:** In future versions of the library, this feature will be expanded. Not only will it make parameters
-  > optional, but it will also offer typed suggestions for these predefined parameters when creating a client. This enhancement will
-  > further improve type safety and developer experience.
-
 - **`--operation-name-modifier <patterns...>`:** Modifies operation names using a pattern.
 
   - **Pattern syntax:**
@@ -137,14 +135,32 @@ npx openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript http
 
 - **`--explicit-component-exports`:** Enabling this option will export API components as separate type aliases, alongside `components` interface.
 
-- **`--service-name-base <endpoint[<index>] | tags>`:** Use OpenAPI Operation `endpoint[<index>]` path part (e.g.: `/0/1/2`) or `tags` as the base name of the service. _(optional, default: `endpoint[0]`)_.
+- **`--redocly [config]`:** Use the Redocly configuration to generate multiple API clients. If the `[config]` parameter is not specified, the default Redocly configuration will be used: `[redocly.yaml | redocly.yml | .redocly.yaml | .redocly.yml]`. _(optional)_
+
   - Examples:
-    - `--service-name-base endpoint[0]` generates `services/FooService.ts` for the endpoint `/foo/bar/baz`
-    - `--service-name-base endpoint[1]` generates `services/BarService.ts` for the endpoint `/foo/bar/baz`
-    - `--service-name-base endpoint[3]` generates `services/BazService.ts` for the endpoint `/foo/bar/baz` _(if the endpoint is shorter than the index, the last part is used)_
-    - `--service-name-base tags` will generate services based on the OpenAPI Operation tags instead of the endpoint.
-      - If multiple tags are present for the operation, similar services will be created for each tag. Operation with `tags: [Foo, Bar]` will generate `services/FooService.ts` and `services/BarService.ts`.
-      - If there are no tags for the operation, the services will be created under the `default` tag. Operation with empty `tags: []` will generate `services/DefaultService.ts`.
+    - `--redocly` - use the default Redocly configuration file
+    - `--redocly ./my-redocly-config.yaml` - use a custom Redocly configuration file
+    - `openapi-qraft my-api@v1 external-api --redocly` - generate clients for multiple APIs defined in the Redocly configuration
+  - For more information about this option, use the command: `--redocly-help`
+
+- **`--service-name-base <endpoint[<index>] | tags>`:** Use OpenAPI Operation `endpoint[<index>]` path part (e.g.: `/0/1/2`) or `tags` as the base name of the service. _(optional, default: `endpoint[0]`)_.
+  - **`endpoint[<index>]`** - Use the path segment (e.g., `/0/1/2`) as the base name for the service.
+    - Examples:
+      - `--service-name-base endpoint[0]` generates `services/FooService.ts` for the endpoint `/foo/bar/baz`
+      - `--service-name-base endpoint[1]` generates `services/BarService.ts` for the endpoint `/foo/bar/baz`
+      - `--service-name-base endpoint[3]` generates `services/BazService.ts` for the endpoint `/foo/bar/baz` _(if the endpoint is shorter than the index, the last part is used)_
+      - If used `endpoint[<index>]` as the base name, operation names will be generated according to the specified index.
+        - For example:
+          - `--service-name-base endpoint[1]` for the endpoint `/api/bar` generates `get` operation name.
+          - `--service-name-base endpoint[1]` for the endpoint `/api/foo/bar` generates `getBar` operation name.
+  - **`tags`** - Use the OpenAPI Operation `tags` as the base name of the service.
+    - Examples:
+      - `--service-name-base tags` will generate services based on the OpenAPI Operation tags instead of the endpoint.
+        - If multiple tags are present for the operation, similar services will be created for each tag. Operation with `tags: [Foo, Bar]` will generate `services/FooService.ts` and `services/BarService.ts`.
+        - If there are no tags for the operation, the services will be created under the `default` tag. Operation with empty `tags: []` will generate `services/DefaultService.ts`.
+        - If `tags` are used as the base name, operation names will be generated based on the `operationId` from the
+          OpenAPI Operation, or from the path if `operationId` is not provided.
+          You can use `--operation-name-modifier` to customize the operation names.
 - **`--explicit-import-extensions [extension]`**: All import statements will contain an explicit file extension. Ideal for projects using ECMAScript modules
   when TypeScript's _--moduleResolution_ is `node16` or `nodenext`. Choices: `.js`, `.ts`, preset: `.js`. _(optional)_
 - **`--file-header <string>`:** Add a custom header to each generated file, useful for disabling linting rules or adding file
@@ -182,12 +198,14 @@ The following plugins are currently supported:
       - `--openapi-types-import-path '@external-package-types'`
 - **`--operation-generics-import-path <path>`:** Define the path to the operation generics file, allowing for custom
   operation handling _(optional, default: `@openapi-qraft/react`)_.
-- **`--export-openapi-types [bool]`:** Export the OpenAPI schema types from the generated `./index.ts` file. _(optional, default: `true`, if `--plugin openapi-typescript` is used)_
+- **`--export-openapi-types [bool]`:** Add an export statement of the generated OpenAPI document types from the `./index.ts` file. Useful for sharing types within your project. _(optional, default: `true`, if `--plugin openapi-typescript` is used)_
 
 ### `--plugin openapi-typescript` options
 
 - **`--openapi-types-file-name <path>`**: OpenAPI Schema types file name, e.g., `schema.d.ts` (default: `schema.ts`).
 - **`--enum`**: Export true TypeScript enums instead of unions.
+- **`--enum-values`**: Export enum values as arrays.
+- **`--dedupe-enums`**: Dedupe enum types when `--enum` is set.
 - **`-t, --export-type`**: Export top-level `type` instead of `interface`.
 - **`--immutable`**: Generate readonly types.
 - **`--additional-properties`**: Treat schema objects as if `additionalProperties: true` is set.
@@ -199,20 +217,21 @@ The following plugins are currently supported:
 - **`--alphabetize`**: Sort object keys alphabetically.
 - **`--exclude-deprecated`**: Exclude deprecated types.
 - **`--no-blob-from-binary`**: If this option is enabled, `format: binary` fields will not be converted to `Blob` types, preserving the native type. Could be used with `--plugin openapi-typescript` option.
+- **`--explicit-component-exports`**: Enabling this option will export API components as separate type aliases, alongside `components` interface.
 
 ## In-project Setup
 
 Add the following `"scripts"` to your `package.json` file:
 
-```json lines title="package.json"
+```json5 title="package.json"
 {
-  "devDependencies": {
-    "@openapi-qraft/cli": "latest"
+  devDependencies: {
+    '@openapi-qraft/cli': 'latest',
   },
-  "scripts": {
-    "generate-client": "openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript https://raw.githubusercontent.com/swagger-api/swagger-petstore/master/src/main/resources/openapi.yaml --output-dir src/api"
+  scripts: {
+    'generate-client': 'openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript https://raw.githubusercontent.com/swagger-api/swagger-petstore/master/src/main/resources/openapi.yaml --output-dir src/api',
     // ...other scripts
-  }
+  },
 }
 ```
 

package/bin.mjs

@@ -7,4 +7,4 @@
  */
 import { main } from './dist/bin.js';
 
-main();
+main(process.argv);

package/dist/bin.d.ts

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
-export declare function main(): Promise<undefined>;
+import { ParseOptions } from 'commander';
+export declare function main(processArgv: string[], processArgvParseOptions?: ParseOptions): Promise<void>;
 /**
- * Extracts multiple `--plugin <name>` options from the `argv`
- * and returns the filtered `argv` and the list of plugins.
+ * Extracts multiple `--plugin <name>` options from `argv`
+ * and returns both the filtered `argv` and the extracted plugins list.
  */
 export declare function extractArgvPluginOptions(argv: string[]): {
     argv: string[];

package/dist/bin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AAOA,wBAAsB,IAAI,uBA8BzB;AA+BD;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE;;;;;;EAwBtD"}
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AAIA,OAAO,EAAU,YAAY,EAAE,MAAM,WAAW,CAAC;AAGjD,wBAAsB,IAAI,CACxB,WAAW,EAAE,MAAM,EAAE,EACrB,uBAAuB,CAAC,EAAE,YAAY,iBAWvC;AAkED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE;;;;;;EA6BtD"}

package/dist/bin.js

@@ -1,28 +1,34 @@
 #!/usr/bin/env node
-import process from 'node:process';
-import { QraftCommand } from '@openapi-qraft/plugin/lib/QraftCommand';
+import { QraftCommand } from '@openapi-qraft/plugin';
+import { RedoclyConfigCommand } from '@openapi-qraft/plugin/lib/RedoclyConfigCommand';
 import { Option } from 'commander';
 import { builtInPlugins } from './builtInPlugins.js';
-export async function main() {
+export async function main(processArgv, processArgvParseOptions) {
+    const redoclyConfigParseResult = await new RedoclyConfigCommand().parseConfig(qraft, processArgv, processArgvParseOptions);
+    if (redoclyConfigParseResult?.length)
+        return;
+    await qraft(processArgv, processArgvParseOptions);
+}
+async function qraft(processArgv, processArgvParseOptions) {
     const command = new QraftCommand();
-    const { argv, plugins } = extractArgvPluginOptions(process.argv);
+    const { argv, plugins } = extractArgvPluginOptions(processArgv);
     if (plugins) {
         await setupPlugins(command, plugins);
     }
     else {
-        // default - setup tanstack-query-react plugin
+        // Default - set up the tanstack-query-react plugin
         await setupPlugins(command, [
             'tanstack-query-react',
         ]);
-        // option to display help with all available plugins
-        command.addOption(new Option('--plugin <name_1> --plugin <name_2>', `Generator plugins to be used.`)
+        // Option to display help with all available plugins
+        command.addOption(new Option('--plugin <name_1> --plugin <name_2>', `Specifies which generator plugins should be used for code generation`)
             .choices(Object.keys(builtInPlugins))
             .argParser(() => {
-            // Fallback, if plugins parsing went wrong
-            throw new Error('Plugin option must be handled before parsing the command and should not be passed to the commander');
+            // Fallback handler for when plugin parsing fails
+            throw new Error('The plugin option must be processed before command parsing and should not be directly passed to the commander');
         }));
     }
-    return void (await command.parseAsync(argv));
+    await command.parseAsync(argv, processArgvParseOptions);
 }
 async function setupPlugins(command, plugins) {
     const pluginList = [];
@@ -37,15 +43,15 @@ async function setupPlugins(command, plugins) {
     await Promise.all(pluginList.map((plugin) => plugin.postSetupCommand?.(command, plugins)));
 }
 /**
- * Add plugin's usage instructions calling `command.usage(...)`
+ * Adds plugin usage instructions by calling `command.usage(...)`
  */
 function addCommandUsageWithPlugins(command, plugins) {
     const pluginUsage = plugins.map((plugin) => `--plugin ${plugin}`).join(' ');
     command.usage(`${pluginUsage} [input] [options]`);
 }
 /**
- * Extracts multiple `--plugin <name>` options from the `argv`
- * and returns the filtered `argv` and the list of plugins.
+ * Extracts multiple `--plugin <name>` options from `argv`
+ * and returns both the filtered `argv` and the extracted plugins list.
  */
 export function extractArgvPluginOptions(argv) {
     const pluginIndex = argv.indexOf('--plugin');
@@ -57,9 +63,9 @@ export function extractArgvPluginOptions(argv) {
         if (argv[i] === '--plugin') {
             const pluginName = argv.at(i + 1);
             if (!pluginName)
-                throw new Error(`Missing plugin name after '--plugin'`);
+                throw new Error(`A plugin name must be specified after the '--plugin' option`);
             if (pluginName?.startsWith('--'))
-                throw new Error(`Invalid plugin name: '${pluginName}'`);
+                throw new Error(`Invalid plugin name: '${pluginName}'. Plugin names cannot start with '--'`);
             plugins.push(pluginName);
             i++; // Skip next item
         }

package/dist/bin.js.map

@@ -1 +1 @@
-{"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AAEA,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,CAAC,KAAK,UAAU,IAAI;IACxB,MAAM,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IAEnC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,8CAA8C;QAC9C,MAAM,YAAY,CAAC,OAAO,EAAE;YAC1B,sBAAsB;SACmB,CAAC,CAAC;QAE7C,oDAAoD;QACpD,OAAO,CAAC,SAAS,CACf,IAAI,MAAM,CACR,qCAAqC,EACrC,+BAA+B,CAChC;aACE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;aACpC,SAAS,CAAC,GAAG,EAAE;YACd,0CAA0C;YAC1C,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAC;QACJ,CAAC,CAAC,CACL,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,OAAqB,EAAE,OAAiB;IAClE,MAAM,UAAU,GAAyB,EAAE,CAAC;IAE5C,KAAK,MAAM,UAAU,IAAI,OAAO,EAAE,CAAC;QACjC,IAAI,CAAC,CAAC,UAAU,IAAI,cAAc,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,oBAAoB,UAAU,GAAG,CAAC,CAAC;QAErD,UAAU,CAAC,IAAI,CACb,CAAC,MAAM,cAAc,CAAC,UAAyC,CAAC,EAAE,CAAC;aAChE,OAAO,CACX,CAAC;QAEF,0BAA0B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5E,MAAM,OAAO,CAAC,GAAG,CACf,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CACxE,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,0BAA0B,CAAC,OAAqB,EAAE,OAAiB;IAC1E,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,WAAW,oBAAoB,CAAC,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAc;IACrD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7C,IAAI,WAAW,KAAK,CAAC,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAExC,MAAM,YAAY,GAAa,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IAC1D,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,IAAI,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/C,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAClC,IAAI,CAAC,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;YACzE,IAAI,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,yBAAyB,UAAU,GAAG,CAAC,CAAC;YAC1D,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACzB,CAAC,EAAE,CAAC,CAAC,iBAAiB;QACxB,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,OAAO;KACR,CAAC;AACJ,CAAC"}
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,gDAAgD,CAAC;AACtF,OAAO,EAAE,MAAM,EAAgB,MAAM,WAAW,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,WAAqB,EACrB,uBAAsC;IAEtC,MAAM,wBAAwB,GAAG,MAAM,IAAI,oBAAoB,EAAE,CAAC,WAAW,CAC3E,KAAK,EACL,WAAW,EACX,uBAAuB,CACxB,CAAC;IAEF,IAAI,wBAAwB,EAAE,MAAM;QAAE,OAAO;IAE7C,MAAM,KAAK,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAC;AACpD,CAAC;AAED,KAAK,UAAU,KAAK,CAClB,WAAqB,EACrB,uBAAsC;IAEtC,MAAM,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;IAEnC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAEhE,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,mDAAmD;QACnD,MAAM,YAAY,CAAC,OAAO,EAAE;YAC1B,sBAAsB;SACmB,CAAC,CAAC;QAE7C,oDAAoD;QACpD,OAAO,CAAC,SAAS,CACf,IAAI,MAAM,CACR,qCAAqC,EACrC,sEAAsE,CACvE;aACE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;aACpC,SAAS,CAAC,GAAG,EAAE;YACd,iDAAiD;YACjD,MAAM,IAAI,KAAK,CACb,+GAA+G,CAChH,CAAC;QACJ,CAAC,CAAC,CACL,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,uBAAuB,CAAC,CAAC;AAC1D,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,OAAqB,EAAE,OAAiB;IAClE,MAAM,UAAU,GAAyB,EAAE,CAAC;IAE5C,KAAK,MAAM,UAAU,IAAI,OAAO,EAAE,CAAC;QACjC,IAAI,CAAC,CAAC,UAAU,IAAI,cAAc,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,oBAAoB,UAAU,GAAG,CAAC,CAAC;QAErD,UAAU,CAAC,IAAI,CACb,CAAC,MAAM,cAAc,CAAC,UAAyC,CAAC,EAAE,CAAC;aAChE,OAAO,CACX,CAAC;QAEF,0BAA0B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5E,MAAM,OAAO,CAAC,GAAG,CACf,UAAU,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,gBAAgB,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CACxE,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,0BAA0B,CAAC,OAAqB,EAAE,OAAiB;IAC1E,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5E,OAAO,CAAC,KAAK,CAAC,GAAG,WAAW,oBAAoB,CAAC,CAAC;AACpD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAc;IACrD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7C,IAAI,WAAW,KAAK,CAAC,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAExC,MAAM,YAAY,GAAa,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;IAC1D,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,KAAK,IAAI,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/C,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAClC,IAAI,CAAC,UAAU;gBACb,MAAM,IAAI,KAAK,CACb,6DAA6D,CAC9D,CAAC;YACJ,IAAI,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC;gBAC9B,MAAM,IAAI,KAAK,CACb,yBAAyB,UAAU,wCAAwC,CAC5E,CAAC;YACJ,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACzB,CAAC,EAAE,CAAC,CAAC,iBAAiB;QACxB,CAAC;aAAM,CAAC;YACN,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,OAAO;KACR,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-qraft/cli",
-  "version": "2.3.2",
+  "version": "2.4.1",
   "description": "CLI for generating typed TanStack Query React Hooks and services from OpenAPI Document, improving type safety in React apps",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -15,9 +15,9 @@
     "openapi-qraft": "./bin.mjs"
   },
   "dependencies": {
-    "@openapi-qraft/openapi-typescript-plugin": "1.2.12",
-    "@openapi-qraft/plugin": "2.3.2",
-    "@openapi-qraft/tanstack-query-react-plugin": "2.3.2",
+    "@openapi-qraft/openapi-typescript-plugin": "1.2.14",
+    "@openapi-qraft/plugin": "2.4.1",
+    "@openapi-qraft/tanstack-query-react-plugin": "2.4.1",
     "commander": "^11.1.0"
   },
   "devDependencies": {
@@ -28,6 +28,9 @@
     "typescript": "^5.6.2",
     "vitest": "^3.0.5"
   },
+  "peerDependencies": {
+    "ansi-colors": "^4.1.3"
+  },
   "files": [
     "dist",
     "src",

package/src/bin.ts

@@ -1,40 +1,58 @@
 #!/usr/bin/env node
 import type { QraftCommandPlugin } from '@openapi-qraft/plugin/lib/QraftCommandPlugin';
-import process from 'node:process';
-import { QraftCommand } from '@openapi-qraft/plugin/lib/QraftCommand';
-import { Option } from 'commander';
+import { QraftCommand } from '@openapi-qraft/plugin';
+import { RedoclyConfigCommand } from '@openapi-qraft/plugin/lib/RedoclyConfigCommand';
+import { Option, ParseOptions } from 'commander';
 import { builtInPlugins } from './builtInPlugins.js';
 
-export async function main() {
+export async function main(
+  processArgv: string[],
+  processArgvParseOptions?: ParseOptions
+) {
+  const redoclyConfigParseResult = await new RedoclyConfigCommand().parseConfig(
+    qraft,
+    processArgv,
+    processArgvParseOptions
+  );
+
+  if (redoclyConfigParseResult?.length) return;
+
+  await qraft(processArgv, processArgvParseOptions);
+}
+
+async function qraft(
+  processArgv: string[],
+  processArgvParseOptions?: ParseOptions
+) {
   const command = new QraftCommand();
 
-  const { argv, plugins } = extractArgvPluginOptions(process.argv);
+  const { argv, plugins } = extractArgvPluginOptions(processArgv);
 
   if (plugins) {
     await setupPlugins(command, plugins);
   } else {
-    // default - setup tanstack-query-react plugin
+    // Default - set up the tanstack-query-react plugin
     await setupPlugins(command, [
       'tanstack-query-react',
     ] satisfies (keyof typeof builtInPlugins)[]);
 
-    // option to display help with all available plugins
+    // Option to display help with all available plugins
     command.addOption(
       new Option(
         '--plugin <name_1> --plugin <name_2>',
-        `Generator plugins to be used.`
+        `Specifies which generator plugins should be used for code generation`
       )
         .choices(Object.keys(builtInPlugins))
         .argParser(() => {
-          // Fallback, if plugins parsing went wrong
+          // Fallback handler for when plugin parsing fails
           throw new Error(
-            'Plugin option must be handled before parsing the command and should not be passed to the commander'
+            'The plugin option must be processed before command parsing and should not be directly passed to the commander'
           );
         })
     );
   }
 
-  return void (await command.parseAsync(argv));
+  await command.parseAsync(argv, processArgvParseOptions);
 }
 
 async function setupPlugins(command: QraftCommand, plugins: string[]) {
@@ -59,7 +77,7 @@ async function setupPlugins(command: QraftCommand, plugins: string[]) {
 }
 
 /**
- * Add plugin's usage instructions calling `command.usage(...)`
+ * Adds plugin usage instructions by calling `command.usage(...)`
  */
 function addCommandUsageWithPlugins(command: QraftCommand, plugins: string[]) {
   const pluginUsage = plugins.map((plugin) => `--plugin ${plugin}`).join(' ');
@@ -67,8 +85,8 @@ function addCommandUsageWithPlugins(command: QraftCommand, plugins: string[]) {
 }
 
 /**
- * Extracts multiple `--plugin <name>` options from the `argv`
- * and returns the filtered `argv` and the list of plugins.
+ * Extracts multiple `--plugin <name>` options from `argv`
+ * and returns both the filtered `argv` and the extracted plugins list.
  */
 export function extractArgvPluginOptions(argv: string[]) {
   const pluginIndex = argv.indexOf('--plugin');
@@ -80,9 +98,14 @@ export function extractArgvPluginOptions(argv: string[]) {
   for (let i = pluginIndex; i < argv.length; i++) {
     if (argv[i] === '--plugin') {
       const pluginName = argv.at(i + 1);
-      if (!pluginName) throw new Error(`Missing plugin name after '--plugin'`);
+      if (!pluginName)
+        throw new Error(
+          `A plugin name must be specified after the '--plugin' option`
+        );
       if (pluginName?.startsWith('--'))
-        throw new Error(`Invalid plugin name: '${pluginName}'`);
+        throw new Error(
+          `Invalid plugin name: '${pluginName}'. Plugin names cannot start with '--'`
+        );
       plugins.push(pluginName);
       i++; // Skip next item
     } else {