@redocly/cli 1.10.5 → 1.11.0

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

@@ -1,4 +1,4 @@
-import { lint, bundle, getTotals, getMergedConfig } from '@redocly/openapi-core';
+import { bundle, getTotals, getMergedConfig } from '@redocly/openapi-core';
 
 import { BundleOptions, handleBundle } from '../../commands/bundle';
 import { handleError } from '../../utils/miscellaneous';
@@ -25,21 +25,18 @@ describe('bundle', () => {
   });
 
   afterEach(() => {
-    (lint as jest.Mock).mockClear();
     (bundle as jest.Mock).mockClear();
     (getTotals as jest.Mock).mockReset();
   });
 
-  it('bundles definitions w/o linting', async () => {
+  it('bundles definitions', async () => {
     const apis = ['foo.yaml', 'bar.yaml'];
 
     await commandWrapper(handleBundle)({
       apis,
       ext: 'yaml',
-      format: 'codeframe',
     } as Arguments<BundleOptions>);
 
-    expect(lint).toBeCalledTimes(0);
     expect(bundle).toBeCalledTimes(apis.length);
   });
 
@@ -49,48 +46,25 @@ describe('bundle', () => {
     await commandWrapper(handleBundle)({
       apis,
       ext: 'yaml',
-      format: 'codeframe',
     } as Arguments<BundleOptions>);
 
     await exitCb?.();
     expect(processExitMock).toHaveBeenCalledWith(0);
   });
 
-  it('bundles definitions w/ linting', async () => {
-    const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-
-    (getTotals as jest.Mock).mockReturnValue({
-      errors: 0,
-      warnings: 0,
-      ignored: 0,
-    });
-
-    await commandWrapper(handleBundle)({
-      apis,
-      ext: 'yaml',
-      format: 'codeframe',
-      lint: true,
-    } as Arguments<BundleOptions>);
-
-    expect(lint).toBeCalledTimes(apis.length);
-    expect(bundle).toBeCalledTimes(apis.length);
-  });
-
-  it('exits with code 0 when bundles definitions w/linting w/o errors', async () => {
+  it('exits with code 0 when bundles definitions w/o errors', async () => {
     const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
 
     await commandWrapper(handleBundle)({
       apis,
       ext: 'yaml',
-      format: 'codeframe',
-      lint: true,
     } as Arguments<BundleOptions>);
 
     await exitCb?.();
     expect(processExitMock).toHaveBeenCalledWith(0);
   });
 
-  it('exits with code 1 when bundles definitions w/linting w/errors', async () => {
+  it('exits with code 1 when bundles definitions w/errors', async () => {
     const apis = ['foo.yaml'];
 
     (getTotals as jest.Mock).mockReturnValue({
@@ -102,11 +76,8 @@ describe('bundle', () => {
     await commandWrapper(handleBundle)({
       apis,
       ext: 'yaml',
-      format: 'codeframe',
-      lint: true,
     } as Arguments<BundleOptions>);
 
-    expect(lint).toBeCalledTimes(apis.length);
     await exitCb?.();
     expect(processExitMock).toHaveBeenCalledWith(1);
   });
@@ -121,8 +92,6 @@ describe('bundle', () => {
     await commandWrapper(handleBundle)({
       apis,
       ext: 'json',
-      format: 'codeframe',
-      lint: false,
     } as Arguments<BundleOptions>);
 
     expect(handleError).toHaveBeenCalledTimes(1);
@@ -141,8 +110,6 @@ describe('bundle', () => {
     await commandWrapper(handleBundle)({
       apis,
       ext: 'yaml',
-      format: 'codeframe',
-      lint: false,
     } as Arguments<BundleOptions>);
 
     expect(handleError).toHaveBeenCalledTimes(0);

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

@@ -165,23 +165,6 @@ describe('handleJoin', () => {
     expect(config.styleguide.skipPreprocessors).toHaveBeenCalled();
   });
 
-  it('should not call skipDecorators and skipPreprocessors', async () => {
-    (detectSpec as jest.Mock).mockReturnValue('oas3_0');
-    await handleJoin(
-      {
-        apis: ['first.yaml', 'second.yaml'],
-        decorate: true,
-        preprocess: true,
-      },
-      ConfigFixture as any,
-      'cli-version'
-    );
-
-    const config = loadConfig();
-    expect(config.styleguide.skipDecorators).not.toHaveBeenCalled();
-    expect(config.styleguide.skipPreprocessors).not.toHaveBeenCalled();
-  });
-
   it('should handle join with prefix-components-with-info-prop and null values', async () => {
     (detectSpec as jest.Mock).mockReturnValue('oas3_0');
 

package/src/commands/bundle.ts

@@ -1,12 +1,4 @@
-import {
-  formatProblems,
-  getTotals,
-  getMergedConfig,
-  lint,
-  bundle,
-  Config,
-  OutputFormat,
-} from '@redocly/openapi-core';
+import { formatProblems, getTotals, getMergedConfig, bundle, Config } from '@redocly/openapi-core';
 import {
   dumpBundle,
   getExecutionTime,
@@ -15,8 +7,6 @@ import {
   handleError,
   printUnusedWarnings,
   saveBundle,
-  printLintTotals,
-  checkIfRulesetExist,
   sortTopLevelKeysForOas,
 } from '../utils/miscellaneous';
 import type { OutputExtensions, Skips, Totals } from '../types';
@@ -27,15 +17,12 @@ import { checkForDeprecatedOptions } from '../utils/miscellaneous';
 
 export type BundleOptions = {
   apis?: string[];
-  'max-problems'?: number;
   extends?: string[];
   config?: string;
-  format?: OutputFormat;
   output?: string;
   ext: OutputExtensions;
   dereferenced?: boolean;
   force?: boolean;
-  lint?: boolean;
   metafile?: string;
   'remove-unused-components'?: boolean;
   'keep-url-references'?: boolean;
@@ -47,14 +34,7 @@ export async function handleBundle(argv: BundleOptions, config: Config, version:
     config.rawConfig?.styleguide?.decorators?.hasOwnProperty('remove-unused-components');
   const apis = await getFallbackApisOrExit(argv.apis, config);
   const totals: Totals = { errors: 0, warnings: 0, ignored: 0 };
-  const maxProblems = argv['max-problems'];
-  const deprecatedOptions: Array<keyof BundleOptions> = [
-    'lint',
-    'format',
-    'skip-rule',
-    'extends',
-    'max-problems',
-  ];
+  const deprecatedOptions: Array<keyof BundleOptions> = [];
 
   checkForDeprecatedOptions(argv, deprecatedOptions);
 
@@ -64,38 +44,9 @@ export async function handleBundle(argv: BundleOptions, config: Config, version:
       const resolvedConfig = getMergedConfig(config, alias);
       const { styleguide } = resolvedConfig;
 
-      styleguide.skipRules(argv['skip-rule']);
       styleguide.skipPreprocessors(argv['skip-preprocessor']);
       styleguide.skipDecorators(argv['skip-decorator']);
 
-      if (argv.lint) {
-        checkIfRulesetExist(styleguide.rules);
-        if (config.styleguide.recommendedFallback) {
-          process.stderr.write(
-            `No configurations were provided -- using built in ${blue(
-              'recommended'
-            )} configuration by default.\n\n`
-          );
-        }
-        const results = await lint({
-          ref: path,
-          config: resolvedConfig,
-        });
-        const fileLintTotals = getTotals(results);
-
-        totals.errors += fileLintTotals.errors;
-        totals.warnings += fileLintTotals.warnings;
-        totals.ignored += fileLintTotals.ignored;
-
-        formatProblems(results, {
-          format: argv.format || 'codeframe',
-          totals: fileLintTotals,
-          version,
-          maxProblems: maxProblems,
-        });
-        printLintTotals(fileLintTotals, 2);
-      }
-
       process.stderr.write(gray(`bundling ${path}...\n`));
 
       const {
@@ -132,8 +83,7 @@ export async function handleBundle(argv: BundleOptions, config: Config, version:
       totals.ignored += fileTotals.ignored;
 
       formatProblems(problems, {
-        format: argv.format || 'codeframe',
-        maxProblems: maxProblems,
+        format: 'codeframe',
         totals: fileTotals,
         version,
       });

package/src/commands/join.ts

@@ -6,10 +6,8 @@ import {
   Config,
   SpecVersion,
   BaseResolver,
-  StyleguideConfig,
   formatProblems,
   getTotals,
-  lintDocument,
   detectSpec,
   bundleDocument,
   isRef,
@@ -17,13 +15,10 @@ import {
 import {
   getFallbackApisOrExit,
   printExecutionTime,
-  handleError,
-  printLintTotals,
   exitWithError,
   sortTopLevelKeysForOas,
   getAndValidateFileExtension,
   writeToFileByExtension,
-  checkForDeprecatedOptions,
 } from '../utils/miscellaneous';
 import { isObject, isString, keysOf } from '../utils/js-utils';
 import { COMPONENTS, OPENAPI3_METHOD } from './split/types';
@@ -60,9 +55,6 @@ type JoinDocumentContext = {
 
 export type JoinOptions = {
   apis: string[];
-  lint?: boolean;
-  decorate?: boolean;
-  preprocess?: boolean;
   'prefix-tags-with-info-prop'?: string;
   'prefix-tags-with-filename'?: boolean;
   'prefix-components-with-info-prop'?: string;
@@ -79,8 +71,6 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     return exitWithError(`At least 2 apis should be provided. \n\n`);
   }
 
-  checkForDeprecatedOptions(argv, ['lint'] as Array<keyof JoinOptions>);
-
   const fileExtension = getAndValidateFileExtension(argv.output || argv.apis[0]);
 
   const {
@@ -111,23 +101,19 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     )
   );
 
-  if (!argv.decorate) {
-    const decorators = new Set([
-      ...Object.keys(config.styleguide.decorators.oas3_0),
-      ...Object.keys(config.styleguide.decorators.oas3_1),
-      ...Object.keys(config.styleguide.decorators.oas2),
-    ]);
-    config.styleguide.skipDecorators(Array.from(decorators));
-  }
+  const decorators = new Set([
+    ...Object.keys(config.styleguide.decorators.oas3_0),
+    ...Object.keys(config.styleguide.decorators.oas3_1),
+    ...Object.keys(config.styleguide.decorators.oas2),
+  ]);
+  config.styleguide.skipDecorators(Array.from(decorators));
 
-  if (!argv.preprocess) {
-    const preprocessors = new Set([
-      ...Object.keys(config.styleguide.preprocessors.oas3_0),
-      ...Object.keys(config.styleguide.preprocessors.oas3_1),
-      ...Object.keys(config.styleguide.preprocessors.oas2),
-    ]);
-    config.styleguide.skipPreprocessors(Array.from(preprocessors));
-  }
+  const preprocessors = new Set([
+    ...Object.keys(config.styleguide.preprocessors.oas3_0),
+    ...Object.keys(config.styleguide.preprocessors.oas3_1),
+    ...Object.keys(config.styleguide.preprocessors.oas2),
+  ]);
+  config.styleguide.skipPreprocessors(Array.from(preprocessors));
 
   const bundleResults = await Promise.all(
     documents.map((document) =>
@@ -146,7 +132,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     if (fileTotals.errors) {
       formatProblems(problems, {
         totals: fileTotals,
-        version: document.parsed.version,
+        version: packageVersion,
       });
       exitWithError(
         `❌ Errors encountered while bundling ${blue(
@@ -179,12 +165,6 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     }
   }
 
-  if (argv.lint) {
-    for (const document of documents) {
-      await validateApi(document, config.styleguide, externalRefResolver, packageVersion);
-    }
-  }
-
   const joinedDef: any = {};
   const potentialConflicts = {
     tags: {},
@@ -787,22 +767,6 @@ function getInfoPrefix(info: any, prefixArg: string | undefined, type: string) {
   return info[prefixArg].replaceAll(/\s/g, '_');
 }
 
-async function validateApi(
-  document: Document,
-  config: StyleguideConfig,
-  externalRefResolver: BaseResolver,
-  packageVersion: string
-) {
-  try {
-    const results = await lintDocument({ document, config, externalRefResolver });
-    const fileTotals = getTotals(results);
-    formatProblems(results, { format: 'stylish', totals: fileTotals, version: packageVersion });
-    printLintTotals(fileTotals, 2);
-  } catch (err) {
-    handleError(err, document.parsed);
-  }
-}
-
 function replace$Refs(obj: unknown, componentsPrefix: string) {
   crawl(obj, (node: Record<string, unknown>) => {
     if (node.$ref && typeof node.$ref === 'string' && startsWithComponents(node.$ref)) {

package/src/commands/lint.ts

@@ -24,6 +24,8 @@ import { performance } from 'perf_hooks';
 import type { OutputFormat, ProblemSeverity, Document, RuleSeverity } from '@redocly/openapi-core';
 import type { ResolvedRefMap } from '@redocly/openapi-core/lib/resolve';
 import type { CommandOptions, Skips, Totals } from '../types';
+import { getCommandNameFromArgs } from '../utils/getCommandNameFromArgs';
+import { Arguments } from 'yargs';
 
 export type LintOptions = {
   apis?: string[];
@@ -144,7 +146,9 @@ export function lintConfigCallback(
       version,
     });
 
-    printConfigLintTotals(fileTotals);
+    const command = argv ? getCommandNameFromArgs(argv as unknown as Arguments) : undefined;
+
+    printConfigLintTotals(fileTotals, command);
 
     if (fileTotals.errors > 0) {
       throw new ConfigValidationError();

package/src/index.ts

@@ -2,6 +2,7 @@
 
 import './utils/assert-node-version';
 import * as yargs from 'yargs';
+import * as colors from 'colorette';
 import { outputExtensions, PushArguments, regionChoices } from './types';
 import { RedoclyClient } from '@redocly/openapi-core';
 import { previewDocs } from './commands/preview-docs';
@@ -104,9 +105,6 @@ yargs
           demandOption: true,
         })
         .option({
-          lint: { description: 'Lint descriptions', type: 'boolean', default: false, hidden: true },
-          decorate: { description: 'Run decorators', type: 'boolean', default: false },
-          preprocess: { description: 'Run preprocessors', type: 'boolean', default: false },
           'prefix-tags-with-info-prop': {
             description: 'Prefix tags with property value from info object.',
             requiresArg: true,
@@ -141,8 +139,47 @@ yargs
             choices: ['warn', 'error', 'off'] as ReadonlyArray<RuleSeverity>,
             default: 'warn' as RuleSeverity,
           },
+          lint: {
+            hidden: true,
+            deprecated: true,
+          },
+          decorate: {
+            hidden: true,
+            deprecated: true,
+          },
+          preprocess: {
+            hidden: true,
+            deprecated: true,
+          },
         }),
     (argv) => {
+      const DEPRECATED_OPTIONS = ['lint', 'preprocess', 'decorate'];
+      const DECORATORS_DOCUMENTATION_LINK = 'https://redocly.com/docs/cli/decorators/#decorators';
+      const JOIN_COMMAND_DOCUMENTATION_LINK = 'https://redocly.com/docs/cli/commands/join/#join';
+
+      DEPRECATED_OPTIONS.forEach((option) => {
+        if (argv[option]) {
+          process.stdout.write(
+            `${colors.red(
+              `Option --${option} is no longer supported. Please review join command documentation ${JOIN_COMMAND_DOCUMENTATION_LINK}.`
+            )}`
+          );
+          process.stdout.write('\n\n');
+
+          if (['preprocess', 'decorate'].includes(option)) {
+            process.stdout.write(
+              `${colors.red(
+                `If you are looking for decorators, please review the decorators documentation ${DECORATORS_DOCUMENTATION_LINK}.`
+              )}`
+            );
+            process.stdout.write('\n\n');
+          }
+
+          yargs.showHelp();
+          process.exit(1);
+        }
+      });
+
       process.env.REDOCLY_CLI_COMMAND = 'join';
       commandWrapper(handleJoin)(argv);
     }
@@ -360,6 +397,7 @@ yargs
             'checkstyle',
             'codeclimate',
             'summary',
+            'github-actions',
           ] as ReadonlyArray<OutputFormat>,
           default: 'codeframe' as OutputFormat,
         },
@@ -415,28 +453,11 @@ yargs
           description: 'Output file.',
           alias: 'o',
         },
-        format: {
-          description: 'Use a specific output format.',
-          choices: ['stylish', 'codeframe', 'json', 'checkstyle'] as ReadonlyArray<OutputFormat>,
-          hidden: true,
-        },
-        'max-problems': {
-          requiresArg: true,
-          description: 'Reduce output to a maximum of N problems.',
-          type: 'number',
-          hidden: true,
-        },
         ext: {
           description: 'Bundle file extension.',
           requiresArg: true,
           choices: outputExtensions,
         },
-        'skip-rule': {
-          description: 'Ignore certain rules.',
-          array: true,
-          type: 'string',
-          hidden: true,
-        },
         'skip-preprocessor': {
           description: 'Ignore certain preprocessors.',
           array: true,
@@ -461,12 +482,6 @@ yargs
           description: 'Path to the config file.',
           type: 'string',
         },
-        lint: {
-          description: 'Lint API descriptions',
-          type: 'boolean',
-          default: false,
-          hidden: true,
-        },
         metafile: {
           description: 'Produce metadata about the bundle',
           type: 'string',
@@ -493,12 +508,67 @@ yargs
           choices: ['warn', 'error', 'off'] as ReadonlyArray<RuleSeverity>,
           default: 'warn' as RuleSeverity,
         },
+        format: {
+          hidden: true,
+          deprecated: true,
+        },
+        lint: {
+          hidden: true,
+          deprecated: true,
+        },
+        'skip-rule': {
+          hidden: true,
+          deprecated: true,
+          array: true,
+          type: 'string',
+        },
+        'max-problems': {
+          hidden: true,
+          deprecated: true,
+        },
       }),
     (argv) => {
+      const DEPRECATED_OPTIONS = ['lint', 'format', 'skip-rule', 'max-problems'];
+      const LINT_AND_BUNDLE_DOCUMENTATION_LINK =
+        'https://redocly.com/docs/cli/guides/lint-and-bundle/#lint-and-bundle-api-descriptions-with-redocly-cli';
+
+      DEPRECATED_OPTIONS.forEach((option) => {
+        if (argv[option]) {
+          process.stdout.write(
+            `${colors.red(
+              `Option --${option} is no longer supported. Please use separate commands, as described in the ${LINT_AND_BUNDLE_DOCUMENTATION_LINK}.`
+            )}`
+          );
+          process.stdout.write('\n\n');
+          yargs.showHelp();
+          process.exit(1);
+        }
+      });
+
       process.env.REDOCLY_CLI_COMMAND = 'bundle';
       commandWrapper(handleBundle)(argv);
     }
   )
+  .command(
+    'check-config',
+    'Lint the Redocly configuration file.',
+    async (yargs) =>
+      yargs.option({
+        config: {
+          description: 'Path to the config file.',
+          type: 'string',
+        },
+        'lint-config': {
+          description: 'Severity level for config file linting.',
+          choices: ['warn', 'error'] as ReadonlyArray<RuleSeverity>,
+          default: 'error' as RuleSeverity,
+        },
+      }),
+    (argv) => {
+      process.env.REDOCLY_CLI_COMMAND = 'check-config';
+      commandWrapper()(argv);
+    }
+  )
   .command(
     'login',
     'Login to the Redocly API registry with an access token.',

package/src/types.ts

@@ -38,8 +38,14 @@ export type CommandOptions =
   | PreviewDocsOptions
   | BuildDocsArgv
   | PushStatusOptions
+  | VerifyConfigOptions
   | PreviewProjectOptions;
 
+export type VerifyConfigOptions = {
+  config?: string;
+  'lint-config'?: 'warning' | 'error' | 'off';
+};
+
 export type Skips = {
   'skip-rule'?: string[];
   'skip-decorator'?: string[];

package/src/utils/getCommandNameFromArgs.ts

@@ -0,0 +1,5 @@
+import { Arguments } from 'yargs';
+
+export function getCommandNameFromArgs(argv: Arguments | undefined): string | number {
+  return argv?._?.[0] ?? '';
+}

package/src/utils/miscellaneous.ts

@@ -352,7 +352,7 @@ export function printLintTotals(totals: Totals, definitionsCount: number) {
   process.stderr.write('\n');
 }
 
-export function printConfigLintTotals(totals: Totals): void {
+export function printConfigLintTotals(totals: Totals, command?: string | number): void {
   if (totals.errors > 0) {
     process.stderr.write(
       red(`❌ Your config has ${totals.errors} ${pluralize('error', totals.errors)}.`)
@@ -361,6 +361,8 @@ export function printConfigLintTotals(totals: Totals): void {
     process.stderr.write(
       yellow(`⚠️ Your config has ${totals.warnings} ${pluralize('warning', totals.warnings)}.\n`)
     );
+  } else if (command === 'check-config') {
+    process.stderr.write(green('✅  Your config is valid.\n'));
   }
 }
 

package/src/wrapper.ts

@@ -11,7 +11,7 @@ import { lintConfigCallback } from './commands/lint';
 import type { CommandOptions } from './types';
 
 export function commandWrapper<T extends CommandOptions>(
-  commandHandler: (argv: T, config: Config, version: string) => Promise<void>
+  commandHandler?: (argv: T, config: Config, version: string) => Promise<void>
 ) {
   return async (argv: Arguments<T>) => {
     let code: ExitCode = 2;
@@ -31,7 +31,9 @@ export function commandWrapper<T extends CommandOptions>(
       telemetry = config.telemetry;
       hasConfig = !config.styleguide.recommendedFallback;
       code = 1;
-      await commandHandler(argv, config, version);
+      if (typeof commandHandler === 'function') {
+        await commandHandler(argv, config, version);
+      }
       code = 0;
     } catch (err) {
       // Do nothing