@redocly/cli 1.20.0 → 1.21.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @redocly/cli
 
+## 1.21.0
+
+### Minor Changes
+
+- Added the `eject` and `translate` commands for use with the new Reunite-hosted product family.
+
+### Patch Changes
+
+- Updated @redocly/openapi-core to v1.21.0.
+
+## 1.20.1
+
+### Patch Changes
+
+- Get more helpful error messages when there's a problem importing a plugin.
+- Updated @redocly/openapi-core to v1.20.1.
+
 ## 1.20.0
 
 ### Minor Changes

package/lib/cms/commands/push.d.ts

@@ -1,5 +1,6 @@
 import type { OutputFormat } from '@redocly/openapi-core';
 import type { CommandArgs } from '../../wrapper';
+import type { VerifyConfigOptions } from '../../types';
 export type PushOptions = {
     apis?: string[];
     organization?: string;
@@ -16,13 +17,12 @@ export type PushOptions = {
     files: string[];
     'default-branch': string;
     domain?: string;
-    config?: string;
     'wait-for-deployment'?: boolean;
     'max-execution-time': number;
     'continue-on-deploy-failures'?: boolean;
     verbose?: boolean;
     format?: Extract<OutputFormat, 'stylish'>;
-};
+} & VerifyConfigOptions;
 export declare function handlePush({ argv, config, version, }: CommandArgs<PushOptions>): Promise<{
     pushId: string;
 } | void>;

package/lib/commands/build-docs/types.d.ts

@@ -1,3 +1,4 @@
+import type { VerifyConfigOptions } from '../../types';
 export type BuildDocsOptions = {
     watch?: boolean;
     output?: string;
@@ -19,5 +20,4 @@ export type BuildDocsArgv = {
     theme: {
         openapi: string | Record<string, unknown>;
     };
-    config?: string;
-};
+} & VerifyConfigOptions;

package/lib/commands/bundle.d.ts

@@ -1,9 +1,8 @@
-import type { OutputExtensions, Skips } from '../types';
+import type { OutputExtensions, Skips, VerifyConfigOptions } from '../types';
 import type { CommandArgs } from '../wrapper';
 export type BundleOptions = {
     apis?: string[];
     extends?: string[];
-    config?: string;
     output?: string;
     ext: OutputExtensions;
     dereferenced?: boolean;
@@ -11,5 +10,5 @@ export type BundleOptions = {
     metafile?: string;
     'remove-unused-components'?: boolean;
     'keep-url-references'?: boolean;
-} & Skips;
+} & Skips & VerifyConfigOptions;
 export declare function handleBundle({ argv, config, version, collectSpecData, }: CommandArgs<BundleOptions>): Promise<void>;

package/lib/commands/eject.d.ts

@@ -0,0 +1,9 @@
+import type { CommandArgs } from '../wrapper';
+import type { VerifyConfigOptions } from '../types';
+export type EjectOptions = {
+    type: 'component';
+    path: string;
+    'project-dir'?: string;
+    force: boolean;
+} & VerifyConfigOptions;
+export declare const handleEject: ({ argv }: CommandArgs<EjectOptions>) => Promise<void>;

package/lib/commands/eject.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleEject = void 0;
+const child_process_1 = require("child_process");
+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, [
+        '-y',
+        '@redocly/realm',
+        'eject',
+        `${argv.type}`,
+        `${argv.path}`,
+        `-d=${argv['project-dir']}`,
+        argv.force ? `--force=${argv.force}` : '',
+    ], { stdio: 'inherit' });
+};
+exports.handleEject = handleEject;

package/lib/commands/join.d.ts

@@ -1,5 +1,5 @@
-import type { RuleSeverity } from '@redocly/openapi-core';
 import type { CommandArgs } from '../wrapper';
+import type { VerifyConfigOptions } from '../types';
 export type JoinOptions = {
     apis: string[];
     'prefix-tags-with-info-prop'?: string;
@@ -7,7 +7,5 @@ export type JoinOptions = {
     'prefix-components-with-info-prop'?: string;
     'without-x-tag-groups'?: boolean;
     output?: string;
-    config?: string;
-    'lint-config'?: RuleSeverity;
-};
+} & VerifyConfigOptions;
 export declare function handleJoin({ argv, config, version: packageVersion, }: CommandArgs<JoinOptions>): Promise<void>;

