@openapi-qraft/cli 1.7.0 → 1.9.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @openapi-qraft/cli
 
+## 1.9.0
+
+### Minor Changes
+
+- 3a75364: **Plugin Support in CLI**: Introduced the `--plugin <name>` option in the OpenAPI Qraft CLI to allow users to specify
+  plugins such as `tanstack-query-react` for React service generation and `openapi-typescript` for TypeScript type
+  generation. This enhancement provides greater flexibility and customization options in the API generation process. The
+  CLI now supports using multiple plugins simultaneously, enhancing the tool's versatility for developers.
+
+### Patch Changes
+
+- Updated dependencies [943a9d3]
+- Updated dependencies [3a75364]
+  - @openapi-qraft/plugin@1.9.0
+  - @openapi-qraft/openapi-typescript-plugin@1.0.1
+  - @openapi-qraft/tanstack-query-react-plugin@1.9.0
+
+## 1.8.0
+
+### Patch Changes
+
+- 878c002: Replaced string-based path handling with URL objects to ensure path normalization and enhance security.
+- Updated dependencies [27d501a]
+  - @openapi-qraft/tanstack-query-react-plugin@1.8.0
+
 ## 1.7.0
 
 ## 1.6.0

package/README.md

@@ -19,49 +19,59 @@ npm install -g @openapi-qraft/cli
 ## Usage
 
 ```
-Usage: openapi-qraft [options] [input]
+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/)
 
 Arguments:
-  input                                    Input OpenAPI Schema 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
-  --openapi-types-import-path <path>       Path to schema types file (.d.ts), eg: "../openapi.d.ts"
-  -rm, --clean                             Clean output directory before generating services
-  --filter-services <glob-pattern>          Filter services to be generated by glob pattern. Eg: "/user/**,/post/**". See NPM `micromatch` package for more details.
-  --operation-generics-import-path <path>  Path to operation generics file (default: "@openapi-qraft/react")
-  --file-header <string>                   Header to be added to the generated file (eg: /* eslint-disable */)
-  --postfix-services <string>              Postfix to be added to the generated service name (eg: Service)
-  --explicit-import-extensions             All import statements will include explicit `.js` extensions. Ideal for projects using ECMAScript modules.
-  --service-name-base <endpoint | tags>    Use OpenAPI Operation `endpoint` or `tags` as service names (default: "endpoint")
-  -h, --help                               display help for command
+  -o, --output-dir <path>                         Output directory for generated services
+  -rm, --clean                                    Clean output directory before generating services
+  --filter-services <glob-pattern>                Filter services to be generated by glob pattern. Eg: "/user/**,/post/**". See NPM `micromatch` package for more
+                                                  details.
+  --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"
+  --explicit-import-extensions                    All import statements will include explicit `.js` extensions. Ideal for projects using ECMAScript modules.
+  --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")
+  --enum                                          Export true TS enums instead of unions
+  -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
+  --empty-objects-unknown                         Generate `unknown` instead of `Record<string, never>` for empty objects
+  --default-non-nullable                          Set to `false` to ignore default values when generating non-nullable types
+  --properties-required-by-default                Treat schema objects as if `required` is set to all properties by default
+  --array-length                                  Generate tuples using array minItems / maxItems
+  --path-params-as-types                          Convert paths to template literal types
+  --alphabetize                                   Sort object keys alphabetically
+  --exclude-deprecated                            Exclude deprecated types
+  --no-blob-from-binary                           If this option is enabled, binary format fields will not be converted to Blob types, preserving the native
+                                                  representation
+  -h, --help                                      display help for command
+
 ```
 
-### Example
+## Usage example
 
-To generate services from an OpenAPI schema file:
+The command below generates Qraft API services for the OpenAPI schema and places them in the `src/api` directory:
 
