Merge pull request #379 from OpenAPI-Qraft/chore/update-commander

feat: update commander

Author: radist2s

.changeset/shaggy-cats-jam.md

@@ -0,0 +1,12 @@
+---
+'@openapi-qraft/tanstack-query-react-plugin': minor
+'@openapi-qraft/openapi-typescript-plugin': minor
+'@openapi-qraft/plugin': minor
+'@openapi-qraft/cli': minor
+---
+
+Deprecate `-rm` CLI option in favor of `-c` for `--clean` flag.
+
+The `-rm` short flag for the `--clean` option has been deprecated due to commander.js v14 requiring single-character
+short flags. The option will continue to work but will show a deprecation warning. Please migrate to using `-c` or
+`--clean` instead. The `-rm` flag will be removed in v3.0.

packages/cli/README.md

@@ -28,7 +28,7 @@ Arguments:
 
 Options:
   -o, --output-dir <path>                             Output directory for generated services
-  -rm, --clean                                        Clean output directory before generating services
+  -c, --clean                                         Clean output directory before generating services
   --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"
@@ -93,7 +93,7 @@ npx openapi-qraft --plugin tanstack-query-react --plugin openapi-typescript http
 
 ### Edge-case Options
 
-- **`-rm, --clean`:** Clean the specified output directory services before generating to remove stale files _(optional)_.
+- **`-c, --clean`:** Clean the specified output directory services before generating to remove stale files _(optional)_.
 - **`--filter-services <glob-patterns...>`:** Filter services to be generated by glob pattern _(optional)_.
   - **Pattern syntax:**
     - `<glob-pattern>,<glob-pattern>,...` - comma-separated list of glob patterns. See [`micromatch`](https://github.com/micromatch/micromatch)

packages/cli/package.json

@@ -18,7 +18,8 @@
     "@openapi-qraft/openapi-typescript-plugin": "workspace:*",
     "@openapi-qraft/plugin": "workspace:*",
     "@openapi-qraft/tanstack-query-react-plugin": "workspace:*",
-    "commander": "^11.1.0"
+    "ansi-colors": "^4.1.3",
+    "commander": "^14.0.2"
   },
   "devDependencies": {
     "@openapi-qraft/eslint-config": "workspace:*",

packages/cli/src/bin.ts

@@ -4,20 +4,23 @@ import { QraftCommand } from '@openapi-qraft/plugin';
 import { RedoclyConfigCommand } from '@openapi-qraft/plugin/lib/RedoclyConfigCommand';
 import { Option, ParseOptions } from 'commander';
 import { builtInPlugins } from './builtInPlugins.js';
+import { handleDeprecatedOptions } from './handleDeprecatedOptions.js';
 
 export async function main(
   processArgv: string[],
   processArgvParseOptions?: ParseOptions
 ) {
+  const argv = handleDeprecatedOptions(processArgv);
+
   const redoclyConfigParseResult = await new RedoclyConfigCommand().parseConfig(
     qraft,
-    processArgv,
+    argv,
     processArgvParseOptions
   );
 
   if (redoclyConfigParseResult?.length) return;
 
-  await qraft(processArgv, processArgvParseOptions);
+  await qraft(argv, processArgvParseOptions);
 }
 
 async function qraft(

packages/cli/src/handleDeprecatedOptions.test.ts

@@ -0,0 +1,51 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { handleDeprecatedOptions } from './handleDeprecatedOptions.js';
+
+describe('handleDeprecatedOptions', () => {
+  const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+
+  beforeEach(() => {
+    warnSpy.mockClear();
+  });
+
+  afterEach(() => {
+    warnSpy.mockClear();
+  });
+
+  it('should replace -rm with -c', () => {
+    const result = handleDeprecatedOptions(['-rm']);
+    expect(result).toEqual(['-c']);
+  });
+
+  it('should show deprecation warning for -rm', () => {
+    handleDeprecatedOptions(['-rm']);
+    expect(warnSpy).toHaveBeenCalledTimes(1);
+    expect(warnSpy.mock.calls[0][0]).toContain('-rm');
+    expect(warnSpy.mock.calls[0][0]).toContain('-c');
+    expect(warnSpy.mock.calls[0][0]).toContain('v3.0');
+  });
+
+  it('should not modify other arguments', () => {
+    const result = handleDeprecatedOptions(['--output-dir', 'src/api', '-o']);
+    expect(result).toEqual(['--output-dir', 'src/api', '-o']);
+    expect(warnSpy).not.toHaveBeenCalled();
+  });
+
+  it('should handle mixed arguments with deprecated option', () => {
+    const result = handleDeprecatedOptions([
+      '--plugin',
+      'tanstack-query-react',
+      '-rm',
+      '-o',
+      'src/api',
+    ]);
+    expect(result).toEqual([
+      '--plugin',
+      'tanstack-query-react',
+      '-c',
+      '-o',
+      'src/api',
+    ]);
+    expect(warnSpy).toHaveBeenCalledTimes(1);
+  });
+});

packages/cli/src/handleDeprecatedOptions.ts

@@ -0,0 +1,20 @@
+import c from 'ansi-colors';
+
+const deprecatedOptionsMap: Record<string, { replacement: string }> = {
+  '-rm': { replacement: '-c' },
+};
+
+export function handleDeprecatedOptions(argv: string[]): string[] {
+  return argv.map((arg) => {
+    const deprecated = deprecatedOptionsMap[arg];
+    if (deprecated) {
+      console.warn(
+        c.yellow(
+          `⚠ Option '${arg}' is deprecated and will be removed in v3.0. Please use '${deprecated.replacement}' instead.`
+        )
+      );
+      return deprecated.replacement;
+    }
+    return arg;
+  });
+}

packages/openapi-typescript-plugin/package.json

@@ -37,7 +37,7 @@
     "@openapi-qraft/plugin": "workspace:^",
     "@redocly/openapi-core": "^1.34.5",
     "ansi-colors": "^4.1.3",
-    "commander": "^11.1.0",
+    "commander": "^14.0.2",
     "openapi-typescript": "^7.10.1",
     "typescript": "^5.6.2"
   },

packages/plugin/package.json

@@ -36,7 +36,7 @@
     "@redocly/openapi-core": "^1.34.5",
     "ansi-colors": "^4.1.3",
     "camelcase": "^8.0.0",
-    "commander": "^11.1.0",
+    "commander": "^14.0.2",
     "micromatch": "^4.0.8",
     "openapi-typescript": "^7.10.1",
     "ora": "^8.2.0"

packages/plugin/src/lib/QraftCommand.ts

@@ -54,7 +54,7 @@ export class QraftCommand extends Command {
       )
       .addOption(
         new Option(
-          '-rm, --clean',
+          '-c, --clean',
           'Clean output directory before generating services'
         )
       )