cleanup lint, bundle, and join commands

Author: tatomyr

packages/cli/src/commands/bundle.ts

@@ -15,7 +15,7 @@ import {
   formatPath,
 } from '../utils/miscellaneous';
 
-import type { OutputExtensions, Skips, Totals, VerifyConfigOptions } from '../types';
+import type { OutputExtensions, Totals, VerifyConfigOptions } from '../types';
 import type { CommandArgs } from '../wrapper';
 
 export type BundleOptions = {
@@ -28,8 +28,9 @@ export type BundleOptions = {
   metafile?: string;
   'remove-unused-components'?: boolean;
   'keep-url-references'?: boolean;
-} & Skips &
-  VerifyConfigOptions;
+  'skip-decorator'?: string[];
+  'skip-preprocessor'?: string[];
+} & VerifyConfigOptions;
 
 export async function handleBundle({
   argv,

packages/cli/src/commands/join.ts

@@ -88,6 +88,7 @@ export async function handleJoin({
     );
   }
 
+  // FIXME: decide on the behaviour. Can we join by aliases? If yes, then I'd expect decorators to be applied
   const apis = await getFallbackApisOrExit(argv.apis, config);
   if (apis.length < 2) {
     return exitWithError(`At least 2 APIs should be provided.`);

packages/cli/src/commands/lint.ts

@@ -26,7 +26,7 @@ import { getCommandNameFromArgs } from '../utils/getCommandNameFromArgs';
 import type { Arguments } from 'yargs';
 import type { OutputFormat, ProblemSeverity } from '@redocly/openapi-core';
 import type { RawConfigProcessor } from '@redocly/openapi-core/lib/config';
-import type { CommandOptions, Skips, Totals, VerifyConfigOptions } from '../types';
+import type { CommandOptions, Totals, VerifyConfigOptions } from '../types';
 import type { CommandArgs } from '../wrapper';
 
 export type LintOptions = {
@@ -35,8 +35,9 @@ export type LintOptions = {
   extends?: string[];
   format: OutputFormat;
   'generate-ignore-file'?: boolean;
-} & Omit<Skips, 'skip-decorator'> &
-  VerifyConfigOptions;
+  'skip-rule'?: string[];
+  'skip-preprocessor'?: string[]; // FIXME: do we need this?
+} & VerifyConfigOptions;
 
 export async function handleLint({
   argv,

packages/cli/src/index.ts

@@ -150,48 +150,8 @@ 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);
     }
   )
@@ -538,24 +498,6 @@ 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,
-          },
         })
         .check((argv) => {
           if (argv.output && (!argv.apis || argv.apis.length === 0)) {
@@ -564,24 +506,6 @@ yargs
           return 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);
     }
   )

packages/cli/src/types.ts

@@ -51,12 +51,6 @@ export type VerifyConfigOptions = {
   'lint-config'?: RuleSeverity;
 };
 
-export type Skips = {
-  'skip-rule'?: string[];
-  'skip-decorator'?: string[];
-  'skip-preprocessor'?: string[];
-};
-
 export type ConfigApis = Pick<Config, 'apis' | 'configFile'>;
 
 export type PushArguments = ArgumentsCamelCase<PushOptions & CMSPushOptions & { apis: string[] }>;