-```bash
-openapi-qraft https://example.com/openapi.json --output-dir src/api --openapi-types-import-path ../openapi.d.ts
+```bash npm2yarn
+npx 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
 ```
 
-This command generates service declarations and React Query hooks types in the `src/api` directory based on
-the `schema.json` file.
-
-#### Required Options
+### Required
 
 - **`-o <path>, --output-dir <path>`:** Specify where to output the generated services.
   - Example: `--output-dir src/api`
-- **`--openapi-types-import-path <path>`:** Set the path to the schema types definition file to ensure consistent type
-  usage (assumed, you already have `openapi.d.ts` as a result of the [`openapi-typescript`](https://github.com/drwpow/openapi-typescript) utility).
-  - The path is the exact import specifier used in the _generated services_. It should be \_relative to the service
-    output directory.
-  - Examples:
-    - `--openapi-types-import-path ../openapi.d.ts`
-    - `--openapi-types-import-path '@/api/openapi.d.ts'`
-    - `--openapi-types-import-path '@external-package-types'`
 
-#### Useful Options
+### Edge-case Options
 
 - **`-rm, --clean`:** Clean the specified output directory services before generating to remove stale files _(optional)_.
 - **`--filter-services`:** Filter services to be generated by glob pattern _(optional)_. See [`micromatch`](https://github.com/micromatch/micromatch)
@@ -69,28 +79,84 @@ the `schema.json` file.
   - Examples:
     - `--filter-services '/user/**,/post/**'` - include only API endpoints that start with `/user/` or `/post/`
     - `--filter-services '**,!/internal/**'` - include _all_ API endpoints _except_ those that start with `/internal/`
-
-#### Edge-case Options
-
-- **`--operation-generics-import-path <path>`:** Define the path to the operation generics file, allowing for custom
-  operation handling _(optional, default: `@openapi-qraft/react`)_.
+- **`--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]`)_.
+  - 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`.
+- **`--explicit-import-extensions`:** Include explicit `.js` extensions in all import statements. Ideal for projects using ECMAScript modules when TypeScript's _--moduleResolution_ is `node16` or `nodenext` _(optional)_.
 - **`--file-header <string>`:** Add a custom header to each generated file, useful for disabling linting rules or adding file
   comments _(optional)_.
   - Example: `--file-header '/* eslint-disable */'`
 - **`--postfix-services <string>`:** Customize the generated service names with a specific postfix _(optional, default: `Service`)_.
   - Example: `--postfix-services Endpoint` will generate `services/UserEndpoint.ts` instead of `services/UserService.ts`.
-- **`--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]`)_.
+- **`--plugin <name_1> --plugin <name_2>`**: Generator plugins to be used. (choices: `tanstack-query-react`, `openapi-typescript`)
   - Examples:
-    - `--service-name-base endpoint[0]` generates `services/FooService.ts`. from endpoint `/foo/bar/baz`
-    - `--service-name-base endpoint[1]` generates `services/BarService.ts`. from endpoint `/foo/bar/baz`
-    - `--service-name-base endpoint[2]` generates `services/BarService.ts`. from endpoint `/foo/bar` _(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`.
-- **`--explicit-import-extensions`:** Include explicit `.js` extensions in all import statements. Ideal for projects
-  using ECMAScript modules when TypeScript's _--moduleResolution_ is `node16` or `nodenext` _(optional)_.
+    - `--plugin tanstack-query-react --plugin openapi-typescript` generates Qraft Services and `openapi-typescript` types file.
+    - `--plugin tanstack-query-react` generates Qraft Services only.
+    - `--plugin openapi-typescript` generates [`openapi-typescript`](https://github.com/drwpow/openapi-typescript) types file only.
 - **`-h, --help`:** Display help for the command (optional).
 
+## Plugin System
+
+The following plugins are currently supported:
+
+- `openapi-typescript` - Generates TypeScript types from an OpenAPI Document. The main difference from the original [`openapi-typescript`](https://www.npmjs.com/package/openapi-typescript) package is that `format: binary` fields default to `Blob` types instead of remaining as `string`. This behavior can be altered using the `--no-blob-from-binary` option.
+- `tanstack-query-react` - Generates Qraft API services for React.
+
+> Plugin must be provided with the `--plugin <name>` option. By default, the `tanstack-query-react` plugin is used.
+> It is possible to use multiple plugins at the same time. For example, `--plugin tanstack-query-react --plugin openapi-typescript` generates Qraft API services & schema types file.
+
+### `--plugin tanstack-query-react` options
+
+- **`--openapi-types-import-path <path>`:** Set the path to the schema types definition file to ensure consistent type
+  usage (assumed, you already have `schema.d.ts` as a result of the [`openapi-typescript`](https://github.com/drwpow/openapi-typescript) utility). You also probably
+  don't need the ~~`--plugin openapi-typescript`~~ option in this case.
+  - The path is the exact import specifier used in the _generated services_. It should be _relative_ to the service
+    output directory. _Optional_, if the `--plugin openapi-typescript` is used. _Required_ otherwise.
+    - Examples:
+      - `--openapi-types-import-path ../openapi.d.ts`
+      - `--openapi-types-import-path '@/api/openapi.d.ts'`
+      - `--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)_
+
+### `--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.
+- **`-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.
+- **`--empty-objects-unknown`**: Generate `unknown` instead of `Record<string, never>` for empty objects.
+- **`--default-non-nullable`**: Set to `false` to ignore default values when generating non-nullable types.
+- **`--properties-required-by-default`**: Treat schema objects as if `required` is set to all properties by default.
+- **`--array-length`**: Generate tuples using array `minItems` / `maxItems`.
+- **`--path-params-as-types`**: Convert paths to template literal types.
+- **`--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.
+
+## In-project Setup
+
+Add the following `"scripts"` to your `package.json` file:
+
+```json lines title="package.json"
+{
+  "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"
+    // ...other scripts
+  }
+}
+```
+
 ## Contributing
 
 Contributions to `@openapi-qraft/cli` are welcome! Please feel free to submit issues, pull requests, or suggest features

