@redocly/cli 1.25.15 → 1.26.1

package/src/commands/eject.ts

@@ -1,4 +1,5 @@
 import { spawn } from 'child_process';
+import { getPlatformSpawnArgs, sanitizePath } from '../utils/platform';
 
 import type { CommandArgs } from '../wrapper';
 import type { VerifyConfigOptions } from '../types';
@@ -12,18 +13,30 @@ export type EjectOptions = {
 
 export const handleEject = async ({ argv }: CommandArgs<EjectOptions>) => {
   process.stdout.write(`\nLaunching eject using NPX.\n\n`);
-  const npxExecutableName = process.platform === 'win32' ? 'npx.cmd' : 'npx';
-  spawn(
+  const { npxExecutableName, sanitize, shell } = getPlatformSpawnArgs();
+
+  const path = sanitize(argv.path, sanitizePath);
+  const projectDir = sanitize(argv['project-dir'], sanitizePath);
+
+  const child = 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.');
+  });
 };

package/src/commands/join.ts

@@ -64,18 +64,12 @@ export async function handleJoin({
 }: CommandArgs<JoinOptions>) {
   const startedAt = performance.now();
 
-  if (argv.apis.length < 2) {
-    return exitWithError(`At least 2 apis should be provided.`);
-  }
-
-  const fileExtension = 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}`,
+    output,
   } = argv;
 
   const usedTagsOptions = [
@@ -91,6 +85,13 @@ export async function handleJoin({
   }
 
   const apis = await getFallbackApisOrExit(argv.apis, config);
+  if (apis.length < 2) {
+    return exitWithError(`At least 2 APIs should be provided.`);
+  }
+
+  const fileExtension = getAndValidateFileExtension(output || apis[0].path);
+  const specFilename = output || `openapi.${fileExtension}`;
+
   const externalRefResolver = new BaseResolver(config.resolve);
   const documents = await Promise.all(
     apis.map(

package/src/commands/lint.ts

@@ -1,3 +1,4 @@
+import { relative } from 'path';
 import { blue, gray } from 'colorette';
 import { performance } from 'perf_hooks';
 import {
@@ -74,7 +75,7 @@ export async function handleLint({
           )} configuration by default.\n\n`
         );
       }
-      process.stderr.write(gray(`validating ${path.replace(process.cwd(), '')}...\n`));
+      process.stderr.write(gray(`validating ${relative(process.cwd(), path)}...\n`));
       const results = await lint({
         ref: path,
         config: resolvedConfig,
@@ -101,7 +102,7 @@ export async function handleLint({
       }
 
       const elapsed = getExecutionTime(startedAt);
-      process.stderr.write(gray(`${path.replace(process.cwd(), '')}: validated in ${elapsed}\n\n`));
+      process.stderr.write(gray(`${relative(process.cwd(), path)}: validated in ${elapsed}\n\n`));
     } catch (e) {
       handleError(e, path);
     }

package/src/commands/login.ts

@@ -1,6 +1,6 @@
 import { blue, green, gray } from 'colorette';
 import { RedoclyClient } from '@redocly/openapi-core';
-import { promptUser } from '../utils/miscellaneous';
+import { exitWithError, promptUser } from '../utils/miscellaneous';
 
 import type { CommandArgs } from '../wrapper';
 import type { Region } from '@redocly/openapi-core';
@@ -21,10 +21,14 @@ export type LoginOptions = {
 };
 
 export async function handleLogin({ argv, config }: CommandArgs<LoginOptions>) {
-  const region = argv.region || config.region;
-  const client = new RedoclyClient(region);
-  const clientToken = await promptClientToken(client.domain);
-  process.stdout.write(gray('\n  Logging in...\n'));
-  await client.login(clientToken, argv.verbose);
-  process.stdout.write(green('  Authorization confirmed. ✅\n\n'));
+  try {
+    const region = argv.region || config.region;
+    const client = new RedoclyClient(region);
+    const clientToken = await promptClientToken(client.domain);
+    process.stdout.write(gray('\n  Logging in...\n'));
+    await client.login(clientToken, argv.verbose);
+    process.stdout.write(green('  Authorization confirmed. ✅\n\n'));
+  } catch (err) {
+    exitWithError('  ' + err?.message);
+  }
 }

package/src/commands/preview-project/index.ts

@@ -2,6 +2,7 @@ import path = require('path');
 import { existsSync, readFileSync } from 'fs';
 import { spawn } from 'child_process';
 import { PRODUCT_NAMES, PRODUCT_PACKAGES } from './constants';
+import { getPlatformSpawnArgs } from '../../utils/platform';
 
 import type { PreviewProjectOptions, Product } from './types';
 import type { CommandArgs } from '../../wrapper';
@@ -21,17 +22,22 @@ export const previewProject = async ({ argv }: CommandArgs<PreviewProjectOptions
   const packageName = PRODUCT_PACKAGES[product];
 
   process.stdout.write(`\nLaunching preview of ${productName} ${plan} using NPX.\n\n`);
+  const { npxExecutableName, shell } = getPlatformSpawnArgs();
 
-  const npxExecutableName = process.platform === 'win32' ? 'npx.cmd' : 'npx';
-
-  spawn(
+  const child = 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.`);
+  });
 };
 
 const isValidProduct = (product: string | undefined): product is Product => {

package/src/commands/translations.ts

@@ -1,4 +1,5 @@
 import { spawn } from 'child_process';
+import { getPlatformSpawnArgs, sanitizeLocale, sanitizePath } from '../utils/platform';
 
 import type { CommandArgs } from '../wrapper';
 import type { VerifyConfigOptions } from '../types';
@@ -10,10 +11,22 @@ export type TranslationsOptions = {
 
 export const handleTranslations = async ({ argv }: CommandArgs<TranslationsOptions>) => {
   process.stdout.write(`\nLaunching translate using NPX.\n\n`);
-  const npxExecutableName = process.platform === 'win32' ? 'npx.cmd' : 'npx';
-  spawn(
+  const { npxExecutableName, sanitize, shell } = getPlatformSpawnArgs();
+
+  const projectDir = sanitize(argv['project-dir'], sanitizePath);
+  const locale = sanitize(argv.locale, sanitizeLocale);
+
+  const child = spawn(
     npxExecutableName,
-    ['-y', '@redocly/realm', 'translate', argv.locale, `-d=${argv['project-dir']}`],
-    { stdio: 'inherit' }
+    ['-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.`);
+  });
 };

package/src/utils/miscellaneous.ts

@@ -92,9 +92,11 @@ function getAliasOrPath(config: ConfigApis, aliasOrPath: string): Entrypoint {
   const aliasApi = config.apis[aliasOrPath];
   return aliasApi
     ? {
-        path: aliasApi.root,
+        path: isAbsolute(aliasApi.root)
+          ? aliasApi.root
+          : resolve(getConfigDirectory(config), aliasApi.root),
         alias: aliasOrPath,
-        output: aliasApi.output,
+        output: aliasApi.output && resolve(getConfigDirectory(config), aliasApi.output),
       }
     : {
         path: aliasOrPath,
@@ -529,7 +531,7 @@ export function checkIfRulesetExist(rules: typeof StyleguideConfig.prototype.rul
     ...rules.oas3_1,
     ...rules.async2,
     ...rules.async3,
-    ...rules.arazzo,
+    ...rules.arazzo1,
   };
 
   if (isEmptyObject(ruleset)) {

package/src/utils/platform.ts

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