@openapi-qraft/plugin 2.3.2 → 2.4.1

package/dist/lib/open-api/readSchema.js

@@ -1,11 +1,5 @@
-import { createConfig } from '@redocly/openapi-core';
 import { validateAndBundle } from 'openapi-typescript/dist/lib/redoc.js';
-export const readSchema = async (source) => {
-    const redoc = await createConfig({
-        rules: {
-            'operation-operationId-unique': { severity: 'error' }, // throw error on duplicate operationIDs
-        },
-    }, { extends: ['minimal'] });
+export const readSchema = async (source, redoc) => {
     const parsed = await validateAndBundle(source, {
         redoc,
         silent: false,

package/dist/lib/open-api/readSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"readSchema.js","sourceRoot":"","sources":["../../../src/lib/open-api/readSchema.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAEzE,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAC7B,MAAmD,EACnD,EAAE;IACF,MAAM,KAAK,GAAG,MAAM,YAAY,CAC9B;QACE,KAAK,EAAE;YACL,8BAA8B,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,wCAAwC;SAChG;KACF,EACD,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE,CACzB,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,MAAM,EAAE;QAC7C,KAAK;QACL,MAAM,EAAE,KAAK;KACd,CAAC,CAAC;IAEH,OAAO,MAAkB,CAAC;AAC5B,CAAC,CAAC"}
+{"version":3,"file":"readSchema.js","sourceRoot":"","sources":["../../../src/lib/open-api/readSchema.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAEzE,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAC7B,MAAmD,EACnD,KAAa,EACb,EAAE;IACF,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,MAAM,EAAE;QAC7C,KAAK;QACL,MAAM,EAAE,KAAK;KACd,CAAC,CAAC;IAEH,OAAO,MAAkB,CAAC;AAC5B,CAAC,CAAC"}

package/dist/lib/parseConfigToArgs.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts a parsed YAML configuration into command line arguments
+ * @param config The parsed YAML configuration object
+ * @returns Array of command line arguments
+ */
+export declare function parseConfigToArgs(config: Record<string, unknown>): string[];
+//# sourceMappingURL=parseConfigToArgs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parseConfigToArgs.d.ts","sourceRoot":"","sources":["../../src/lib/parseConfigToArgs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,CAgI3E"}

package/dist/lib/parseConfigToArgs.js

@@ -0,0 +1,130 @@
+/**
+ * Converts a parsed YAML configuration into command line arguments
+ * @param config The parsed YAML configuration object
+ * @returns Array of command line arguments
+ */
+export function parseConfigToArgs(config) {
+    const args = [];
+    const isPrimitive = (val) => typeof val === 'string' ||
+        typeof val === 'number' ||
+        typeof val === 'boolean';
+    function flattenMapping(node, prefixKeys) {
+        const results = [];
+        if (isPrimitive(node)) {
+            if (typeof node === 'boolean') {
+                if (node) {
+                    results.push(prefixKeys.join(':'));
+                }
+            }
+            else {
+                results.push(`${prefixKeys.join(':')}:${node.toString()}`);
+            }
+            return results;
+        }
+        if (Array.isArray(node)) {
+            if (node.every((el) => isPrimitive(el))) {
+                const primitives = node.filter((el) => el !== null && el !== undefined);
+                const joined = primitives.map((el) => el.toString()).join(',');
+                if (joined) {
+                    results.push(`${prefixKeys.join(':')}:${joined}`);
+                }
+                return results;
+            }
+            for (const el of node) {
+                if (el == null) {
+                    continue;
+                }
+                results.push(...flattenMapping(el, prefixKeys));
+            }
+            return results;
+        }
+        if (typeof node === 'object' && node !== null) {
+            for (const [key, value] of Object.entries(node)) {
+                results.push(...flattenMapping(value, [...prefixKeys, key]));
+            }
+            return results;
+        }
+        return results;
+    }
+    for (const [key, value] of Object.entries(config)) {
+        if (typeof value === 'string' || typeof value === 'number') {
+            args.push(`--${key}`, value.toString());
+        }
+        else if (typeof value === 'boolean') {
+            if (value) {
+                args.push(`--${key}`);
+            }
+        }
+        else if (value == null) {
+            continue;
+        }
+        else if (Array.isArray(value)) {
+            if (value.every((el) => isPrimitive(el))) {
+                const primitives = value.filter((el) => el !== null && el !== undefined);
+                args.push(`--${key}`, ...primitives.map((el) => el.toString()));
+            }
+            else {
+                for (const el of value) {
+                    if (el == null) {
+                        continue;
+                    }
+                    if (typeof el === 'object') {
+                        const mappingPaths = flattenMapping(el, []);
+                        if (mappingPaths.length) {
+                            args.push(`--${key}`, ...mappingPaths);
+                        }
+                    }
+                    else if (isPrimitive(el)) {
+                        args.push(`--${key}`, el.toString());
+                    }
+                }
+            }
+        }
+        else if (typeof value === 'object') {
+            for (const [childKey, childValue] of Object.entries(value)) {
+                if (typeof childValue === 'string' || typeof childValue === 'number') {
+                    args.push(`--${key}`, childKey, childValue.toString());
+                }
+                else if (typeof childValue === 'boolean') {
+                    if (childValue) {
+                        args.push(`--${key}`, childKey);
+                    }
+                }
+                else if (childValue == null) {
+                    continue;
+                }
+                else if (Array.isArray(childValue)) {
+                    if (childValue.every((el) => isPrimitive(el))) {
+                        const primitives = childValue.filter((el) => el !== null && el !== undefined);
+                        const joined = primitives.map((el) => el.toString()).join(',');
+                        args.push(`--${key}`, childKey, joined);
+                    }
+                    else {
+                        for (const el of childValue) {
+                            if (el == null) {
+                                continue;
+                            }
+                            if (typeof el === 'object') {
+                                const mappingPaths = flattenMapping(el, [childKey]);
+                                if (mappingPaths.length) {
+                                    args.push(`--${key}`, ...mappingPaths);
+                                }
+                            }
+                            else if (isPrimitive(el)) {
+                                args.push(`--${key}`, childKey, el.toString());
+                            }
+                        }
+                    }
+                }
+                else if (typeof childValue === 'object') {
+                    const mappingPaths = flattenMapping(childValue, []);
+                    if (mappingPaths.length) {
+                        args.push(`--${key}`, childKey, ...mappingPaths);
+                    }
+                }
+            }
+        }
+    }
+    return args;
+}
+//# sourceMappingURL=parseConfigToArgs.js.map

package/dist/lib/parseConfigToArgs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseConfigToArgs.js","sourceRoot":"","sources":["../../src/lib/parseConfigToArgs.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAA+B;IAC/D,MAAM,IAAI,GAAa,EAAE,CAAC;IAE1B,MAAM,WAAW,GAAG,CAAC,GAAQ,EAAoC,EAAE,CACjE,OAAO,GAAG,KAAK,QAAQ;QACvB,OAAO,GAAG,KAAK,QAAQ;QACvB,OAAO,GAAG,KAAK,SAAS,CAAC;IAE3B,SAAS,cAAc,CAAC,IAAS,EAAE,UAAoB;QACrD,MAAM,OAAO,GAAa,EAAE,CAAC;QAE7B,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC9B,IAAI,IAAI,EAAE,CAAC;oBACT,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;gBACrC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAC7D,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBACxC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAC5B,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,SAAS,CACP,CAAC;gBACnC,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC/D,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC;gBACpD,CAAC;gBACD,OAAO,OAAO,CAAC;YACjB,CAAC;YAED,KAAK,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC;gBACtB,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;oBACf,SAAS;gBACX,CAAC;gBACD,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAC9C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChD,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,KAAK,EAAE,CAAC,GAAG,UAAU,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;YAC/D,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC3D,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC1C,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;YACtC,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YACzB,SAAS;QACX,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBACzC,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAC7B,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,SAAS,CACP,CAAC;gBACnC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YAClE,CAAC;iBAAM,CAAC;gBACN,KAAK,MAAM,EAAE,IAAI,KAAK,EAAE,CAAC;oBACvB,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;wBACf,SAAS;oBACX,CAAC;oBACD,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;wBAC3B,MAAM,YAAY,GAAG,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC5C,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;4BACxB,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,GAAG,YAAY,CAAC,CAAC;wBACzC,CAAC;oBACH,CAAC;yBAAM,IAAI,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;wBAC3B,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;oBACvC,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrC,KAAK,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,MAAM,CAAC,OAAO,CACjD,KAAgC,CACjC,EAAE,CAAC;gBACF,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;oBACrE,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;gBACzD,CAAC;qBAAM,IAAI,OAAO,UAAU,KAAK,SAAS,EAAE,CAAC;oBAC3C,IAAI,UAAU,EAAE,CAAC;wBACf,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC;oBAClC,CAAC;gBACH,CAAC;qBAAM,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;oBAC9B,SAAS;gBACX,CAAC;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;oBACrC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;wBAC9C,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAClC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,SAAS,CACP,CAAC;wBACnC,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAC/D,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;oBAC1C,CAAC;yBAAM,CAAC;wBACN,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;4BAC5B,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;gCACf,SAAS;4BACX,CAAC;4BACD,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;gCAC3B,MAAM,YAAY,GAAG,cAAc,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;gCACpD,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;oCACxB,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,GAAG,YAAY,CAAC,CAAC;gCACzC,CAAC;4BACH,CAAC;iCAAM,IAAI,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;gCAC3B,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;4BACjD,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;qBAAM,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;oBAC1C,MAAM,YAAY,GAAG,cAAc,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;oBACpD,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;wBACxB,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,YAAY,CAAC,CAAC;oBACnD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/lib/shouldQuoteCommandLineArg.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Checks if a command-line argument needs to be quoted when used in a command line.
+ *
+ * Arguments containing special characters like spaces, quotes, or shell metacharacters
+ * need to be wrapped in quotes to be properly interpreted by the shell.
+ *
+ * @param arg The command-line argument to check
+ * @returns True if the argument needs quotes, false otherwise
+ */
+export declare function shouldQuoteCommandLineArg(arg: string): boolean;
+//# sourceMappingURL=shouldQuoteCommandLineArg.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shouldQuoteCommandLineArg.d.ts","sourceRoot":"","sources":["../../src/lib/shouldQuoteCommandLineArg.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAsB9D"}

package/dist/lib/shouldQuoteCommandLineArg.js

@@ -0,0 +1,33 @@
+/**
+ * Checks if a command-line argument needs to be quoted when used in a command line.
+ *
+ * Arguments containing special characters like spaces, quotes, or shell metacharacters
+ * need to be wrapped in quotes to be properly interpreted by the shell.
+ *
+ * @param arg The command-line argument to check
+ * @returns True if the argument needs quotes, false otherwise
+ */
+export function shouldQuoteCommandLineArg(arg) {
+    if (!arg)
+        return false;
+    // Check for spaces
+    if (arg.includes(' '))
+        return true;
+    // Check for quotes
+    if (arg.includes('"') || arg.includes("'"))
+        return true;
+    // Check for shell metacharacters and special characters
+    const shellSpecialChars = /[&|<>(){}[\]$;!*?~`\n\r\t#]/;
+    if (shellSpecialChars.test(arg))
+        return true;
+    // Check for control characters
+    // eslint-disable-next-line no-control-regex
+    if (/[\x00-\x1F\x7F]/.test(arg))
+        return true;
+    // Check if argument starts with a dash (to avoid confusion with options)
+    if (arg.startsWith('-') && !arg.startsWith('--'))
+        return true;
+    // Check for wildcards
+    return arg.includes('*') || arg.includes('?');
+}
+//# sourceMappingURL=shouldQuoteCommandLineArg.js.map

package/dist/lib/shouldQuoteCommandLineArg.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shouldQuoteCommandLineArg.js","sourceRoot":"","sources":["../../src/lib/shouldQuoteCommandLineArg.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,UAAU,yBAAyB,CAAC,GAAW;IACnD,IAAI,CAAC,GAAG;QAAE,OAAO,KAAK,CAAC;IAEvB,mBAAmB;IACnB,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAEnC,mBAAmB;IACnB,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAExD,wDAAwD;IACxD,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;IACxD,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAE7C,+BAA+B;IAC/B,4CAA4C;IAC5C,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAE7C,yEAAyE;IACzE,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAE9D,sBAAsB;IACtB,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAChD,CAAC"}

package/dist/packageVersion.d.ts

@@ -1,2 +1,2 @@
-export declare const packageVersion = "2.3.2";
+export declare const packageVersion = "2.4.1";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.js

@@ -1,3 +1,3 @@
 // This file was generated automatically
-export const packageVersion = '2.3.2';
+export const packageVersion = '2.4.1';
 //# sourceMappingURL=packageVersion.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-qraft/plugin",
-  "version": "2.3.2",
+  "version": "2.4.1",
   "packageManager": "yarn@4.0.2",
   "type": "module",
   "scripts": {
@@ -78,6 +78,6 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/OpenAPI-Qraft/openapi-qraft.git",
-    "directory": "packages/cli"
+    "directory": "packages/plugin"
   }
 }

package/src/lib/QraftCommand.ts

@@ -1,14 +1,16 @@
-import type { Option } from 'commander';
 import { sep } from 'node:path';
 import process from 'node:process';
 import { pathToFileURL, URL } from 'node:url';
+import { Config, createConfig, getMergedConfig } from '@redocly/openapi-core';
 import c from 'ansi-colors';
-import { Command } from 'commander';
+import { Command, CommanderError, Option, ParseOptions } from 'commander';
 import ora, { 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';
@@ -23,15 +25,21 @@ 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();
+
   protected readonly cwd: URL;
   protected registeredPluginActions: QraftCommandActionCallback[] = [];
 
-  constructor() {
-    super();
+  /**
+   * @param name - not used
+   */
+  constructor(name?: string) {
+    super(name);
     this.cwd = pathToFileURL(`${process.cwd()}/`);
 
     this.usage('[input] [options]')
@@ -40,39 +48,47 @@ export class QraftCommand extends Command {
         'Input OpenAPI Document file path, URL (json, yml)',
         null
       )
-      .requiredOption(
+      .option(
         '-o, --output-dir <path>',
         'Output directory for generated services'
       )
-      .option(
-        '-rm, --clean',
-        'Clean output directory before generating services'
+      .addOption(
+        new Option(
+          '-rm, --clean',
+          'Clean output directory before generating services'
+        )
       )
       .option(
         '--filter-services <glob-patterns...>',
-        'Filter services to be generated by glob pattern. Eg: "/user/**,/post/**". See NPM `micromatch` package for more details.'
+        'Filter services to be generated using glob patterns. Example: "/user/**,/post/**". For more details, see the NPM `micromatch` package documentation.'
       )
       .option(
         '--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"'
+        '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"',
+        parseColonSeparatedList
       )
       .option(
         '--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"'
       )
-      .option(
-        '--postfix-services <string>',
-        'Postfix to be added to the generated service name (eg: Service)'
+      .addOption(
+        new Option(
+          '--postfix-services <string>',
+          'Postfix to be added to the generated service name (eg: Service)'
+        )
       )
       .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]'
       )
-      .option(
-        '--file-header <string>',
-        'Header to be added to the generated file (eg: /* eslint-disable */)'
-      );
+      .addOption(
+        new Option(
+          '--file-header <string>',
+          'Header to be added to the generated file (eg: /* eslint-disable */)'
+        )
+      )
+      .addOption(redoclyOption);
   }
 
   action(callback: QraftCommandActionCallback): this {
@@ -95,15 +111,33 @@ export class QraftCommand extends Command {
       process.exit(0);
     }
 
-    console.info(`✨ ${c.bold(`OpenAPI Qraft ${packageVersion}`)}`);
+    const spinner = QraftCommand.spinner;
+
+    spinner.start('Initializing process...');
+
+    const redoc = args.redocly
+      ? getMergedConfig(
+          await loadRedoclyConfig(args.redocly, this.cwd),
+          inputs[0]
+        )
+      : await createConfig(
+          {
+            rules: {
+              // throw error on duplicate operationIDs
+              'operation-operationId-unique': { severity: 'error' },
+            },
+          },
+          { extends: ['minimal'] }
+        );
 
-    const spinner = ora('Starting ⛏︎').start();
+    const input = args.redocly
+      ? handleRedoclySchemaInput(redoc, inputs[0], this.cwd, spinner)
+      : handleSchemaInput(inputs[0], this.cwd, spinner);
 
-    const input = handleSchemaInput(inputs[0], this.cwd, spinner);
+    spinner.text = 'Reading OpenAPI Document...';
 
-    spinner.text = 'Reading OpenAPI Schema';
     let schema = filterDocumentPaths(
-      await readSchema(input),
+      await readSchema(input, redoc),
       splitCommaSeparatedGlobs(args.filterServices)
     );
 
@@ -122,7 +156,7 @@ export class QraftCommand extends Command {
       if (predefinedParametersErrors.length) {
         predefinedParametersErrors.forEach((error) => spinner.warn(error));
         spinner.fail(
-          'Error occurred during operation predefined parameters setup.'
+          'An error occurred while setting up operation predefined parameters.'
         );
         process.exit(1);
       }
@@ -130,7 +164,7 @@ export class QraftCommand extends Command {
       schema = predefineSchemaParameters(schema, predefinedParametersGlobs);
     }
 
-    spinner.text = 'Getting OpenAPI Services';
+    spinner.text = 'Retrieving OpenAPI Services...';
     let services = getServices(schema as OpenAPISchemaType, {
       postfixServices: args.postfixServices,
       serviceNameBase: args.serviceNameBase,
@@ -188,7 +222,7 @@ export class QraftCommand extends Command {
       services = modifiedServicesOperationNames;
     }
 
-    spinner.text = 'Generating code';
+    spinner.text = 'Generating code...';
 
     const outputDir = normalizeOutputDirPath(args.outputDir);
 
@@ -223,7 +257,9 @@ export class QraftCommand extends Command {
           await writeGeneratorFiles({ fileItems, spinner });
         }
       } catch (error) {
-        spinner.fail(c.red('Error occurred during generation'));
+        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 ?? ''));
@@ -233,7 +269,7 @@ export class QraftCommand extends Command {
       }
     }
 
-    spinner.succeed(c.green('Qraft has been finished'));
+    spinner.succeed(c.green('Qraft process completed successfully'));
   }
 
   protected registerPluginAction(callback: QraftCommandActionCallback) {
@@ -334,6 +370,35 @@ export class QraftCommand extends Command {
     );
   }
 
+  addOption(option: Option): this {
+    if (
+      this.findSimilarOption({
+        flags: option.flags,
+        mandatory: option.mandatory,
+      })
+    ) {
+      return this;
+    }
+
+    return super.addOption(option);
+  }
+
+  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() {
+    QraftCommand.spinner.info(
+      `✨ ${c.bold(`OpenAPI Qraft ${packageVersion}`)}`
+    );
+  }
+
   protected findSimilarOption(option: { flags: string; mandatory: boolean }) {
     try {
       return findSimilarOption(option, this.options);
@@ -342,7 +407,7 @@ export class QraftCommand extends Command {
         c.red(
           error instanceof Error
             ? error.message
-            : 'Error occurred during option setup'
+            : 'An error occurred during command option setup'
         )
       );
 
@@ -496,3 +561,49 @@ export function splitOptionFlags(flags: string) {
 
   return { shortFlag, longFlag };
 }
+
+function parseColonSeparatedList(value: string, previous: unknown) {
+  if (Array.isArray(previous)) {
+    const previousValue = previous.at(-1);
+
+    if (
+      typeof previousValue === 'string' &&
+      !previousValue.includes(':') &&
+      !value.includes(':')
+    ) {
+      return previous.slice(0, -1).concat(`${previousValue}:${value}`);
+    }
+
+    return previous.concat(value);
+  }
+
+  return [value];
+}
+
+function handleRedoclySchemaInput(
+  redoc: Config,
+  inputAPIName: string,
+  cwd: URL,
+  spinner: Ora
+) {
+  if (!inputAPIName) {
+    throw new CommanderError(
+      1,
+      'ERR_MISSING_API',
+      'No API specified. Please specify the API to be generated.'
+    );
+  }
+
+  const api = getRedocAPIsToQraft(redoc, cwd, spinner, inputAPIName)[
+    inputAPIName
+  ];
+
+  if (!api)
+    throw new CommanderError(
+      1,
+      'ERR_MISSING_API',
+      `API not found in Redocly API (${inputAPIName}) found in the Redocly configuration: ${inputAPIName}. Please specify the correct API.`
+    );
+
+  return new URL(api['root'], cwd);
+}