package/bin.mjs

@@ -5,4 +5,6 @@
  * Workaround to allow `rimraf dist/` on rebuilds and keep `bin` executable
  * without a need `yarn install`
  */
-import './dist/bin.js';
+import { main } from './dist/bin.js';
+
+main();

package/dist/bin.d.ts

@@ -1,2 +1,14 @@
 #!/usr/bin/env node
-export {};
+export declare function main(): Promise<undefined>;
+/**
+ * Extracts multiple `--plugin <name>` options from the `argv`
+ * and returns the filtered `argv` and the list of plugins.
+ */
+export declare function extractArgvPluginOptions(argv: string[]): {
+    argv: string[];
+    plugins?: undefined;
+} | {
+    argv: string[];
+    plugins: string[];
+};
+//# sourceMappingURL=bin.d.ts.map

package/dist/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AASA,wBAAsB,IAAI,uBA8BzB;AA+BD;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE;;;;;;EAwBtD"}

package/dist/bin.js

@@ -1,63 +1,75 @@
 #!/usr/bin/env node
-import c from 'ansi-colors';
-import { program } from 'commander';
-import fs from 'node:fs';
-import { fileHeader } from './lib/fileHeader.js';
-import { writeOpenAPIServices } from './writeOpenAPIServices.js';
-program
-    .description('Generate services declarations and Typed React Query Interfaces from OpenAPI Schema')
-    .argument('[input]', 'Input OpenAPI Schema file path, URL (json, yml)', null)
-    .requiredOption('-o, --output-dir <path>', 'Output directory for generated services')
-    .requiredOption('--openapi-types-import-path <path>', // todo::specify better param name to avoid confusion with real path
-'Path to schema types file (.d.ts), eg: "../openapi.d.ts"')
-    .option('-rm, --clean', 'Clean output directory before generating services')
-    .option('--filter-services <glob-pattern>', 'Filter services to be generated by glob pattern. Eg: "/user/**,/post/**". See NPM `micromatch` package for more details.')
-    .option('--operation-generics-import-path <path>', 'Path to operation generics file', '@openapi-qraft/react')
-    .option('--file-header <string>', 'Header to be added to the generated file (eg: /* eslint-disable */)')
-    .option('--postfix-services <string>', 'Postfix to be added to the generated service name (eg: Service)')
-    .option('--explicit-import-extensions', 'All import statements will include explicit `.js` extensions. Ideal for projects using ECMAScript modules.')
-    .option('--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.', 'endpoint[0]')
-    .action(async (input, args) => {
-    const { version: packageVersion, name: packageName } = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url), 'utf8'));
-    if (args.version) {
-        console.info(`v${packageVersion}`);
-        process.exit(0);
+import { QraftCommand } from '@openapi-qraft/plugin/lib/QraftCommand';
+import { Option } from 'commander';
+import process from 'node:process';
+import { builtInPlugins } from './builtInPlugins.js';
+export async function main() {
+    const command = new QraftCommand();
+    const { argv, plugins } = extractArgvPluginOptions(process.argv);
+    if (plugins) {
+        await setupPlugins(command, plugins);
     }
-    console.info(`✨ ${c.bold(`${packageName} ${packageVersion}`)}`);
-    const source = input
-        ? new URL(input, new URL(`file://${process.cwd()}/`))
-        : process.stdin;
-    if (source === process.stdin && source.isTTY) {
-        console.error(c.red('Input file not found or stdin is empty. Please specify `--input` option or pipe OpenAPI Schema to stdin.'));
-        process.exit(1);
+    else {
+        // default - setup 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.`)
+            .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');
+        }));
     }
