@openapi-qraft/plugin 2.15.0-beta.0 → 2.15.0-beta.2

package/src/lib/QraftCommand.ts

@@ -1,21 +1,29 @@
-import { sep } from 'node:path';
 import process from 'node:process';
-import { pathToFileURL, URL } from 'node:url';
+import { URL } from 'node:url';
+import {
+  handleSchemaInput,
+  normalizeOutputDirPath,
+  QraftCommandActionOptions,
+  QraftCommand as QraftCommandBase,
+  QraftCommandOptions,
+  splitOptionFlags,
+} from '@qraft/plugin';
+import {
+  getRedocAPIsToQraft,
+  OPENAPI_QRAFT_REDOC_CONFIG_KEY,
+} from '@qraft/plugin/lib/getRedocAPIsToQraft';
+import { loadRedoclyConfig } from '@qraft/plugin/lib/loadRedoclyConfig';
+import { createRedoclyOption } from '@qraft/plugin/lib/RedoclyConfigCommand';
 import { Config, createConfig, getMergedConfig } from '@redocly/openapi-core';
 import c from 'ansi-colors';
-import { Command, CommanderError, Option, ParseOptions } from 'commander';
-import ora, { Ora } from 'ora';
+import { CommanderError, Option } from 'commander';
+import { Ora } from 'ora';
 import { packageVersion } from '../packageVersion.js';
 import { filterDocumentPaths } from './filterDocumentPaths.js';
-import { GeneratorFile } from './GeneratorFile.js';
-import { getRedocAPIsToQraft } from './getRedocAPIsToQraft.js';
-import { handleSchemaInput } from './handleSchemaInput.js';
-import { loadRedoclyConfig } from './loadRedoclyConfig.js';
 import { getServices } from './open-api/getServices.js';
 import { OpenAPISchemaType } from './open-api/OpenAPISchemaType.js';
 import { OpenAPIService } from './open-api/OpenAPIService.js';
 import { readSchema } from './open-api/readSchema.js';