package/lib/commands/lint.d.ts

@@ -1,15 +1,13 @@
-import type { OutputFormat, RuleSeverity } from '@redocly/openapi-core';
+import type { OutputFormat } from '@redocly/openapi-core';
 import type { RawConfigProcessor } from '@redocly/openapi-core/lib/config';
-import type { CommandOptions, Skips } from '../types';
+import type { CommandOptions, Skips, VerifyConfigOptions } from '../types';
 import type { CommandArgs } from '../wrapper';
 export type LintOptions = {
     apis?: string[];
     'max-problems': number;
     extends?: string[];
-    config?: string;
     format: OutputFormat;
     'generate-ignore-file'?: boolean;
-    'lint-config'?: RuleSeverity;
-} & Omit<Skips, 'skip-decorator'>;
+} & Omit<Skips, 'skip-decorator'> & VerifyConfigOptions;
 export declare function handleLint({ argv, config, version, collectSpecData, }: CommandArgs<LintOptions>): Promise<void>;
 export declare function lintConfigCallback(argv: CommandOptions & Record<string, undefined>, version: string): RawConfigProcessor | undefined;

package/lib/commands/preview-docs/index.d.ts

@@ -1,4 +1,4 @@
-import type { Skips } from '../../types';
+import type { Skips, VerifyConfigOptions } from '../../types';
 import type { CommandArgs } from '../../wrapper';
 export type PreviewDocsOptions = {
     port: number;
@@ -7,6 +7,6 @@ export type PreviewDocsOptions = {
     config?: string;
     api?: string;
     force?: boolean;
-} & Omit<Skips, 'skip-rule'>;
+} & Omit<Skips, 'skip-rule'> & VerifyConfigOptions;
 export declare function previewDocs({ argv, config: configFromFile, }: CommandArgs<PreviewDocsOptions>): Promise<void>;
 export declare function debounce(func: Function, wait: number, immediate?: boolean): (...args: any[]) => void;

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