-    const servicesGlob = args.filterServices
-        ? args.filterServices
-            .split(',')
-            .filter((item) => typeof item === 'string' && item.trim())
-        : undefined;
-    await writeOpenAPIServices({
-        source,
-        serviceImports: {
-            operationGenericsImportPath: args.operationGenericsImportPath,
-            openapiTypesImportPath: args.openapiTypesImportPath,
-        },
-        servicesGlob,
-        output: {
-            dir: args.outputDir,
-            clean: args.clean,
-            fileHeader: args.fileHeader ?? fileHeader,
-            postfixServices: args.postfixServices,
-            explicitImportExtensions: args.explicitImportExtensions,
-            servicesDirName: 'services',
-            serviceNameBase: args.serviceNameBase,
-        },
-    }).catch((error) => {
-        if (error instanceof Error)
-            console.error(c.red(error.message), c.red(error.stack ?? ''));
-        console.error(error);
-        process.exit(1);
-    });
-});
-program.parse(process.argv);
+    return void (await command.parseAsync(argv));
+}
+async function setupPlugins(command, plugins) {
+    const pluginList = [];
+    for (const pluginName of plugins) {
+        if (!(pluginName in builtInPlugins))
+            throw new Error(`Unknown plugin: '${pluginName}'`);
+        pluginList.push((await builtInPlugins[pluginName]())
+            .default);
+        addCommandUsageWithPlugins(command, plugins);
+    }
+    await Promise.all(pluginList.map((plugin) => plugin.setupCommand(command)));
+    await Promise.all(pluginList.map((plugin) => plugin.postSetupCommand?.(command, plugins)));
+}
+/**
+ * Add plugin's usage instructions 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.
+ */
+export function extractArgvPluginOptions(argv) {
+    const pluginIndex = argv.indexOf('--plugin');
+    if (pluginIndex === -1)
+        return { argv };
+    const filteredArgv = argv.slice(0, pluginIndex);
+    const plugins = [];
+    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?.startsWith('--'))
+                throw new Error(`Invalid plugin name: '${pluginName}'`);
+            plugins.push(pluginName);
+            i++; // Skip next item
+        }
+        else {
+            filteredArgv.push(argv[i]);
+        }
+    }
+    return {
+        argv: filteredArgv,
+        plugins,
+    };
+}
 //# sourceMappingURL=bin.js.map

package/dist/bin.js.map

