@redocly/cli 1.20.0 → 1.21.0

package/src/commands/split/index.ts

@@ -37,13 +37,13 @@ import type {
   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 async function handleSplit({ argv, collectSpecData }: CommandArgs<SplitOptions>) {
   const startedAt = performance.now();

package/src/commands/stats.ts

@@ -13,7 +13,6 @@ import {
 } from '@redocly/openapi-core';
 import { getFallbackApisOrExit, printExecutionTime } from '../utils/miscellaneous';
 
-import type { CommandArgs } from '../wrapper';
 import type {
   StatsAccumulator,
   StatsName,
@@ -21,6 +20,8 @@ import type {
   OutputFormat,
   StyleguideConfig,
 } from '@redocly/openapi-core';
+import type { CommandArgs } from '../wrapper';
+import type { VerifyConfigOptions } from '../types';
 
 const statsAccumulator: StatsAccumulator = {
   refs: { metric: '🚗 References', total: 0, color: 'red', items: new Set() },
@@ -89,8 +90,7 @@ function printStats(
 export type StatsOptions = {
   api?: string;
   format: OutputFormat;
-  config?: string;
-};
+} & VerifyConfigOptions;
 
 export async function handleStats({ argv, config, collectSpecData }: CommandArgs<StatsOptions>) {
   const [{ path }] = await getFallbackApisOrExit(argv.api ? [argv.api] : [], config);

package/src/commands/translations.ts

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

package/src/index.ts

@@ -21,6 +21,8 @@ import {
 } from './utils/update-version-notifier';
 import { commandWrapper } from './wrapper';
 import { previewProject } from './commands/preview-project';
+import { handleTranslations } from './commands/translations';
+import { handleEject } from './commands/eject';
 import { PRODUCT_PLANS } from './commands/preview-project/constants';
 import { commonPushHandler } from './commands/push';
 
@@ -29,6 +31,7 @@ import type { OutputFormat, RuleSeverity } from '@redocly/openapi-core';
 import type { BuildDocsArgv } from './commands/build-docs/types';
 import type { PushStatusOptions } from './cms/commands/push-status';
 import type { PushArguments } from './types';
+import type { EjectOptions } from './commands/eject';
 
 if (!('replaceAll' in String.prototype)) {
   require('core-js/actual/string/replace-all');
@@ -228,6 +231,11 @@ yargs
             type: 'boolean',
             default: false,
           },
+          'lint-config': {
+            description: 'Severity level for config file linting.',
+            choices: ['warn', 'error', 'off'] as ReadonlyArray<RuleSeverity>,
+            default: 'warn' as RuleSeverity,
+          },
         }),
     (argv) => {
       process.env.REDOCLY_CLI_COMMAND = 'push-status';
@@ -642,18 +650,32 @@ 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'] as ReadonlyArray<RuleSeverity>,
+          default: 'warn' as RuleSeverity,
+        },
       }),
     (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'
+          )
+        );
+      }
       commandWrapper(previewProject)(argv);
     }
   )
@@ -764,6 +786,77 @@ yargs
       commandWrapper(handlerBuildCommand)(argv as Arguments<BuildDocsArgv>);
     }
   )
+  .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'] as ReadonlyArray<RuleSeverity>,
+            default: 'warn' as RuleSeverity,
+          },
+        }),
+    (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'translate';
+      commandWrapper(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'] as ReadonlyArray<RuleSeverity>,
+            default: 'warn' as RuleSeverity,
+          },
+        }),
+    (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'eject';
+      commandWrapper(handleEject)(argv as Arguments<EjectOptions>);
+    }
+  )
   .completion('completion', 'Generate autocomplete script for `redocly` command.')
   .demandCommand(1)
   .middleware([notifyUpdateCliVersion])

package/src/types.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;
@@ -37,12 +39,13 @@ export type CommandOptions =
   | PreviewDocsOptions
   | BuildDocsArgv
   | PushStatusOptions
-  | VerifyConfigOptions
-  | PreviewProjectOptions;
+  | PreviewProjectOptions
+  | TranslationsOptions
+  | EjectOptions;
 
 export type VerifyConfigOptions = {
   config?: string;
-  'lint-config'?: 'warning' | 'error' | 'off';
+  'lint-config'?: RuleSeverity;
 };
 
 export type Skips = {