-import { OutputOptions } from './OutputOptions.js';
 import {
   createPredefinedParametersGlobs,
   parseOperationPredefinedParametersOption,
@@ -25,39 +33,20 @@ import {
   parseOperationNameModifier,
   processOperationNameModifierOption,
 } from './processOperationNameModifierOption.js';
-import { redoclyOption } from './RedoclyConfigCommand.js';
 import { splitCommaSeparatedGlobs } from './splitCommaSeparatedGlobs.js';
-import { writeGeneratorFiles } from './writeGeneratorFiles.js';
 
-export class QraftCommand extends Command {
-  static spinner = ora();
+export { splitOptionFlags };
 
-  protected readonly cwd: URL;
-  protected registeredPluginActions: QraftCommandActionCallback[] = [];
-
-  /**
-   * @param name - not used
-   */
-  constructor(name?: string) {
-    super(name);
-    this.cwd = pathToFileURL(`${process.cwd()}/`);
+export class QraftCommand extends QraftCommandBase<OpenAPIQraftCommandActionOptions> {
+  constructor(name?: string, options?: QraftCommandOptions) {
+    super(name, options);
 
     this.usage('[input] [options]')
       .argument(
-        '[input]',
+        '[input]', // todo::why now required with <input>?
         'Input OpenAPI Document file path, URL (json, yml)',
         null
       )
-      .option(
-        '-o, --output-dir <path>',
-        'Output directory for generated services'
-      )
-      .addOption(
-        new Option(
-          '-c, --clean',
-          'Clean output directory before generating services'
-        )
-      )
       .option(
         '--filter-services <glob-patterns...>',
         'Filter services to be generated using glob patterns. Example: "/user/**,/post/**". For more details, see the NPM `micromatch` package documentation.'
@@ -82,24 +71,10 @@ export class QraftCommand extends Command {
         'Use OpenAPI Operation `endpoint[<index>]` path part (e.g.: "/0/1/2") or `tags` as the base name of the service.',
         'endpoint[0]'
       )
-      .addOption(
-        new Option(
-          '--file-header <string>',
-          'Header to be added to the generated file (eg: /* eslint-disable */)'
-        )
-      )
-      .addOption(redoclyOption);
+      .addOption(createRedoclyOption());
   }
 
-  action(callback: QraftCommandActionCallback): this {
-    this.registerPluginAction(callback);
-    return super.action(this.actionCallback.bind(this));
-  }
-
-  async actionCallback(...actionArgs: any[]) {
-    const inputs = actionArgs.filter(
-      (arg) => typeof arg === 'string'
-    ) as string[];
+  async actionCallback(...actionArgs: any[]): Promise<void> {
     const args = actionArgs.find(
       (arg) => arg && typeof arg === 'object'
     ) as Record<string, any>;
@@ -107,13 +82,18 @@ export class QraftCommand extends Command {
     if (!args) throw new Error('Arguments object not found');
 
     if (args.version) {
-      console.info(`v${packageVersion}`); // todo::add displaying of the used plugin version
+      console.info(`v${packageVersion}`);
       process.exit(0);
     }
 
-    const spinner = QraftCommand.spinner;
+    return super.actionCallback(...actionArgs);
+  }
 
-    spinner.start('Initializing process...');
+  protected override async prepareActionOptions(
+    inputs: string[],
+    args: Record<string, any>
+  ): Promise<OpenAPIQraftCommandActionOptions> {
+    const spinner = QraftCommand.spinner;
 
     const redoc = args.redocly
       ? getMergedConfig(
@@ -123,7 +103,6 @@ export class QraftCommand extends Command {
       : await createConfig(
           {
             rules: {
-              // throw error on duplicate operationIDs
               'operation-operationId-unique': { severity: 'error' },
             },
           },
@@ -132,7 +111,7 @@ export class QraftCommand extends Command {
 
     const input = args.redocly
       ? handleRedoclySchemaInput(redoc, inputs[0], this.cwd, spinner)
-      : handleSchemaInput(inputs[0], this.cwd, spinner);
+      : handleSchemaInput(inputs[0], this.cwd, spinner, 'OpenAPI Document');
 
     spinner.text = 'Reading OpenAPI Document...';
 
@@ -222,346 +201,40 @@ export class QraftCommand extends Command {
       services = modifiedServicesOperationNames;
     }
 
-    spinner.text = 'Generating code...';
-
     const outputDir = normalizeOutputDirPath(args.outputDir);
 
-    for (const pluginAction of this.registeredPluginActions) {
-      const fileItems = await new Promise<GeneratorFile[]>(
-        (resolve, reject) => {
-          pluginAction(
-            {
-              inputs,
-              args,
-              spinner,
-              services,
-              schema: schema as OpenAPISchemaType,
-              output: {
-                dir: outputDir,
-                clean: args.clean,
-              },
-            },
-            resolve
-          ).catch(reject);
-        }
-      );
-
-      try {
-        if (this.registeredPluginActions.indexOf(pluginAction) === 0) {
-          await writeGeneratorFiles({
-            // Create output directory first, but for the first plugin only
-            fileItems: [{ directory: outputDir, clean: false }, ...fileItems],
-            spinner,
-          });
-        } else {
-          await writeGeneratorFiles({ fileItems, spinner });
-        }
-      } catch (error) {
-        spinner.fail(
-          c.red('An error occurred during the code generation process.')
-        );
-
-        if (error instanceof Error) {
-          console.error(c.red(error.message), c.red(error.stack ?? ''));
-        }
-
-        throw error;
-      }
-    }
-
-    spinner.succeed(c.green('Qraft process completed successfully'));
-  }
-
-  protected registerPluginAction(callback: QraftCommandActionCallback) {
-    this.registeredPluginActions.push(callback);
-  }
-
-  option(
-    flags: string,
-    description?: string,
-    defaultValue?: string | boolean | string[]
-  ): this;
-  option<T>(
-    flags: string,
-    description: string,
-    parseArg: (value: string, previous: T) => T,
-    defaultValue?: T
-  ): this;
-  /** @deprecated since v7, instead use choices or a custom function */
-  option(
-    flags: string,
-    description: string,
-    regexp: RegExp,
-    defaultValue?: string | boolean | string[]
-  ): this;
-  option<T>(
-    flags: string,
-    description?: string,
-    parseArg?:
-      | ((value: string, previous: T) => T)
-      | string
-      | boolean
-      | string[]
-      | RegExp,
-    defaultValue?: T
-  ): this {
-    if (
-      this.findSimilarOption({
-        flags,
-        mandatory: false,
-      })
-    ) {
-      return this;
-    }
-
-    return super.option(
-      flags,
-      // @ts-expect-error - Issues with overloading
-      description,
-      parseArg,
-      defaultValue
-    );
-  }
-
-  requiredOption(
-    flags: string,
-    description?: string,
-    defaultValue?: string | boolean | string[]
-  ): this;
-  requiredOption<T>(
-    flags: string,
-    description: string,
-    parseArg: (value: string, previous: T) => T,
-    defaultValue?: T
-  ): this;
-  /** @deprecated since v7, instead use choices or a custom function */
-  requiredOption(
-    flags: string,
-    description: string,
-    regexp: RegExp,
-    defaultValue?: string | boolean | string[]
-  ): this;
-  requiredOption<T>(
-    flags: string,
-    description?: string,
-    regexpOrDefaultValue?:
-      | string
-      | boolean
-      | string[]
-      | RegExp
-      | ((value: string, previous: T) => T),
-    defaultValue?: string | boolean | string[]
-  ): this {
-    if (
-      this.findSimilarOption({
-        flags,
-        mandatory: true,
-      })
-    ) {
-      return this;
-    }
-
-    return super.requiredOption(
-      flags,
-      // @ts-expect-error - Issues with overloading
-      description,
-      regexpOrDefaultValue,
-      defaultValue
-    );
-  }
-
-  addOption(option: Option): this {
-    if (
-      this.findSimilarOption({
-        flags: option.flags,
-        mandatory: option.mandatory,
-      })
-    ) {
-      return this;
-    }
-
-    return super.addOption(option);
+    return {
+      inputs,
+      args,
+      spinner,
+      services,
+      schema: schema as OpenAPISchemaType,
+      output: {
+        dir: outputDir,
+        clean: args.clean,
+      },
+    };
   }
 
-  parseAsync(argv?: readonly string[], options?: ParseOptions): Promise<this> {
-    if (options?.from !== 'user') this.logVersion();
-    return super.parseAsync(argv, options);
-  }
-
-  parse(argv?: readonly string[], options?: ParseOptions): this {
-    if (options?.from !== 'user') this.logVersion();
-    return super.parse(argv, options);
-  }
-
-  protected logVersion() {
+  protected override logVersion() {
     QraftCommand.spinner.info(
       `✨ ${c.bold(`OpenAPI Qraft ${packageVersion}`)}`
     );
   }
-
-  protected findSimilarOption(option: { flags: string; mandatory: boolean }) {
-    try {
-      return findSimilarOption(option, this.options);
-    } catch (error) {
-      console.error(
-        c.red(
-          error instanceof Error
-            ? error.message
-            : 'An error occurred during command option setup'
-        )
-      );
-
-      throw error;
-    }
-  }
 }
 
-/**
- * Normalize an output directory path by adding trailing slash
- */
-function normalizeOutputDirPath(outputDir: string): URL {
-  return pathToFileURL(
-    outputDir.endsWith(sep) ? outputDir : `${outputDir}${sep}`
-  );
+export interface OpenAPIQraftCommandActionOptions extends QraftCommandActionOptions {
+  services: OpenAPIService[];
+  schema: OpenAPISchemaType;
 }
 
 export type QraftCommandActionCallback = (
-  options: {
-    /**
-     * Command inputs, e.g. `bin <input> [options]` where `<input>` is the `inputs` item
-     */
-    inputs: string[];
-    /**
-     * Command arguments, e.g. `bin <input> [options]` where `[options]` is the `args`
-     */
-    args: Record<string, any>;
-    /**
-     * Spinner instance
-     */
-    spinner: Ora;
-    /**
-     * OpenAPI services
-     */
-    services: OpenAPIService[];
-    /**
-     * OpenAPI schema
-     */
-    schema: OpenAPISchemaType;
-    /**
-     * Output options
-     */
-    output: OutputOptions;
-  },
-  resolve: (files: GeneratorFile[]) => void
+  options: OpenAPIQraftCommandActionOptions,
+  resolve: (
+    files: import('@qraft/plugin/lib/GeneratorFile').GeneratorFile[]
+  ) => void
 ) => Promise<void>;
 
-function findSimilarOption(
-  {
-    flags,
-    mandatory,
-  }: {
-    flags: string;
-    mandatory: boolean;
-  },
-  options: readonly Option[]
-) {
-  const newOptionParsedFlags = splitOptionFlags(flags);
-  /** @see {@link https://github.com/tj/commander.js/blob/83c3f4e391754d2f80b179acc4bccc2d4d0c863d/lib/option.js#L15} Source implementation */
-  const optional = flags.includes('['); // A value is optional when the option is specified.
-  const required = flags.includes('<'); // A value must be supplied when the option is specified.
-  // variadic test ignores <value,...> et al which might be used to describe custom splitting of single argument
-  const variadic = /\w\.\.\.[>\]]$/.test(flags); // The option can take multiple values.
-
-  return options.find((existingOption) => {
-    const existingOptionParsedFlags = splitOptionFlags(existingOption.flags);
-
-    if (
-      !(
-        (existingOptionParsedFlags.longFlag !== undefined &&
-          existingOptionParsedFlags.longFlag ===
-            newOptionParsedFlags.longFlag) ||
-        (existingOptionParsedFlags.shortFlag !== undefined &&
-          existingOptionParsedFlags.shortFlag ===
-            newOptionParsedFlags.shortFlag)
-      )
-    ) {
-      return false;
-    }
-
-    if (
-      existingOptionParsedFlags.longFlag !== undefined &&
-      newOptionParsedFlags.longFlag !== undefined &&
-      existingOptionParsedFlags.longFlag !== newOptionParsedFlags.longFlag
-    ) {
-      throw new Error(
-        `Long flag ${flags} already exists in the option list with flags: "${existingOption.flags}" and description: "${existingOption.description}"`
-      );
-    }
-
-    if (
-      existingOptionParsedFlags.shortFlag !== undefined &&
-      newOptionParsedFlags.shortFlag !== undefined &&
-      existingOptionParsedFlags.shortFlag !== newOptionParsedFlags.shortFlag
-    ) {
-      throw new Error(
-        `Short flag ${flags} already exists in the option list with flags: "${existingOption.flags}" and description: "${existingOption.description}"`
-      );
-    }
-
-    if (required !== existingOption.required) {
-      throw new Error(
-        `Flag ${flags} already exists in the option list with flags: "${existingOption.flags}" and description: "${existingOption.description}" but with different required status`
-      );
-    }
-
-    if (optional !== existingOption.optional) {
-      throw new Error(
-        `Flag ${flags} already exists in the option list with flags: "${existingOption.flags}" and description: "${existingOption.description}" but with different optional status`
-      );
-    }
-
-    if (mandatory !== existingOption.mandatory) {
-      throw new Error(
-        `Flag ${flags} already exists in the option list with flags: "${existingOption.flags}" and description: "${existingOption.description}" but with different mandatory status`
-      );
-    }
-
-    if (variadic !== existingOption.variadic) {
-      throw new Error(
-        `Flag ${flags} already exists in the option list with flags: "${existingOption.flags}" and description: "${existingOption.description}" but with different variadic status`
-      );
-    }
-
-    return existingOption;
-  });
-}
-
-/**
- * Split the short and long flag out of something like '-m,--mixed <value>'
- * @link https://github.com/tj/commander.js/blob/83c3f4e391754d2f80b179acc4bccc2d4d0c863d/lib/option.js#L310
- */
-export function splitOptionFlags(flags: string) {
-  let shortFlag;
-  let longFlag;
-
-  // Use original very loose parsing to maintain backwards compatibility for now,
-  // which allowed, for example, unintended `-sw, --short-word` [sic].
-  const flagParts = flags.split(/[ |,]+/);
-
-  if (flagParts.length > 1 && !/^[[<]/.test(flagParts[1]))
-    shortFlag = flagParts.shift();
-
-  longFlag = flagParts.shift();
-
-  // Add support for a lone short flag without significantly changing parsing!
-  if (!shortFlag && /^-[^-]$/.test(longFlag ?? '')) {
-    shortFlag = longFlag;
-    longFlag = undefined;
-  }
-
-  return { shortFlag, longFlag };
-}
-
 function parseColonSeparatedList(value: string, previous: unknown) {
   if (Array.isArray(previous)) {
     const previousValue = previous.at(-1);
@@ -594,9 +267,13 @@ function handleRedoclySchemaInput(
     );
   }
 
-  const api = getRedocAPIsToQraft(redoc, cwd, spinner, inputAPIName)[
+  const api = getRedocAPIsToQraft(
+    redoc,
+    cwd,
+    spinner,
+    OPENAPI_QRAFT_REDOC_CONFIG_KEY,
     inputAPIName
-  ];
+  )[inputAPIName];
 
   if (!api)
     throw new CommanderError(

package/src/lib/QraftCommandPlugin.ts

@@ -1,13 +1,4 @@
+import { QraftCommandPlugin as QraftCommandPluginBase } from '@qraft/plugin';
 import { QraftCommand } from './QraftCommand.js';
 
-export interface QraftCommandPlugin {
-  setupCommand(command: QraftCommand): void | Promise<void>;
-
-  /**
-   * Called after all plugins have been set up
-   */
-  postSetupCommand?(
-    command: QraftCommand,
-    plugins: string[]
-  ): void | Promise<void>;
-}
+export interface QraftCommandPlugin extends QraftCommandPluginBase<QraftCommand> {}

package/src/packageVersion.ts

@@ -1,2 +1,2 @@
 // This file was generated automatically
-export const packageVersion = '2.15.0-beta.0';
+export const packageVersion = '2.15.0-beta.2';

package/dist/lib/GeneratorFile.d.ts

@@ -1,9 +0,0 @@
-import type { URL } from 'node:url';
-export type GeneratorFile = {
-    file: URL;
-    code: string;
-} | {
-    directory: URL;
-    clean: boolean;
-};
-//# sourceMappingURL=GeneratorFile.d.ts.map

package/dist/lib/GeneratorFile.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"GeneratorFile.d.ts","sourceRoot":"","sources":["../../src/lib/GeneratorFile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAEpC,MAAM,MAAM,aAAa,GACrB;IAAE,IAAI,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC3B;IAAE,SAAS,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC"}

package/dist/lib/GeneratorFile.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=GeneratorFile.js.map

package/dist/lib/GeneratorFile.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"GeneratorFile.js","sourceRoot":"","sources":["../../src/lib/GeneratorFile.ts"],"names":[],"mappings":""}

package/dist/lib/OutputOptions.d.ts

@@ -1,6 +0,0 @@
-import { URL } from 'node:url';
-export interface OutputOptions {
-    dir: URL;
-    clean: boolean;
-}
-//# sourceMappingURL=OutputOptions.d.ts.map

package/dist/lib/OutputOptions.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"OutputOptions.d.ts","sourceRoot":"","sources":["../../src/lib/OutputOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,GAAG,CAAC;IACT,KAAK,EAAE,OAAO,CAAC;CAChB"}

package/dist/lib/OutputOptions.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=OutputOptions.js.map

package/dist/lib/OutputOptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"OutputOptions.js","sourceRoot":"","sources":["../../src/lib/OutputOptions.ts"],"names":[],"mappings":""}

package/dist/lib/RedoclyConfigCommand.d.ts

@@ -1,22 +0,0 @@
-import { URL } from 'node:url';
-import { Command, Option, ParseOptions } from 'commander';
-export declare const redoclyOption: Option;
-/**
- * @param name - not used
- */
-export declare class RedoclyConfigCommand extends Command {
-    protected readonly cwd: URL;
-    /**
-     * Redocly API item and QraftCommand arguments
-     */
-    protected parsedAPIs: RedoclyQraftAPIs;
-    constructor(name?: string);
-    parseConfig<T>(callbackFn: CallbackFn<T>, argv: readonly string[], options?: ParseOptions): Promise<T[] | undefined>;
-    static forEachRedoclyAPIEntry<T>(redoclyAPIs: RedoclyQraftAPIs, callbackFn: CallbackFn<T>): Promise<T[]>;
-}
-type CallbackFn<T> = (processArgv: string[], processArgvParseOptions?: ParseOptions) => T;
-type RedoclyQraftAPIs = {
-    [apiName: string]: string[];
-};
-export {};
-//# sourceMappingURL=RedoclyConfigCommand.d.ts.map

package/dist/lib/RedoclyConfigCommand.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RedoclyConfigCommand.d.ts","sourceRoot":"","sources":["../../src/lib/RedoclyConfigCommand.ts"],"names":[],"mappings":"AACA,OAAO,EAAgC,GAAG,EAAE,MAAM,UAAU,CAAC;AAG7D,OAAO,EAAE,OAAO,EAAkB,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAO1E,eAAO,MAAM,aAAa,QAqBtB,CAAC;AACL;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,OAAO;IAC/C,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,gBAAgB,CAAM;gBAEhC,IAAI,CAAC,EAAE,MAAM;IA6FnB,WAAW,CAAC,CAAC,EACjB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACzB,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC;WAWd,sBAAsB,CAAC,CAAC,EACnC,WAAW,EAAE,gBAAgB,EAC7B,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;CAoE5B;AAED,KAAK,UAAU,CAAC,CAAC,IAAI,CACnB,WAAW,EAAE,MAAM,EAAE,EACrB,uBAAuB,CAAC,EAAE,YAAY,KACnC,CAAC,CAAC;AAEP,KAAK,gBAAgB,GAAG;IACtB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC7B,CAAC"}