@@ -1 +1 @@
-{"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AACA,OAAO,CAAC,MAAM,aAAa,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzB,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO;KACJ,WAAW,CACV,qFAAqF,CACtF;KACA,QAAQ,CAAC,SAAS,EAAE,iDAAiD,EAAE,IAAI,CAAC;KAC5E,cAAc,CACb,yBAAyB,EACzB,yCAAyC,CAC1C;KACA,cAAc,CACb,oCAAoC,EAAE,oEAAoE;AAC1G,0DAA0D,CAC3D;KACA,MAAM,CAAC,cAAc,EAAE,mDAAmD,CAAC;KAC3E,MAAM,CACL,kCAAkC,EAClC,0HAA0H,CAC3H;KACA,MAAM,CACL,yCAAyC,EACzC,iCAAiC,EACjC,sBAAsB,CACvB;KACA,MAAM,CACL,wBAAwB,EACxB,qEAAqE,CACtE;KACA,MAAM,CACL,6BAA6B,EAC7B,iEAAiE,CAClE;KACA,MAAM,CACL,8BAA8B,EAC9B,4GAA4G,CAC7G;KACA,MAAM,CACL,gDAAgD,EAChD,iHAAiH,EACjH,aAAa,CACd;KACA,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;IAC5B,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAC/D,EAAE,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CACrE,CAAC;IAEF,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,OAAO,CAAC,IAAI,CAAC,IAAI,cAAc,EAAE,CAAC,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,IAAI,cAAc,EAAE,CAAC,EAAE,CAAC,CAAC;IAEhE,MAAM,MAAM,GAAG,KAAK;QAClB,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,UAAU,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACrD,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;IAElB,IAAI,MAAM,KAAK,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QAC7C,OAAO,CAAC,KAAK,CACX,CAAC,CAAC,GAAG,CACH,0GAA0G,CAC3G,CACF,CAAC;QAEF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,CAAC,cAAc;QACtC,CAAC,CAAC,IAAI,CAAC,cAAc;aAChB,KAAK,CAAC,GAAG,CAAC;aACV,MAAM,CAAC,CAAC,IAAa,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACvE,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,oBAAoB,CAAC;QACzB,MAAM;QACN,cAAc,EAAE;YACd,2BAA2B,EAAE,IAAI,CAAC,2BAA2B;YAC7D,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;SACpD;QACD,YAAY;QACZ,MAAM,EAAE;YACN,GAAG,EAAE,IAAI,CAAC,SAAS;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,UAAU;YACzC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,wBAAwB,EAAE,IAAI,CAAC,wBAAwB;YACvD,eAAe,EAAE,UAAU;YAC3B,eAAe,EAAE,IAAI,CAAC,eAAe;SACtC;KACF,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACjB,IAAI,KAAK,YAAY,KAAK;YACxB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;QAChE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../src/bin.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAC;AAGtE,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,OAAO,MAAM,cAAc,CAAC;AAEnC,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"}

package/dist/builtInPlugins.d.ts

@@ -0,0 +1,5 @@
+export declare const builtInPlugins: {
+    readonly 'tanstack-query-react': () => Promise<typeof import("@openapi-qraft/tanstack-query-react-plugin")>;
+    readonly 'openapi-typescript': () => Promise<typeof import("@openapi-qraft/openapi-typescript-plugin")>;
+};
+//# sourceMappingURL=builtInPlugins.d.ts.map

package/dist/builtInPlugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builtInPlugins.d.ts","sourceRoot":"","sources":["../src/builtInPlugins.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;CAKjB,CAAC"}

package/dist/builtInPlugins.js

@@ -0,0 +1,5 @@
+export const builtInPlugins = {
+    'tanstack-query-react': () => import('@openapi-qraft/tanstack-query-react-plugin'),
+    'openapi-typescript': () => import('@openapi-qraft/openapi-typescript-plugin'),
+};
+//# sourceMappingURL=builtInPlugins.js.map

package/dist/builtInPlugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builtInPlugins.js","sourceRoot":"","sources":["../src/builtInPlugins.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,sBAAsB,EAAE,GAAG,EAAE,CAC3B,MAAM,CAAC,4CAA4C,CAAC;IACtD,oBAAoB,EAAE,GAAG,EAAE,CACzB,MAAM,CAAC,0CAA0C,CAAC;CAC5C,CAAC"}

package/package.json