@@ -7,15 +7,15 @@ const child_process_1 = require("child_process");
 const constants_1 = require("./constants");
 const previewProject = async ({ argv }) => {
     const { plan, port } = argv;
-    const projectDir = argv['source-dir'];
+    const projectDir = argv['project-dir'];
     const product = argv.product || tryGetProductFromPackageJson(projectDir);
     if (!isValidProduct(product)) {
-        process.stderr.write(`Invalid product ${product}`);
-        throw new Error(`Project preview launch failed`);
+        process.stderr.write(`Invalid product ${product}.`);
+        throw new Error(`Project preview launch failed.`);
     }
     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`);
+    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, 'develop', `--plan=${plan}`, `--port=${port || 4000}`], {
         stdio: 'inherit',

package/lib/commands/preview-project/types.d.ts

@@ -1,3 +1,4 @@
+import type { VerifyConfigOptions } from '../../types';
 import type { PRODUCT_PACKAGES, PRODUCT_PLANS } from './constants';
 export type Product = keyof typeof PRODUCT_PACKAGES;
 export type ProductPlan = typeof PRODUCT_PLANS[number];
@@ -5,6 +6,5 @@ export type PreviewProjectOptions = {
     product?: Product | string;
     plan: ProductPlan | string;
     port?: number;
-    'source-dir': string;
-    config?: string;
-};
+    'project-dir': string;
+} & VerifyConfigOptions;

package/lib/commands/push.d.ts

@@ -1,6 +1,7 @@
 import { handlePush as handleCMSPush } from '../cms/commands/push';
 import type { Config, Region } from '@redocly/openapi-core';
 import type { CommandArgs } from '../wrapper';
+import type { VerifyConfigOptions } from '../types';
 export declare const DESTINATION_REGEX: RegExp;
 export type PushOptions = {
     api?: string;
@@ -14,8 +15,7 @@ export type PushOptions = {
     public?: boolean;
     files?: string[];
     organization?: string;
-    config?: string;
-};
+} & VerifyConfigOptions;
 export declare function commonPushHandler({ project, 'mount-path': mountPath, }: {
     project?: string;
     'mount-path'?: string;

package/lib/commands/split/index.d.ts

@@ -1,11 +1,11 @@
 import type { Oas3PathItem, Referenced } from './types';
 import type { CommandArgs } from '../../wrapper';
+import type { VerifyConfigOptions } from '../../types';
 export type SplitOptions = {
     api: string;
     outDir: string;
     separator: string;
-    config?: string;
-};
+} & VerifyConfigOptions;
 export declare function handleSplit({ argv, collectSpecData }: CommandArgs<SplitOptions>): Promise<void>;
 export declare function startsWithComponents(node: string): boolean;
 export declare function crawl(object: unknown, visitor: (node: Record<string, unknown>) => void): void;

package/lib/commands/stats.d.ts

@@ -1,8 +1,8 @@
-import type { CommandArgs } from '../wrapper';
 import type { OutputFormat } from '@redocly/openapi-core';
+import type { CommandArgs } from '../wrapper';
+import type { VerifyConfigOptions } from '../types';
 export type StatsOptions = {
     api?: string;
     format: OutputFormat;
-    config?: string;
-};
+} & VerifyConfigOptions;
 export declare function handleStats({ argv, config, collectSpecData }: CommandArgs<StatsOptions>): Promise<void>;

package/lib/commands/translations.d.ts

@@ -0,0 +1,7 @@
+import type { CommandArgs } from '../wrapper';
+import type { VerifyConfigOptions } from '../types';
+export type TranslationsOptions = {
+    locale: string;
+    'project-dir'?: string;
+} & VerifyConfigOptions;
+export declare const handleTranslations: ({ argv }: CommandArgs<TranslationsOptions>) => Promise<void>;

package/lib/commands/translations.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleTranslations = void 0;
+const child_process_1 = require("child_process");
+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' });
+};
+exports.handleTranslations = handleTranslations;

package/lib/index.js

@@ -18,6 +18,8 @@ const build_docs_1 = require("./commands/build-docs");
 const update_version_notifier_1 = require("./utils/update-version-notifier");
 const wrapper_1 = require("./wrapper");
 const preview_project_1 = require("./commands/preview-project");
+const translations_1 = require("./commands/translations");
+const eject_1 = require("./commands/eject");
 const constants_1 = require("./commands/preview-project/constants");
 const push_1 = require("./commands/push");
 if (!('replaceAll' in String.prototype)) {
@@ -182,6 +184,11 @@ yargs
         type: 'boolean',
         default: false,
     },
+    'lint-config': {
+        description: 'Severity level for config file linting.',
+        choices: ['warn', 'error', 'off'],
+        default: 'warn',
+    },
 }), (argv) => {
     process.env.REDOCLY_CLI_COMMAND = 'push-status';
     (0, wrapper_1.commandWrapper)(push_status_1.handlePushStatus)(argv);
@@ -545,17 +552,26 @@ yargs
         default: 'enterprise',
     },
     port: {
+        alias: 'p',
         type: 'number',
         description: 'Preview port.',
         default: 4000,
     },
-    'source-dir': {
-        alias: 'd',
+    'project-dir': {
+        alias: ['d', 'source-dir'],
         type: 'string',
-        description: 'Project directory.',
+        description: 'Specifies the project content directory. The default value is the directory where the command is executed.',
         default: '.',
     },
+    'lint-config': {
+        description: 'Severity level for config file linting.',
+        choices: ['warn', 'error', 'off'],
+        default: 'warn',
+    },
 }), (argv) => {
+    if (process.argv.some((arg) => arg.startsWith('--source-dir'))) {
+        process.stderr.write(colors.red('Option --source-dir is deprecated and will be removed soon. Use --project-dir instead.\n'));
+    }
     (0, wrapper_1.commandWrapper)(preview_project_1.previewProject)(argv);
 })
     .command('preview-docs [api]', 'Preview API reference docs for an API description.', (yargs) => yargs.positional('api', { type: 'string' }).options({
@@ -649,6 +665,60 @@ yargs
 }), async (argv) => {
     process.env.REDOCLY_CLI_COMMAND = 'build-docs';
     (0, wrapper_1.commandWrapper)(build_docs_1.handlerBuildCommand)(argv);
+})
+    .command('translate <locale>', 'Creates or updates translations.yaml files and fills them with missing built-in translations and translations from the redocly.yaml and sidebars.yaml files.', (yargs) => yargs
+    .positional('locale', {
+    description: 'Locale code to generate translations for, or `all` for all current project locales.',
+    type: 'string',
+    demandOption: true,
+})
+    .options({
+    'project-dir': {
+        alias: 'd',
+        type: 'string',
+        description: 'Specifies the project content directory. The default value is the directory where the command is executed.',
+        default: '.',
+    },
+    'lint-config': {
+        description: 'Severity level for config file linting.',
+        choices: ['warn', 'error', 'off'],
+        default: 'warn',
+    },
+}), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'translate';
+    (0, wrapper_1.commandWrapper)(translations_1.handleTranslations)(argv);
+})
+    .command('eject <type> <path>', 'Helper function to eject project elements for customization.', (yargs) => yargs
+    .positional('type', {
+    description: 'Specifies what type of project element to eject. Currently, it could be only `component`.',
+    demandOption: true,
+    choices: ['component'],
+})
+    .positional('path', {
+    description: 'Filepath to a component or filepath with glob pattern.',
+    type: 'string',
+    demandOption: true,
+})
+    .options({
+    'project-dir': {
+        alias: 'd',
+        type: 'string',
+        description: 'Specifies the project content directory. The default value is the directory where the command is executed.',
+        default: '.',
+    },
+    force: {
+        alias: 'f',
+        type: 'boolean',
+        description: 'Skips the "overwrite existing" confirmation when ejecting a component that is already ejected in the destination.',
+    },
+    'lint-config': {
+        description: 'Severity level for config file linting.',
+        choices: ['warn', 'error', 'off'],
+        default: 'warn',
+    },
+}), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'eject';
+    (0, wrapper_1.commandWrapper)(eject_1.handleEject)(argv);
 })
     .completion('completion', 'Generate autocomplete script for `redocly` command.')
     .demandCommand(1)

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import type { BundleOutputFormat, Region, Config } from '@redocly/openapi-core';
+import type { BundleOutputFormat, Region, Config, RuleSeverity } from '@redocly/openapi-core';
 import type { ArgumentsCamelCase } from 'yargs';
 import type { LintOptions } from './commands/lint';
 import type { BundleOptions } from './commands/bundle';
@@ -12,6 +12,8 @@ import type { BuildDocsArgv } from './commands/build-docs/types';
 import type { PushOptions as CMSPushOptions } from './cms/commands/push';
 import type { PushStatusOptions } from './cms/commands/push-status';
 import type { PreviewProjectOptions } from './commands/preview-project/types';
+import type { TranslationsOptions } from './commands/translations';
+import type { EjectOptions } from './commands/eject';
 export type Totals = {
     errors: number;
     warnings: number;
@@ -24,10 +26,10 @@ export type Entrypoint = {
 export declare const outputExtensions: ReadonlyArray<BundleOutputFormat>;
 export type OutputExtensions = 'json' | 'yaml' | 'yml' | undefined;
 export declare const regionChoices: ReadonlyArray<Region>;
-export type CommandOptions = StatsOptions | SplitOptions | JoinOptions | PushOptions | CMSPushOptions | LintOptions | BundleOptions | LoginOptions | PreviewDocsOptions | BuildDocsArgv | PushStatusOptions | VerifyConfigOptions | PreviewProjectOptions;
+export type CommandOptions = StatsOptions | SplitOptions | JoinOptions | PushOptions | CMSPushOptions | LintOptions | BundleOptions | LoginOptions | PreviewDocsOptions | BuildDocsArgv | PushStatusOptions | PreviewProjectOptions | TranslationsOptions | EjectOptions;
 export type VerifyConfigOptions = {
     config?: string;
-    'lint-config'?: 'warning' | 'error' | 'off';
+    'lint-config'?: RuleSeverity;
 };
 export type Skips = {
     'skip-rule'?: string[];

package/package.json

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

package/src/cms/commands/push.ts

@@ -13,6 +13,7 @@ import { ReuniteApiClient, getDomain, getApiKeys } from '../api';
 
 import type { OutputFormat } from '@redocly/openapi-core';
 import type { CommandArgs } from '../../wrapper';
+import type { VerifyConfigOptions } from '../../types';
 
 export type PushOptions = {
   apis?: string[];
@@ -33,13 +34,12 @@ export type PushOptions = {
 
   'default-branch': string;
   domain?: string;
-  config?: string;
   'wait-for-deployment'?: boolean;
   'max-execution-time': number;
   'continue-on-deploy-failures'?: boolean;
   verbose?: boolean;
   format?: Extract<OutputFormat, 'stylish'>;
-};
+} & VerifyConfigOptions;
 
 type FileToUpload = { name: string; path: string };
 

package/src/commands/build-docs/types.ts

@@ -1,3 +1,5 @@
+import type { VerifyConfigOptions } from '../../types';
+
 export type BuildDocsOptions = {
   watch?: boolean;
   output?: string;
@@ -20,5 +22,4 @@ export type BuildDocsArgv = {
   theme: {
     openapi: string | Record<string, unknown>;
   };
-  config?: string;
-};
+} & VerifyConfigOptions;

package/src/commands/bundle.ts

@@ -14,13 +14,12 @@ import {
   checkForDeprecatedOptions,
 } from '../utils/miscellaneous';
 
-import type { OutputExtensions, Skips, Totals } from '../types';
+import type { OutputExtensions, Skips, Totals, VerifyConfigOptions } from '../types';
 import type { CommandArgs } from '../wrapper';
 
 export type BundleOptions = {
   apis?: string[];
   extends?: string[];
-  config?: string;
   output?: string;
   ext: OutputExtensions;
   dereferenced?: boolean;
@@ -28,7 +27,8 @@ export type BundleOptions = {
   metafile?: string;
   'remove-unused-components'?: boolean;
   'keep-url-references'?: boolean;
-} & Skips;
+} & Skips &
+  VerifyConfigOptions;
 
 export async function handleBundle({
   argv,

package/src/commands/eject.ts

@@ -0,0 +1,29 @@
+import { spawn } from 'child_process';
+
+import type { CommandArgs } from '../wrapper';
+import type { VerifyConfigOptions } from '../types';
+
+export type EjectOptions = {
+  type: 'component';
+  path: string;
+  'project-dir'?: string;
+  force: boolean;
+} & VerifyConfigOptions;
+
+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(
+    npxExecutableName,
+    [
+      '-y',
+      '@redocly/realm',
+      'eject',
+      `${argv.type}`,
+      `${argv.path}`,
+      `-d=${argv['project-dir']}`,
+      argv.force ? `--force=${argv.force}` : '',
+    ],
+    { stdio: 'inherit' }
+  );
+};

package/src/commands/join.ts

@@ -23,13 +23,7 @@ import { isObject, isString, keysOf } from '../utils/js-utils';
 import { COMPONENTS, OPENAPI3_METHOD } from './split/types';
 import { crawl, startsWithComponents } from './split';
 
-import type {
-  Oas3Definition,
-  Document,
-  Oas3Tag,
-  Referenced,
-  RuleSeverity,
-} from '@redocly/openapi-core';
+import type { Oas3Definition, Document, Oas3Tag, Referenced } from '@redocly/openapi-core';
 import type { BundleResult } from '@redocly/openapi-core/lib/bundle';
 import type {
   Oas3Parameter,
@@ -38,6 +32,7 @@ import type {
   Oas3_1Definition,
 } from '@redocly/openapi-core/lib/typings/openapi';
 import type { CommandArgs } from '../wrapper';
+import type { VerifyConfigOptions } from '../types';
 
 const Tags = 'tags';
 const xTagGroups = 'x-tagGroups';
@@ -60,9 +55,7 @@ export type JoinOptions = {
   'prefix-components-with-info-prop'?: string;
   'without-x-tag-groups'?: boolean;
   output?: string;
-  config?: string;
-  'lint-config'?: RuleSeverity;
-};
+} & VerifyConfigOptions;
 
 export async function handleJoin({
   argv,

package/src/commands/lint.ts

@@ -23,20 +23,19 @@ import {
 import { getCommandNameFromArgs } from '../utils/getCommandNameFromArgs';
 
 import type { Arguments } from 'yargs';
-import type { OutputFormat, ProblemSeverity, RuleSeverity } from '@redocly/openapi-core';
+import type { OutputFormat, ProblemSeverity } from '@redocly/openapi-core';
 import type { RawConfigProcessor } from '@redocly/openapi-core/lib/config';
-import type { CommandOptions, Skips, Totals } from '../types';
+import type { CommandOptions, Skips, Totals, VerifyConfigOptions } from '../types';
 import type { CommandArgs } from '../wrapper';
 
 export type LintOptions = {
   apis?: string[];
   'max-problems': number;
   extends?: string[];
-  config?: string;
   format: OutputFormat;
   'generate-ignore-file'?: boolean;
-  'lint-config'?: RuleSeverity;
-} & Omit<Skips, 'skip-decorator'>;
+} & Omit<Skips, 'skip-decorator'> &
+  VerifyConfigOptions;
 
 export async function handleLint({
   argv,

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

@@ -8,7 +8,7 @@ import {
 } from '../../utils/miscellaneous';
 import startPreviewServer from './preview-server/preview-server';
 
-import type { Skips } from '../../types';
+import type { Skips, VerifyConfigOptions } from '../../types';
 import type { CommandArgs } from '../../wrapper';
 
 export type PreviewDocsOptions = {
@@ -18,7 +18,8 @@ export type PreviewDocsOptions = {
   config?: string;
   api?: string;
   force?: boolean;
-} & Omit<Skips, 'skip-rule'>;
+} & Omit<Skips, 'skip-rule'> &
+  VerifyConfigOptions;
 
 export async function previewDocs({
   argv,

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

@@ -8,19 +8,19 @@ import type { CommandArgs } from '../../wrapper';
 
 export const previewProject = async ({ argv }: CommandArgs<PreviewProjectOptions>) => {
   const { plan, port } = argv;
-  const projectDir = argv['source-dir'];
+  const projectDir = argv['project-dir'];
 
   const product = argv.product || tryGetProductFromPackageJson(projectDir);
 
   if (!isValidProduct(product)) {
-    process.stderr.write(`Invalid product ${product}`);
-    throw new Error(`Project preview launch failed`);
+    process.stderr.write(`Invalid product ${product}.`);
+    throw new Error(`Project preview launch failed.`);
   }
 
   const productName = PRODUCT_NAMES[product];
   const packageName = PRODUCT_PACKAGES[product];
 
-  process.stdout.write(`\nLaunching preview of ${productName} ${plan} using NPX\n\n`);
+  process.stdout.write(`\nLaunching preview of ${productName} ${plan} using NPX.\n\n`);
 
   const npxExecutableName = process.platform === 'win32' ? 'npx.cmd' : 'npx';
 

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

@@ -1,3 +1,4 @@
+import type { VerifyConfigOptions } from '../../types';
 import type { PRODUCT_PACKAGES, PRODUCT_PLANS } from './constants';
 
 export type Product = keyof typeof PRODUCT_PACKAGES;
@@ -7,6 +8,5 @@ export type PreviewProjectOptions = {
   product?: Product | string;
   plan: ProductPlan | string;
   port?: number;
-  'source-dir': string;
-  config?: string;
-};
+  'project-dir': string;
+} & VerifyConfigOptions;

package/src/commands/push.ts

@@ -25,6 +25,7 @@ import { handlePush as handleCMSPush } from '../cms/commands/push';
 
 import type { Config, BundleOutputFormat, Region } from '@redocly/openapi-core';
 import type { CommandArgs } from '../wrapper';
+import type { VerifyConfigOptions } from '../types';
 
 const DEFAULT_VERSION = 'latest';
 
@@ -44,8 +45,7 @@ export type PushOptions = {
   public?: boolean;
   files?: string[];
   organization?: string;
-  config?: string;
-};
+} & VerifyConfigOptions;
 
 export function commonPushHandler({
   project,