@redocly/cli 1.25.15 → 1.26.1

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @redocly/cli
 
+## 1.26.1
+
+### Patch Changes
+
+- Fixed an issue where an API alias's root path might be resolved incorrectly for configuration files located outside the root folder.
+- Updated @redocly/openapi-core to v1.26.1.
+
+## 1.26.0
+
+### Minor Changes
+
+- Introduced the `struct` rule and deprecated the `spec` rule.
+  Added the `spec` ruleset, which enforces compliance with the specifications.
+
+### Patch Changes
+
+- Fixed an issue where the CLI would fail to run on Windows due to a breaking change in the Node.js API.
+- Fixed an issue where `join` would throw an error when a glob pattern was provided.
+- Updated `sourceDescriptions` to enforce a valid type field, ensuring compliance with the Arazzo specification.
+- Updated @redocly/openapi-core to v1.26.0.
+
 ## 1.25.15
 
 ### Patch Changes

package/lib/__tests__/commands/join.test.js

@@ -13,7 +13,29 @@ describe('handleJoin', () => {
     colloreteYellowMock.mockImplementation((string) => string);
     it('should call exitWithError because only one entrypoint', async () => {
         await (0, join_1.handleJoin)({ argv: { apis: ['first.yaml'] }, config: {}, version: 'cli-version' });
-        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided.`);
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`At least 2 APIs should be provided.`);
+    });
+    it('should call exitWithError if glob expands to less than 2 APIs', async () => {
+        miscellaneous_1.getFallbackApisOrExit.mockResolvedValueOnce([{ path: 'first.yaml' }]);
+        await (0, join_1.handleJoin)({
+            argv: { apis: ['*.yaml'] },
+            config: {},
+            version: 'cli-version',
+        });
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`At least 2 APIs should be provided.`);
+    });
+    it('should proceed if glob expands to 2 or more APIs', async () => {
+        openapi_core_1.detectSpec.mockReturnValue('oas3_1');
+        miscellaneous_1.getFallbackApisOrExit.mockResolvedValueOnce([
+            { path: 'first.yaml' },
+            { path: 'second.yaml' },
+        ]);
+        await (0, join_1.handleJoin)({
+            argv: { apis: ['*.yaml'] },
+            config: config_1.ConfigFixture,
+            version: 'cli-version',
+        });
+        expect(miscellaneous_1.exitWithError).not.toHaveBeenCalled();
     });
     it('should call exitWithError because passed all 3 options for tags', async () => {
         await (0, join_1.handleJoin)({
@@ -41,6 +63,7 @@ describe('handleJoin', () => {
         expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one!`);
     });
     it('should call exitWithError because Only OpenAPI 3.0 and OpenAPI 3.1 are supported', async () => {
+        openapi_core_1.detectSpec.mockReturnValueOnce('oas2_0');
         await (0, join_1.handleJoin)({
             argv: {
                 apis: ['first.yaml', 'second.yaml'],

package/lib/__tests__/utils.test.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const miscellaneous_1 = require("../utils/miscellaneous");
+const platform_1 = require("../utils/platform");
 const openapi_core_1 = require("@redocly/openapi-core");
 const colorette_1 = require("colorette");
 const fs_1 = require("fs");
@@ -407,7 +408,7 @@ describe('checkIfRulesetExist', () => {
             oas3_1: {},
             async2: {},
             async3: {},
-            arazzo: {},
+            arazzo1: {},
         };
         expect(() => (0, miscellaneous_1.checkIfRulesetExist)(rules)).toThrowError('⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/');
     });
@@ -530,3 +531,63 @@ describe('writeToFileByExtension', () => {
         expect(process.stderr.write).toHaveBeenCalledWith(`test data`);
     });
 });
+describe('runtime platform', () => {
+    describe('sanitizePath', () => {
+        test.each([
+            ['C:\\Program Files\\App', 'C:\\Program Files\\App'],
+            ['/usr/local/bin/app', '/usr/local/bin/app'],
+            ['invalid|path?name*', 'invalidpathname'],
+            ['', ''],
+            ['<>:"|?*', ':'],
+            ['C:/Program Files\\App', 'C:/Program Files\\App'],
+            ['path\nname\r', 'pathname'],
+            ['/usr/local; rm -rf /', '/usr/local rm -rf /'],
+            ['C:\\data&& dir', 'C:\\data dir'],
+        ])('should sanitize path %s to %s', (input, expected) => {
+            expect((0, platform_1.sanitizePath)(input)).toBe(expected);
+        });
+    });
+    describe('sanitizeLocale', () => {
+        test.each([
+            ['en-US', 'en-US'],
+            ['fr_FR', 'fr_FR'],
+            ['en<>US', 'enUS'],
+            ['fr@FR', 'fr@FR'],
+            ['en_US@#$%', 'en_US@'],
+            [' en-US ', 'en-US'],
+            ['', ''],
+        ])('should sanitize locale %s to %s', (input, expected) => {
+            expect((0, platform_1.sanitizeLocale)(input)).toBe(expected);
+        });
+    });
+    describe('getPlatformSpawnArgs', () => {
+        const originalPlatform = process.platform;
+        afterEach(() => {
+            Object.defineProperty(process, 'platform', {
+                value: originalPlatform,
+            });
+        });
+        it('should return args for Windows platform', () => {
+            Object.defineProperty(process, 'platform', {
+                value: 'win32',
+            });
+            const result = (0, platform_1.getPlatformSpawnArgs)();
+            expect(result).toEqual({
+                npxExecutableName: 'npx.cmd',
+                sanitize: expect.any(Function),
+                shell: true,
+            });
+        });
+        it('should return args for non-Windows platform', () => {
+            Object.defineProperty(process, 'platform', {
+                value: 'linux',
+            });
+            const result = (0, platform_1.getPlatformSpawnArgs)();
+            expect(result).toEqual({
+                npxExecutableName: 'npx',
+                sanitize: expect.any(Function),
+                shell: false,
+            });
+        });
+    });
+});

package/lib/commands/bundle.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleBundle = handleBundle;
+const path_1 = require("path");
 const perf_hooks_1 = require("perf_hooks");
 const colorette_1 = require("colorette");
 const fs_1 = require("fs");
@@ -20,7 +21,7 @@ async function handleBundle({ argv, config, version, collectSpecData, }) {
             const { styleguide } = resolvedConfig;
             styleguide.skipPreprocessors(argv['skip-preprocessor']);
             styleguide.skipDecorators(argv['skip-decorator']);
-            process.stderr.write((0, colorette_1.gray)(`bundling ${path}...\n`));
+            process.stderr.write((0, colorette_1.gray)(`bundling ${(0, path_1.relative)(process.cwd(), path)}...\n`));
             const { bundle: result, problems, ...meta } = await (0, openapi_core_1.bundle)({
                 config: resolvedConfig,
                 ref: path,
@@ -66,14 +67,14 @@ async function handleBundle({ argv, config, version, collectSpecData, }) {
             const elapsed = (0, miscellaneous_1.getExecutionTime)(startedAt);
             if (fileTotals.errors > 0) {
                 if (argv.force) {
-                    process.stderr.write(`❓ Created a bundle for ${(0, colorette_1.blue)(path)} at ${(0, colorette_1.blue)(outputFile || 'stdout')} with errors ${(0, colorette_1.green)(elapsed)}.\n${(0, colorette_1.yellow)('Errors ignored because of --force')}.\n`);
+                    process.stderr.write(`❓ Created a bundle for ${(0, colorette_1.blue)((0, path_1.relative)(process.cwd(), path))} at ${(0, colorette_1.blue)(outputFile || 'stdout')} with errors ${(0, colorette_1.green)(elapsed)}.\n${(0, colorette_1.yellow)('Errors ignored because of --force')}.\n`);
                 }
                 else {
-                    process.stderr.write(`❌ Errors encountered while bundling ${(0, colorette_1.blue)(path)}: bundle not created (use --force to ignore errors).\n`);
+                    process.stderr.write(`❌ Errors encountered while bundling ${(0, colorette_1.blue)((0, path_1.relative)(process.cwd(), path))}: bundle not created (use --force to ignore errors).\n`);
                 }
             }
             else {
-                process.stderr.write(`📦 Created a bundle for ${(0, colorette_1.blue)(path)} at ${(0, colorette_1.blue)(outputFile || 'stdout')} ${(0, colorette_1.green)(elapsed)}.\n`);
+                process.stderr.write(`📦 Created a bundle for ${(0, colorette_1.blue)((0, path_1.relative)(process.cwd(), path))} at ${(0, colorette_1.blue)(outputFile || 'stdout')} ${(0, colorette_1.green)(elapsed)}.\n`);
             }
             const removedCount = meta.visitorsData?.['remove-unused-components']?.removedCount;
             if (removedCount) {

package/lib/commands/eject.js

@@ -2,17 +2,27 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleEject = void 0;
 const child_process_1 = require("child_process");
+const platform_1 = require("../utils/platform");
 const handleEject = async ({ argv }) => {
     process.stdout.write(`\nLaunching eject using NPX.\n\n`);
-    const npxExecutableName = process.platform === 'win32' ? 'npx.cmd' : 'npx';
-    (0, child_process_1.spawn)(npxExecutableName, [
+    const { npxExecutableName, sanitize, shell } = (0, platform_1.getPlatformSpawnArgs)();
+    const path = sanitize(argv.path, platform_1.sanitizePath);
+    const projectDir = sanitize(argv['project-dir'], platform_1.sanitizePath);
+    const child = (0, child_process_1.spawn)(npxExecutableName, [
         '-y',
         '@redocly/realm',
         'eject',
         `${argv.type}`,
-        `${argv.path ?? ''}`,
-        `-d=${argv['project-dir']}`,
+        path,
+        `-d=${projectDir}`,
         argv.force ? `--force=${argv.force}` : '',
-    ], { stdio: 'inherit' });
+    ], {
+        stdio: 'inherit',
+        shell,
+    });
+    child.on('error', (error) => {
+        process.stderr.write(`Eject launch failed: ${error.message}`);
+        throw new Error('Eject launch failed.');
+    });
 };
 exports.handleEject = handleEject;

package/lib/commands/join.js

@@ -15,11 +15,7 @@ const xTagGroups = 'x-tagGroups';
 let potentialConflictsTotal = 0;
 async function handleJoin({ argv, config, version: packageVersion, }) {
     const startedAt = perf_hooks_1.performance.now();
-    if (argv.apis.length < 2) {
-        return (0, miscellaneous_1.exitWithError)(`At least 2 apis should be provided.`);
-    }
-    const fileExtension = (0, miscellaneous_1.getAndValidateFileExtension)(argv.output || argv.apis[0]);
-    const { 'prefix-components-with-info-prop': prefixComponentsWithInfoProp, 'prefix-tags-with-filename': prefixTagsWithFilename, 'prefix-tags-with-info-prop': prefixTagsWithInfoProp, 'without-x-tag-groups': withoutXTagGroups, output: specFilename = `openapi.${fileExtension}`, } = argv;
+    const { 'prefix-components-with-info-prop': prefixComponentsWithInfoProp, 'prefix-tags-with-filename': prefixTagsWithFilename, 'prefix-tags-with-info-prop': prefixTagsWithInfoProp, 'without-x-tag-groups': withoutXTagGroups, output, } = argv;
     const usedTagsOptions = [
         prefixTagsWithFilename && 'prefix-tags-with-filename',
         prefixTagsWithInfoProp && 'prefix-tags-with-info-prop',
@@ -29,6 +25,11 @@ async function handleJoin({ argv, config, version: packageVersion, }) {
         return (0, miscellaneous_1.exitWithError)(`You use ${(0, colorette_1.yellow)(usedTagsOptions.join(', '))} together.\nPlease choose only one!`);
     }
     const apis = await (0, miscellaneous_1.getFallbackApisOrExit)(argv.apis, config);
+    if (apis.length < 2) {
+        return (0, miscellaneous_1.exitWithError)(`At least 2 APIs should be provided.`);
+    }
+    const fileExtension = (0, miscellaneous_1.getAndValidateFileExtension)(output || apis[0].path);
+    const specFilename = output || `openapi.${fileExtension}`;
     const externalRefResolver = new openapi_core_1.BaseResolver(config.resolve);
     const documents = await Promise.all(apis.map(({ path }) => externalRefResolver.resolveDocument(null, path, true)));
     const decorators = new Set([

package/lib/commands/lint.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleLint = handleLint;
 exports.lintConfigCallback = lintConfigCallback;
+const path_1 = require("path");
 const colorette_1 = require("colorette");
 const perf_hooks_1 = require("perf_hooks");
 const openapi_core_1 = require("@redocly/openapi-core");
@@ -31,7 +32,7 @@ async function handleLint({ argv, config, version, collectSpecData, }) {
             if (styleguide.recommendedFallback) {
                 process.stderr.write(`No configurations were provided -- using built in ${(0, colorette_1.blue)('recommended')} configuration by default.\n\n`);
             }
-            process.stderr.write((0, colorette_1.gray)(`validating ${path.replace(process.cwd(), '')}...\n`));
+            process.stderr.write((0, colorette_1.gray)(`validating ${(0, path_1.relative)(process.cwd(), path)}...\n`));
             const results = await (0, openapi_core_1.lint)({
                 ref: path,
                 config: resolvedConfig,
@@ -56,7 +57,7 @@ async function handleLint({ argv, config, version, collectSpecData, }) {
                 });
             }
             const elapsed = (0, miscellaneous_1.getExecutionTime)(startedAt);
-            process.stderr.write((0, colorette_1.gray)(`${path.replace(process.cwd(), '')}: validated in ${elapsed}\n\n`));
+            process.stderr.write((0, colorette_1.gray)(`${(0, path_1.relative)(process.cwd(), path)}: validated in ${elapsed}\n\n`));
         }
         catch (e) {
             (0, miscellaneous_1.handleError)(e, path);

package/lib/commands/login.js

@@ -9,10 +9,15 @@ function promptClientToken(domain) {
     return (0, miscellaneous_1.promptUser)((0, colorette_1.green)(`\n  🔑 Copy your API key from ${(0, colorette_1.blue)(`https://app.${domain}/profile`)} and paste it below`), true);
 }
 async function handleLogin({ argv, config }) {
-    const region = argv.region || config.region;
-    const client = new openapi_core_1.RedoclyClient(region);
-    const clientToken = await promptClientToken(client.domain);
-    process.stdout.write((0, colorette_1.gray)('\n  Logging in...\n'));
-    await client.login(clientToken, argv.verbose);
-    process.stdout.write((0, colorette_1.green)('  Authorization confirmed. ✅\n\n'));
+    try {
+        const region = argv.region || config.region;
+        const client = new openapi_core_1.RedoclyClient(region);
+        const clientToken = await promptClientToken(client.domain);
+        process.stdout.write((0, colorette_1.gray)('\n  Logging in...\n'));
+        await client.login(clientToken, argv.verbose);
+        process.stdout.write((0, colorette_1.green)('  Authorization confirmed. ✅\n\n'));
+    }
+    catch (err) {
+        (0, miscellaneous_1.exitWithError)('  ' + err?.message);
+    }
 }

package/lib/commands/preview-project/index.js

@@ -5,6 +5,7 @@ const path = require("path");
 const fs_1 = require("fs");
 const child_process_1 = require("child_process");
 const constants_1 = require("./constants");
+const platform_1 = require("../../utils/platform");
 const previewProject = async ({ argv }) => {
     const { plan, port } = argv;
     const projectDir = argv['project-dir'];
@@ -16,10 +17,15 @@ const previewProject = async ({ argv }) => {
     const productName = constants_1.PRODUCT_NAMES[product];
     const packageName = constants_1.PRODUCT_PACKAGES[product];
     process.stdout.write(`\nLaunching preview of ${productName} ${plan} using NPX.\n\n`);
-    const npxExecutableName = process.platform === 'win32' ? 'npx.cmd' : 'npx';
-    (0, child_process_1.spawn)(npxExecutableName, ['-y', packageName, 'preview', `--plan=${plan}`, `--port=${port || 4000}`], {
+    const { npxExecutableName, shell } = (0, platform_1.getPlatformSpawnArgs)();
+    const child = (0, child_process_1.spawn)(npxExecutableName, ['-y', packageName, 'preview', `--plan=${plan}`, `--port=${port || 4000}`], {
         stdio: 'inherit',
         cwd: projectDir,
+        shell,
+    });
+    child.on('error', (error) => {
+        process.stderr.write(`Project preview launch failed: ${error.message}`);
+        throw new Error(`Project preview launch failed.`);
     });
 };
 exports.previewProject = previewProject;

package/lib/commands/translations.js

@@ -2,9 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handleTranslations = void 0;
 const child_process_1 = require("child_process");
+const platform_1 = require("../utils/platform");
 const handleTranslations = async ({ argv }) => {
     process.stdout.write(`\nLaunching translate using NPX.\n\n`);
-    const npxExecutableName = process.platform === 'win32' ? 'npx.cmd' : 'npx';
-    (0, child_process_1.spawn)(npxExecutableName, ['-y', '@redocly/realm', 'translate', argv.locale, `-d=${argv['project-dir']}`], { stdio: 'inherit' });
+    const { npxExecutableName, sanitize, shell } = (0, platform_1.getPlatformSpawnArgs)();
+    const projectDir = sanitize(argv['project-dir'], platform_1.sanitizePath);
+    const locale = sanitize(argv.locale, platform_1.sanitizeLocale);
+    const child = (0, child_process_1.spawn)(npxExecutableName, ['-y', '@redocly/realm', 'translate', locale, `-d=${projectDir}`], {
+        stdio: 'inherit',
+        shell,
+    });
+    child.on('error', (error) => {
+        process.stderr.write(`Translate launch failed: ${error.message}`);
+        throw new Error(`Translate launch failed.`);
+    });
 };
 exports.handleTranslations = handleTranslations;

package/lib/utils/miscellaneous.js

@@ -84,9 +84,11 @@ function getAliasOrPath(config, aliasOrPath) {
     const aliasApi = config.apis[aliasOrPath];
     return aliasApi
         ? {
-            path: aliasApi.root,
+            path: (0, path_1.isAbsolute)(aliasApi.root)
+                ? aliasApi.root
+                : (0, path_1.resolve)(getConfigDirectory(config), aliasApi.root),
             alias: aliasOrPath,
-            output: aliasApi.output,
+            output: aliasApi.output && (0, path_1.resolve)(getConfigDirectory(config), aliasApi.output),
         }
         : {
             path: aliasOrPath,
@@ -427,7 +429,7 @@ function checkIfRulesetExist(rules) {
         ...rules.oas3_1,
         ...rules.async2,
         ...rules.async3,
-        ...rules.arazzo,
+        ...rules.arazzo1,
     };
     if ((0, utils_1.isEmptyObject)(ruleset)) {
         exitWithError('⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/');

package/lib/utils/platform.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Sanitizes the input path by removing invalid characters.
+ */
+export declare const sanitizePath: (input: string) => string;
+/**
+ * Sanitizes the input locale (ex. en-US) by removing invalid characters.
+ */
+export declare const sanitizeLocale: (input: string) => string;
+/**
+ * Retrieves platform-specific arguments and utilities.
+ */
+export declare function getPlatformSpawnArgs(): {
+    npxExecutableName: string;
+    sanitize: (input: string | undefined, sanitizer: (input: string) => string) => string;
+    shell: boolean;
+};

package/lib/utils/platform.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeLocale = exports.sanitizePath = void 0;
+exports.getPlatformSpawnArgs = getPlatformSpawnArgs;
+/**
+ * Sanitizes the input path by removing invalid characters.
+ */
+const sanitizePath = (input) => {
+    return input.replace(/[^a-zA-Z0-9 ._\-:\\/@]/g, '');
+};
+exports.sanitizePath = sanitizePath;
+/**
+ * Sanitizes the input locale (ex. en-US) by removing invalid characters.
+ */
+const sanitizeLocale = (input) => {
+    return input.replace(/[^a-zA-Z0-9@._-]/g, '');
+};
+exports.sanitizeLocale = sanitizeLocale;
+/**
+ * Retrieves platform-specific arguments and utilities.
+ */
+function getPlatformSpawnArgs() {
+    const isWindowsPlatform = process.platform === 'win32';
+    const npxExecutableName = isWindowsPlatform ? 'npx.cmd' : 'npx';
+    const sanitizeIfWindows = (input, sanitizer) => {
+        if (isWindowsPlatform && input) {
+            return sanitizer(input);
+        }
+        else {
+            return input || '';
+        }
+    };
+    return { npxExecutableName, sanitize: sanitizeIfWindows, shell: isWindowsPlatform };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.25.15",
+  "version": "1.26.1",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -36,7 +36,7 @@
     "Roman Hotsiy <roman@redocly.com> (https://redocly.com/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.25.15",
+    "@redocly/openapi-core": "1.26.1",
     "abort-controller": "^3.0.0",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",

package/src/__tests__/commands/join.test.ts

@@ -1,7 +1,11 @@
 import { yellow } from 'colorette';
 import { detectSpec } from '@redocly/openapi-core';
 import { handleJoin } from '../../commands/join';
-import { exitWithError, writeToFileByExtension } from '../../utils/miscellaneous';
+import {
+  exitWithError,
+  getFallbackApisOrExit,
+  writeToFileByExtension,
+} from '../../utils/miscellaneous';
 import { loadConfig } from '../../__mocks__/@redocly/openapi-core';
 import { ConfigFixture } from '../fixtures/config';
 
@@ -15,7 +19,35 @@ describe('handleJoin', () => {
 
   it('should call exitWithError because only one entrypoint', async () => {
     await handleJoin({ argv: { apis: ['first.yaml'] }, config: {} as any, version: 'cli-version' });
-    expect(exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided.`);
+    expect(exitWithError).toHaveBeenCalledWith(`At least 2 APIs should be provided.`);
+  });
+
+  it('should call exitWithError if glob expands to less than 2 APIs', async () => {
+    (getFallbackApisOrExit as jest.Mock).mockResolvedValueOnce([{ path: 'first.yaml' }]);
+
+    await handleJoin({
+      argv: { apis: ['*.yaml'] },
+      config: {} as any,
+      version: 'cli-version',
+    });
+
+    expect(exitWithError).toHaveBeenCalledWith(`At least 2 APIs should be provided.`);
+  });
+
+  it('should proceed if glob expands to 2 or more APIs', async () => {
+    (detectSpec as jest.Mock).mockReturnValue('oas3_1');
+    (getFallbackApisOrExit as jest.Mock).mockResolvedValueOnce([
+      { path: 'first.yaml' },
+      { path: 'second.yaml' },
+    ]);
+
+    await handleJoin({
+      argv: { apis: ['*.yaml'] },
+      config: ConfigFixture as any,
+      version: 'cli-version',
+    });
+
+    expect(exitWithError).not.toHaveBeenCalled();
   });
 
   it('should call exitWithError because passed all 3 options for tags', async () => {
@@ -52,6 +84,7 @@ describe('handleJoin', () => {
   });
 
   it('should call exitWithError because Only OpenAPI 3.0 and OpenAPI 3.1 are supported', async () => {
+    (detectSpec as jest.Mock).mockReturnValueOnce('oas2_0');
     await handleJoin({
       argv: {
         apis: ['first.yaml', 'second.yaml'],

package/src/__tests__/utils.test.ts

@@ -15,6 +15,7 @@ import {
   getAndValidateFileExtension,
   writeToFileByExtension,
 } from '../utils/miscellaneous';
+import { sanitizeLocale, sanitizePath, getPlatformSpawnArgs } from '../utils/platform';
 import {
   ResolvedApi,
   Totals,
@@ -500,7 +501,7 @@ describe('checkIfRulesetExist', () => {
       oas3_1: {},
       async2: {},
       async3: {},
-      arazzo: {},
+      arazzo1: {},
     };
     expect(() => checkIfRulesetExist(rules)).toThrowError(
       '⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/'
@@ -641,3 +642,73 @@ describe('writeToFileByExtension', () => {
     expect(process.stderr.write).toHaveBeenCalledWith(`test data`);
   });
 });
+
+describe('runtime platform', () => {
+  describe('sanitizePath', () => {
+    test.each([
+      ['C:\\Program Files\\App', 'C:\\Program Files\\App'],
+      ['/usr/local/bin/app', '/usr/local/bin/app'],
+      ['invalid|path?name*', 'invalidpathname'],
+      ['', ''],
+      ['<>:"|?*', ':'],
+      ['C:/Program Files\\App', 'C:/Program Files\\App'],
+      ['path\nname\r', 'pathname'],
+      ['/usr/local; rm -rf /', '/usr/local rm -rf /'],
+      ['C:\\data&& dir', 'C:\\data dir'],
+    ])('should sanitize path %s to %s', (input, expected) => {
+      expect(sanitizePath(input)).toBe(expected);
+    });
+  });
+
+  describe('sanitizeLocale', () => {
+    test.each([
+      ['en-US', 'en-US'],
+      ['fr_FR', 'fr_FR'],
+      ['en<>US', 'enUS'],
+      ['fr@FR', 'fr@FR'],
+      ['en_US@#$%', 'en_US@'],
+      [' en-US ', 'en-US'],
+      ['', ''],
+    ])('should sanitize locale %s to %s', (input, expected) => {
+      expect(sanitizeLocale(input)).toBe(expected);
+    });
+  });
+
+  describe('getPlatformSpawnArgs', () => {
+    const originalPlatform = process.platform;
+
+    afterEach(() => {
+      Object.defineProperty(process, 'platform', {
+        value: originalPlatform,
+      });
+    });
+
+    it('should return args for Windows platform', () => {
+      Object.defineProperty(process, 'platform', {
+        value: 'win32',
+      });
+
+      const result = getPlatformSpawnArgs();
+
+      expect(result).toEqual({
+        npxExecutableName: 'npx.cmd',
+        sanitize: expect.any(Function),
+        shell: true,
+      });
+    });
+
+    it('should return args for non-Windows platform', () => {
+      Object.defineProperty(process, 'platform', {
+        value: 'linux',
+      });
+
+      const result = getPlatformSpawnArgs();
+
+      expect(result).toEqual({
+        npxExecutableName: 'npx',
+        sanitize: expect.any(Function),
+        shell: false,
+      });
+    });
+  });
+});

package/src/commands/bundle.ts

@@ -1,3 +1,4 @@
+import { relative } from 'path';
 import { performance } from 'perf_hooks';
 import { blue, gray, green, yellow } from 'colorette';
 import { writeFileSync } from 'fs';
@@ -54,7 +55,7 @@ export async function handleBundle({
       styleguide.skipPreprocessors(argv['skip-preprocessor']);
       styleguide.skipDecorators(argv['skip-decorator']);
 
-      process.stderr.write(gray(`bundling ${path}...\n`));
+      process.stderr.write(gray(`bundling ${relative(process.cwd(), path)}...\n`));
 
       const {
         bundle: result,
@@ -117,22 +118,22 @@ export async function handleBundle({
       if (fileTotals.errors > 0) {
         if (argv.force) {
           process.stderr.write(
-            `❓ Created a bundle for ${blue(path)} at ${blue(
+            `❓ Created a bundle for ${blue(relative(process.cwd(), path))} at ${blue(
               outputFile || 'stdout'
             )} with errors ${green(elapsed)}.\n${yellow('Errors ignored because of --force')}.\n`
           );
         } else {
           process.stderr.write(
             `❌ Errors encountered while bundling ${blue(
-              path
+              relative(process.cwd(), path)
             )}: bundle not created (use --force to ignore errors).\n`
           );
         }
       } else {
         process.stderr.write(
-          `📦 Created a bundle for ${blue(path)} at ${blue(outputFile || 'stdout')} ${green(
-            elapsed
-          )}.\n`
+          `📦 Created a bundle for ${blue(relative(process.cwd(), path))} at ${blue(
+            outputFile || 'stdout'
+          )} ${green(elapsed)}.\n`
         );
       }