@@ -1,36 +1,40 @@
 {
   "name": "@openapi-qraft/cli",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "description": "CLI for generating typed Tanstack Query React Hooks and services from OpenAPI Schemas, improving type safety in React apps",
   "scripts": {
     "build": "rimraf dist/ && tsc --project tsconfig.build.json",
     "dev": "yarn build --watch",
     "test": "vitest run",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint"
   },
   "type": "module",
   "bin": {
     "openapi-qraft": "./bin.mjs"
   },
   "dependencies": {
-    "ansi-colors": "^4.1.3",
-    "camelcase": "^8.0.0",
-    "commander": "^11.1.0",
-    "micromatch": "^4.0.5",
-    "openapi-typescript": "7.0.0-next.7",
-    "ora": "^8.0.1",
-    "typescript": "^5.3.3",
-    "yaml": "^2.3.4"
+    "@openapi-qraft/openapi-typescript-plugin": "~1.0.1",
+    "@openapi-qraft/plugin": "~1.9.0",
+    "@openapi-qraft/tanstack-query-react-plugin": "~1.9.0",
+    "commander": "^11.1.0"
   },
   "devDependencies": {
-    "@types/micromatch": "^4",
+    "@openapi-qraft/eslint-config": "~1.0.0",
     "@types/node": "^18.19.4",
+    "eslint": "^9.0.0",
+    "globals": "^15.0.0",
     "rimraf": "^5.0.5",
+    "typescript": "^5.3.3",
     "vitest": "^1.4.0"
   },
   "files": [
     "dist",
-    "bin.mjs"
+    "src",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*",
+    "!src/**/*.test.*",
+    "!src/**/*.spec.*"
   ],
   "exports": {
     "./package.json": "./package.json",

package/src/bin.ts

@@ -0,0 +1,99 @@
+#!/usr/bin/env node
+import { QraftCommand } from '@openapi-qraft/plugin/lib/QraftCommand';
+import type { QraftCommandPlugin } from '@openapi-qraft/plugin/lib/QraftCommandPlugin';
+
+import { Option } from 'commander';
+import process from 'node:process';
+
+import { builtInPlugins } from './builtInPlugins.js';
+
+export async function main() {
+  const command = new QraftCommand();
+
+  const { argv, plugins } = extractArgvPluginOptions(process.argv);
+
+  if (plugins) {
+    await setupPlugins(command, plugins);
+  } else {
+    // default - setup tanstack-query-react plugin
+    await setupPlugins(command, [
+      'tanstack-query-react',
+    ] satisfies (keyof typeof builtInPlugins)[]);
+
+    // option to display help with all available plugins
+    command.addOption(
+      new Option(
+        '--plugin <name_1> --plugin <name_2>',
+        `Generator plugins to be used.`
+      )
+        .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'
+          );
+        })
+    );
+  }
+
+  return void (await command.parseAsync(argv));
+}
+
+async function setupPlugins(command: QraftCommand, plugins: string[]) {
+  const pluginList: QraftCommandPlugin[] = [];
+
+  for (const pluginName of plugins) {
+    if (!(pluginName in builtInPlugins))
+      throw new Error(`Unknown plugin: '${pluginName}'`);
+
+    pluginList.push(
+      (await builtInPlugins[pluginName as keyof typeof builtInPlugins]())
+        .default
+    );
+
+    addCommandUsageWithPlugins(command, plugins);
+  }
+
+  await Promise.all(pluginList.map((plugin) => plugin.setupCommand(command)));
+  await Promise.all(
+    pluginList.map((plugin) => plugin.postSetupCommand?.(command, plugins))
+  );
+}
+
+/**
+ * Add plugin's usage instructions calling `command.usage(...)`
+ */
+function addCommandUsageWithPlugins(command: QraftCommand, plugins: string[]) {
+  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.
+ */
+export function extractArgvPluginOptions(argv: string[]) {
+  const pluginIndex = argv.indexOf('--plugin');
+  if (pluginIndex === -1) return { argv };
+
+  const filteredArgv: string[] = argv.slice(0, pluginIndex);
+  const plugins: 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?.startsWith('--'))
+        throw new Error(`Invalid plugin name: '${pluginName}'`);
+      plugins.push(pluginName);
+      i++; // Skip next item
+    } else {
+      filteredArgv.push(argv[i]);
+    }
+  }
+
+  return {
+    argv: filteredArgv,
+    plugins,
+  };
+}

package/src/builtInPlugins.ts

@@ -0,0 +1,6 @@
+export const builtInPlugins = {
+  'tanstack-query-react': () =>
+    import('@openapi-qraft/tanstack-query-react-plugin'),
+  'openapi-typescript': () =>
+    import('@openapi-qraft/openapi-typescript-plugin'),
+} as const;

package/dist/lib/fileHeader.d.ts

@@ -1 +0,0 @@
-export declare const fileHeader = "/* generated using @openapi-qraft/cli -- do no edit */\n/* istanbul ignore file */\n/* tslint:disable */\n/* eslint-disable */";

package/dist/lib/fileHeader.js

@@ -1,5 +0,0 @@
-export const fileHeader = `/* generated using @openapi-qraft/cli -- do no edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */`;
-//# sourceMappingURL=fileHeader.js.map

package/dist/lib/fileHeader.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fileHeader.js","sourceRoot":"","sources":["../../src/lib/fileHeader.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,UAAU,GAAG;;;qBAGL,CAAC"}