@redocly/cli 1.5.0 → 1.7.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @redocly/cli
 
+## 1.7.0
+
+### Minor Changes
+
+- Added a `preview` command that starts a local preview server for Redocly projects that use products that are currently in a pre-release stage.
+
+### Patch Changes
+
+- Fixed an issue with resolving references after splitting API descriptions written in the json format.
+- Added filename extension support for more `x-codeSamples` languages.
+- Fixed a problem where the linter incorrectly returned an error for valid examples that contain references.
+- Updated @redocly/openapi-core to v1.7.0.
+
+## 1.6.0
+
+### Minor Changes
+
+- Added the ability to use `$ref` in the Redocly config file. This ability allows users to split up big config files and maintain their constituent parts independently.
+
+### Patch Changes
+
+- Deprecated `--lint` option in the `join` command. The options are marked for removal in a future release. Use the [lint command](https://redocly.com/docs/cli/commands/lint/) separately to lint your APIs.
+- Updated @redocly/openapi-core to v1.6.0.
+
 ## 1.5.0
 
 ### Minor Changes

package/README.md

@@ -28,7 +28,7 @@ Then you can use it as `redocly [command] [options]`, for example:
 redocly lint path-to-root-file.yaml
 ```
 
-Minimal required versions of Node.js and NPM are 14.19.0 and 7.0.0 respectively.
+The minimum required versions of Node.js and NPM are 14.19.0 and 7.0.0 respectively.
 
 ### Docker
 
@@ -63,11 +63,11 @@ Your API reference docs are in `redoc-static.html` by default. You can customize
 
 ### Bundle multiple OpenAPI documents
 
-Having one massive OpenAPI description can be annoying, so most people split them up into multiple documents via `$ref`, only to later find out some tools don't support `$ref`, or don't support multiple documents?! Well fear not, because Redocly has a `bundle` command you can use to recombine all of those documents back into one single document. The bundled output Redocly CLI provides is clean, tidy, and looks like a human made it.
+Having one massive OpenAPI description can be annoying, so most people split them up into multiple documents via `$ref`, only to later find out some tools don't support `$ref` or don't support multiple documents. Redocly CLI to the rescue! It has a `bundle` command you can use to recombine all of those documents back into one single document. The bundled output that Redocly CLI provides is clean, tidy, and looks like a human made it.
 
 ### Automate API guidelines with Linting
 
-Check your API matches the expected API guidelines by using the `lint` command. API guidelines are an important piece of API governance, it helps to keep APIs consistent (enforcing the same standards and naming conventions) but can also guide API teams through potential security hazards and other pitfalls. Automating API guidelines means you can keep APIs consistent and secure throughout their lifecycle. Even better, you can shape the design of the API before it even exists if you combine API linting with a design-first API workflow!
+Check that your API matches the expected API guidelines by using the `lint` command. API guidelines are an important piece of API governance. They help to keep APIs consistent by enforcing the same standards and naming conventions, and they can also guide API teams through potential security hazards and other pitfalls. Automating API guidelines means you can keep APIs consistent and secure throughout their lifecycle. Even better, you can shape the design of the API before it even exists by combining API linting with a design-first API workflow.
 
 Our API linter is designed for speed on even large documents, and it's easy to run locally, in CI, or anywhere you need it. It's also designed for humans, with meaningful error messages to help you get your API right every time.
 
@@ -79,9 +79,9 @@ redocly lint openapi.yaml
 
 **Configure the rules** as you wish. Other API Linters use complicated identifiers like JSONPath, but Redocly makes life easy with simple expressions that understand the OpenAPI structure. You can either use the [built-in rules](https://redocly.com/docs/cli/rules) to mix-and-match your ideal API guidelines, or break out the tools to build your own.
 
-**Format the output** in whatever way you need, the `stylish` output is as good as it sounds, but if you need JSON or Checkstyle outputs to integrate with other tools, the lint command can output those too.
+**Format the output** in whatever way you need. The `stylish` output is as good as it sounds, but if you need JSON or Checkstyle outputs to integrate with other tools, the `lint` command can output those too.
 
-**Multiple files supported** so you don't need to bundle your API description to lint it, just point Redocly CLI at the "entry point" (e.g.: `openapi.yaml`) and it handles the rest.
+**Multiple files supported** so you don't need to bundle your API description to lint it; just point Redocly CLI at the "entry point" (e.g.: `openapi.yaml`) and it handles the rest.
 
 [Learn more about API standards and configuring Redocly rules](https://redocly.com/docs/cli/api-standards).
 

package/lib/__mocks__/utils.d.ts

@@ -39,3 +39,4 @@ export declare const checkIfRulesetExist: jest.Mock<any, any>;
 export declare const sortTopLevelKeysForOas: jest.Mock<any, [document: any]>;
 export declare const getAndValidateFileExtension: jest.Mock<string | undefined, [fileName: string]>;
 export declare const writeToFileByExtension: jest.Mock<any, any>;
+export declare const checkForDeprecatedOptions: jest.Mock<any, any>;

package/lib/__mocks__/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeToFileByExtension = exports.getAndValidateFileExtension = exports.sortTopLevelKeysForOas = exports.checkIfRulesetExist = exports.loadConfigAndHandleErrors = exports.writeYaml = exports.exitWithError = exports.handleError = exports.getOutputFileName = exports.printLintTotals = exports.printUnusedWarnings = exports.printExecutionTime = exports.getExecutionTime = exports.pluralize = exports.slash = exports.dumpBundle = exports.getFallbackApisOrExit = void 0;
+exports.checkForDeprecatedOptions = exports.writeToFileByExtension = exports.getAndValidateFileExtension = exports.sortTopLevelKeysForOas = exports.checkIfRulesetExist = exports.loadConfigAndHandleErrors = exports.writeYaml = exports.exitWithError = exports.handleError = exports.getOutputFileName = exports.printLintTotals = exports.printUnusedWarnings = exports.printExecutionTime = exports.getExecutionTime = exports.pluralize = exports.slash = exports.dumpBundle = exports.getFallbackApisOrExit = void 0;
 const config_1 = require("../__tests__/fixtures/config");
 exports.getFallbackApisOrExit = jest.fn((entrypoints) => entrypoints.map((path) => ({ path })));
 exports.dumpBundle = jest.fn(() => '');
@@ -19,3 +19,4 @@ exports.checkIfRulesetExist = jest.fn();
 exports.sortTopLevelKeysForOas = jest.fn((document) => document);
 exports.getAndValidateFileExtension = jest.fn((fileName) => fileName.split('.').pop());
 exports.writeToFileByExtension = jest.fn();
+exports.checkForDeprecatedOptions = jest.fn();

package/lib/__tests__/utils.test.js

@@ -235,6 +235,24 @@ describe('langToExt', () => {
         ['javascript', '.js'],
         ['js', '.js'],
         ['python', '.py'],
+        ['c', '.c'],
+        ['c++', '.cpp'],
+        ['coffeescript', '.litcoffee'],
+        ['dart', '.dart'],
+        ['elixir', '.ex'],
+        ['go', '.go'],
+        ['groovy', '.groovy'],
+        ['java', '.java'],
+        ['kotlin', '.kt'],
+        ['objective-c', '.m'],
+        ['perl', '.pl'],
+        ['powershell', '.ps1'],
+        ['ruby', '.rb'],
+        ['rust', '.rs'],
+        ['scala', '.sc'],
+        ['swift', '.swift'],
+        ['typescript', '.ts'],
+        ['tsx', '.tsx'],
     ])('should infer file extension from lang - %s', (lang, expected) => {
         expect((0, utils_1.langToExt)(lang)).toBe(expected);
     });

package/lib/commands/bundle.js

@@ -26,6 +26,7 @@ const utils_1 = require("../utils");
 const perf_hooks_1 = require("perf_hooks");
 const colorette_1 = require("colorette");
 const fs_1 = require("fs");
+const utils_2 = require("../utils");
 function handleBundle(argv, config, version) {
     var _a, _b, _c, _d, _e;
     return __awaiter(this, void 0, void 0, function* () {
@@ -34,7 +35,14 @@ function handleBundle(argv, config, version) {
         const apis = yield (0, utils_1.getFallbackApisOrExit)(argv.apis, config);
         const totals = { errors: 0, warnings: 0, ignored: 0 };
         const maxProblems = argv['max-problems'];
-        checkForDeprecatedOptions(argv);
+        const deprecatedOptions = [
+            'lint',
+            'format',
+            'skip-rule',
+            'extends',
+            'max-problems',
+        ];
+        (0, utils_2.checkForDeprecatedOptions)(argv, deprecatedOptions);
         for (const { path, alias } of apis) {
             try {
                 const startedAt = perf_hooks_1.performance.now();
@@ -129,17 +137,3 @@ function handleBundle(argv, config, version) {
     });
 }
 exports.handleBundle = handleBundle;
-function checkForDeprecatedOptions(argv) {
-    const deprecatedOptions = [
-        'lint',
-        'format',
-        'skip-rule',
-        'extends',
-        'max-problems',
-    ];
-    for (const option of deprecatedOptions) {
-        if (argv[option]) {
-            process.stderr.write((0, colorette_1.yellow)(`[WARNING] "${option}" option is deprecated and will be removed in a future release. \n\n`));
-        }
-    }
-}

package/lib/commands/join.d.ts

@@ -10,7 +10,6 @@ export type JoinOptions = {
     'without-x-tag-groups'?: boolean;
     output?: string;
     config?: string;
-    extends?: undefined;
     'lint-config'?: RuleSeverity;
 };
 export declare function handleJoin(argv: JoinOptions, config: Config, packageVersion: string): Promise<void>;

package/lib/commands/join.js

@@ -28,6 +28,7 @@ function handleJoin(argv, config, packageVersion) {
         if (argv.apis.length < 2) {
             return (0, utils_1.exitWithError)(`At least 2 apis should be provided. \n\n`);
         }
+        (0, utils_1.checkForDeprecatedOptions)(argv, ['lint']);
         const fileExtension = (0, utils_1.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}`, } = argv;
         const usedTagsOptions = [

package/lib/commands/lint.d.ts

@@ -1,5 +1,6 @@
 import { Config } from '@redocly/openapi-core';
-import type { OutputFormat, RawConfig, RuleSeverity } from '@redocly/openapi-core';
+import type { OutputFormat, Document, RuleSeverity } from '@redocly/openapi-core';
+import type { ResolvedRefMap } from '@redocly/openapi-core/lib/resolve';
 import type { CommandOptions, Skips } from '../types';
 export type LintOptions = {
     apis?: string[];
@@ -11,4 +12,4 @@ export type LintOptions = {
     'lint-config'?: RuleSeverity;
 } & Omit<Skips, 'skip-decorator'>;
 export declare function handleLint(argv: LintOptions, config: Config, version: string): Promise<void>;
-export declare function lintConfigCallback(argv: CommandOptions & Record<string, undefined>, version: string): ((config: RawConfig) => Promise<void>) | undefined;
+export declare function lintConfigCallback(argv: CommandOptions & Record<string, undefined>, version: string): ((document: Document, resolvedRefMap: ResolvedRefMap) => Promise<void>) | undefined;

package/lib/commands/lint.js

@@ -90,12 +90,10 @@ function lintConfigCallback(argv, version) {
         // we can't print config lint results as it will break json output
         return;
     }
-    return (config) => __awaiter(this, void 0, void 0, function* () {
-        const configPath = (0, openapi_core_1.findConfig)(argv.config) || '';
-        const stringYaml = (0, openapi_core_1.stringifyYaml)(config);
-        const configContent = (0, openapi_core_1.makeDocumentFromString)(stringYaml, configPath);
+    return (document, resolvedRefMap) => __awaiter(this, void 0, void 0, function* () {
         const problems = yield (0, openapi_core_1.lintConfig)({
-            document: configContent,
+            document,
+            resolvedRefMap,
             severity: (argv['lint-config'] || 'warn'),
         });
         const fileTotals = (0, openapi_core_1.getTotals)(problems);

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

@@ -0,0 +1,14 @@
+import { Product } from './types';
+export declare const PRODUCT_PACKAGES: {
+    realm: string;
+    'redoc-revel': string;
+    'revel-reef': string;
+    'redoc-reef': string;
+    redoc: string;
+    revel: string;
+    reef: string;
+};
+export declare const PRODUCT_NAMES: {
+    [key in Product]: string;
+};
+export declare const PRODUCT_PLANS: readonly ["pro", "enterprise"];

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRODUCT_PLANS = exports.PRODUCT_NAMES = exports.PRODUCT_PACKAGES = void 0;
+exports.PRODUCT_PACKAGES = {
+    realm: '@redocly/realm',
+    'redoc-revel': '@redocly/redoc-revel',
+    'revel-reef': '@redocly/revel-reef',
+    'redoc-reef': '@redocly/redoc-reef',
+    redoc: '@redocly/redoc',
+    revel: '@redocly/revel',
+    reef: '@redocly/reef',
+};
+exports.PRODUCT_NAMES = {
+    redoc: 'Redoc',
+    revel: 'Revel',
+    reef: 'Reef',
+    realm: 'Realm',
+    'redoc-revel': 'Redoc + Revel',
+    'redoc-reef': 'Redoc + Reef',
+    'revel-reef': 'Revel + Reef',
+};
+exports.PRODUCT_PLANS = ['pro', 'enterprise'];

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

@@ -0,0 +1,2 @@
+import type { PreviewProjectOptions } from './types';
+export declare const previewProject: (args: PreviewProjectOptions) => Promise<void>;

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

@@ -0,0 +1,58 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.previewProject = void 0;
+const path = require("path");
+const fs_1 = require("fs");
+const child_process_1 = require("child_process");
+const constants_1 = require("./constants");
+const previewProject = (args) => __awaiter(void 0, void 0, void 0, function* () {
+    const { plan, port } = args;
+    const projectDir = args['source-dir'];
+    const product = args.product || tryGetProductFromPackageJson(projectDir);
+    if (!isValidProduct(product)) {
+        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`);
+    (0, child_process_1.spawn)('npx', ['-y', packageName, 'develop', `--plan=${plan}`, `--port=${port || 4000}`], {
+        stdio: 'inherit',
+        cwd: projectDir,
+    });
+});
+exports.previewProject = previewProject;
+const isValidProduct = (product) => {
+    if (!product) {
+        return false;
+    }
+    return !!constants_1.PRODUCT_NAMES[product];
+};
+const tryGetProductFromPackageJson = (projectDir) => {
+    const packageJsonPath = path.join(process.cwd(), projectDir, 'package.json');
+    if ((0, fs_1.existsSync)(packageJsonPath)) {
+        try {
+            const packageJson = JSON.parse((0, fs_1.readFileSync)(packageJsonPath, 'utf-8'));
+            const packageJsonDeps = packageJson.dependencies || {};
+            for (const [product, packageName] of Object.entries(constants_1.PRODUCT_PACKAGES)) {
+                if (packageJsonDeps[packageName]) {
+                    process.stdout.write(`\n${packageName} detected in project's 'package.json'`);
+                    return product;
+                }
+            }
+        }
+        catch (error) {
+            process.stdout.write(`Invalid 'package.json': ${packageJsonPath}. Using Realm.`);
+        }
+    }
+    return 'realm';
+};

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

@@ -0,0 +1,10 @@
+import { PRODUCT_PACKAGES, PRODUCT_PLANS } from './constants';
+export type Product = keyof typeof PRODUCT_PACKAGES;
+export type ProductPlan = typeof PRODUCT_PLANS[number];
+export type PreviewProjectOptions = {
+    product?: Product | string;
+    plan: ProductPlan | string;
+    port?: number;
+    'source-dir': string;
+    config: string | undefined;
+};

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/commands/split/index.js

@@ -47,8 +47,8 @@ function splitDefinition(openapi, openapiDir, pathSeparator, ext) {
 function isStartsWithComponents(node) {
     return node.startsWith(types_1.componentsPath);
 }
-function isNotYaml(filename) {
-    return !(filename.endsWith('.yaml') || filename.endsWith('.yml'));
+function isSupportedExtension(filename) {
+    return filename.endsWith('.yaml') || filename.endsWith('.yml') || filename.endsWith('.json');
 }
 function loadFile(fileName) {
     try {
@@ -83,7 +83,7 @@ function traverseDirectoryDeep(directory, callback, componentsFiles) {
     }
 }
 function traverseDirectoryDeepCallback(filename, directory, componentsFiles) {
-    if (isNotYaml(filename))
+    if (!isSupportedExtension(filename))
         return;
     const pathData = (0, utils_1.readYaml)(filename);
     replace$Refs(pathData, directory, componentsFiles);

package/lib/index.js

@@ -26,6 +26,8 @@ const build_docs_1 = require("./commands/build-docs");
 const update_version_notifier_1 = require("./update-version-notifier");
 const wrapper_1 = require("./wrapper");
 const update_version_notifier_2 = require("./update-version-notifier");
+const preview_project_1 = require("./commands/preview-project");
+const constants_1 = require("./commands/preview-project/constants");
 if (!('replaceAll' in String.prototype)) {
     require('core-js/actual/string/replace-all');
 }
@@ -82,14 +84,14 @@ yargs
     process.env.REDOCLY_CLI_COMMAND = 'split';
     (0, wrapper_1.commandWrapper)(split_1.handleSplit)(argv);
 })
-    .command('join [apis...]', 'Join definitions [experimental].', (yargs) => yargs
+    .command('join [apis...]', 'Join multiple API descriptions into one [experimental].', (yargs) => yargs
     .positional('apis', {
     array: true,
     type: 'string',
     demandOption: true,
 })
     .option({
-    lint: { description: 'Lint definitions', type: 'boolean', default: false },
+    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': {
@@ -112,7 +114,7 @@ yargs
         type: 'boolean',
     },
     output: {
-        describe: 'Output file',
+        description: 'Output file.',
         alias: 'o',
         type: 'string',
     },
@@ -203,7 +205,7 @@ yargs
     process.env.REDOCLY_CLI_COMMAND = 'push';
     (0, wrapper_1.commandWrapper)((0, push_1.transformPush)(push_1.handlePush))(argv);
 })
-    .command('lint [apis...]', 'Lint definition.', (yargs) => yargs.positional('apis', { array: true, type: 'string', demandOption: true }).option({
+    .command('lint [apis...]', 'Lint an API description.', (yargs) => yargs.positional('apis', { array: true, type: 'string', demandOption: true }).option({
     format: {
         description: 'Use a specific output format.',
         choices: [
@@ -256,8 +258,12 @@ yargs
     process.env.REDOCLY_CLI_COMMAND = 'lint';
     (0, wrapper_1.commandWrapper)(lint_1.handleLint)(argv);
 })
-    .command('bundle [apis...]', 'Bundle definition.', (yargs) => yargs.positional('apis', { array: true, type: 'string', demandOption: true }).options({
-    output: { type: 'string', alias: 'o' },
+    .command('bundle [apis...]', 'Bundle a multi-file API description to a single file.', (yargs) => yargs.positional('apis', { array: true, type: 'string', demandOption: true }).options({
+    output: {
+        type: 'string',
+        description: 'Output file.',
+        alias: 'o',
+    },
     format: {
         description: 'Use a specific output format.',
         choices: ['stylish', 'codeframe', 'json', 'checkstyle'],
@@ -369,7 +375,32 @@ yargs
         process.stdout.write('Logged out from the Redocly account. ✋\n');
     }))(argv);
 }))
-    .command('preview-docs [api]', 'Preview API reference docs for the specified definition.', (yargs) => yargs.positional('api', { type: 'string' }).options({
+    .command('preview', 'Preview Redocly project using one of the product NPM packages.', (yargs) => yargs.options({
+    product: {
+        type: 'string',
+        choices: ['redoc', 'revel', 'reef', 'realm', 'redoc-revel', 'redoc-reef', 'revel-reef'],
+        description: "Product used to launch preview. Default is inferred from project's package.json or 'realm' is used.",
+    },
+    plan: {
+        type: 'string',
+        choices: constants_1.PRODUCT_PLANS,
+        default: 'enterprise',
+    },
+    port: {
+        type: 'number',
+        description: 'Preview port.',
+        default: 4000,
+    },
+    'source-dir': {
+        alias: 'd',
+        type: 'string',
+        description: 'Project directory.',
+        default: '.',
+    },
+}), (argv) => {
+    (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({
     port: {
         alias: 'p',
         type: 'number',
@@ -462,7 +493,7 @@ yargs
     process.env.REDOCLY_CLI_COMMAND = 'build-docs';
     (0, wrapper_1.commandWrapper)(build_docs_1.handlerBuildCommand)(argv);
 }))
-    .completion('completion', 'Generate completion script.')
+    .completion('completion', 'Generate autocomplete script for `redocly` command.')
     .demandCommand(1)
     .middleware([update_version_notifier_1.notifyUpdateCliVersion])
     .strict().argv;

package/lib/types.d.ts

@@ -8,6 +8,7 @@ import type { StatsOptions } from './commands/stats';
 import type { SplitOptions } from './commands/split';
 import type { PreviewDocsOptions } from './commands/preview-docs';
 import type { BuildDocsArgv } from './commands/build-docs/types';
+import type { PreviewProjectOptions } from './commands/preview-project/types';
 export type Totals = {
     errors: number;
     warnings: number;
@@ -20,7 +21,7 @@ export type Entrypoint = {
 export declare const outputExtensions: readonly BundleOutputFormat[];
 export type OutputExtensions = 'json' | 'yaml' | 'yml' | undefined;
 export declare const regionChoices: readonly Region[];
-export type CommandOptions = StatsOptions | SplitOptions | JoinOptions | PushOptions | LintOptions | BundleOptions | LoginOptions | PreviewDocsOptions | BuildDocsArgv;
+export type CommandOptions = StatsOptions | SplitOptions | JoinOptions | PushOptions | LintOptions | BundleOptions | LoginOptions | PreviewDocsOptions | BuildDocsArgv | PreviewProjectOptions;
 export type Skips = {
     'skip-rule'?: string[];
     'skip-decorator'?: string[];

package/lib/utils.d.ts

@@ -1,6 +1,7 @@
-import { BundleOutputFormat, StyleguideConfig, RawConfig, Region, Config, Oas3Definition, Oas2Definition } from '@redocly/openapi-core';
+import { BundleOutputFormat, StyleguideConfig, Region, Config, Oas3Definition, Oas2Definition } from '@redocly/openapi-core';
 import { Totals, Entrypoint, ConfigApis, CommandOptions, OutputExtensions } from './types';
 import { Arguments } from 'yargs';
+import type { RawConfigProcessor } from '@redocly/openapi-core/lib/config';
 export declare function getFallbackApisOrExit(argsApis: string[] | undefined, config: ConfigApis): Promise<Entrypoint[]>;
 export declare function getExecutionTime(startedAt: number): string;
 export declare function printExecutionTime(commandName: string, startedAt: number, api: string): void;
@@ -38,7 +39,7 @@ export declare function isSubdir(parent: string, dir: string): boolean;
 export declare function loadConfigAndHandleErrors(options?: {
     configPath?: string;
     customExtends?: string[];
-    processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>;
+    processRawConfig?: RawConfigProcessor;
     files?: string[];
     region?: Region;
 }): Promise<Config | void>;
@@ -64,3 +65,4 @@ export type Analytics = {
 };
 export declare function cleanArgs(args: CommandOptions): Record<string, unknown>;
 export declare function cleanRawInput(argv: string[]): string;
+export declare function checkForDeprecatedOptions<T>(argv: T, deprecatedOptions: Array<keyof T>): void;

package/lib/utils.js

@@ -20,7 +20,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanRawInput = exports.cleanArgs = exports.sendTelemetry = exports.cleanColors = exports.checkIfRulesetExist = exports.sortTopLevelKeysForOas = exports.loadConfigAndHandleErrors = exports.isSubdir = exports.exitWithError = exports.printUnusedWarnings = exports.getOutputFileName = exports.printConfigLintTotals = exports.printLintTotals = exports.HandledError = exports.handleError = exports.pluralize = exports.getAndValidateFileExtension = exports.writeJson = exports.writeYaml = exports.writeToFileByExtension = exports.readYaml = exports.promptUser = exports.saveBundle = exports.dumpBundle = exports.CircularJSONNotSupportedError = exports.langToExt = exports.escapeLanguageName = exports.pathToFilename = exports.printExecutionTime = exports.getExecutionTime = exports.getFallbackApisOrExit = void 0;
+exports.checkForDeprecatedOptions = exports.cleanRawInput = exports.cleanArgs = exports.sendTelemetry = exports.cleanColors = exports.checkIfRulesetExist = exports.sortTopLevelKeysForOas = exports.loadConfigAndHandleErrors = exports.isSubdir = exports.exitWithError = exports.printUnusedWarnings = exports.getOutputFileName = exports.printConfigLintTotals = exports.printLintTotals = exports.HandledError = exports.handleError = exports.pluralize = exports.getAndValidateFileExtension = exports.writeJson = exports.writeYaml = exports.writeToFileByExtension = exports.readYaml = exports.promptUser = exports.saveBundle = exports.dumpBundle = exports.CircularJSONNotSupportedError = exports.langToExt = exports.escapeLanguageName = exports.pathToFilename = exports.printExecutionTime = exports.getExecutionTime = exports.getFallbackApisOrExit = void 0;
 const fetch_with_timeout_1 = require("./fetch-with-timeout");
 const path_1 = require("path");
 const colorette_1 = require("colorette");
@@ -31,11 +31,11 @@ const readline = require("readline");
 const stream_1 = require("stream");
 const child_process_1 = require("child_process");
 const openapi_core_1 = require("@redocly/openapi-core");
-const config_1 = require("@redocly/openapi-core/lib/config");
 const types_1 = require("./types");
 const utils_1 = require("@redocly/openapi-core/lib/utils");
 const update_version_notifier_1 = require("./update-version-notifier");
 const push_1 = require("./commands/push");
+const config_1 = require("@redocly/openapi-core/lib/config");
 function getFallbackApisOrExit(argsApis, config) {
     return __awaiter(this, void 0, void 0, function* () {
         const { apis } = config;
@@ -127,6 +127,24 @@ function langToExt(lang) {
         javascript: '.js',
         js: '.js',
         python: '.py',
+        c: '.c',
+        'c++': '.cpp',
+        coffeescript: '.litcoffee',
+        dart: '.dart',
+        elixir: '.ex',
+        go: '.go',
+        groovy: '.groovy',
+        java: '.java',
+        kotlin: '.kt',
+        'objective-c': '.m',
+        perl: '.pl',
+        powershell: '.ps1',
+        ruby: '.rb',
+        rust: '.rs',
+        scala: '.sc',
+        swift: '.swift',
+        typescript: '.ts',
+        tsx: '.tsx',
     };
     return langObj[lang.toLowerCase()];
 }
@@ -524,3 +542,11 @@ function cleanRawInput(argv) {
     return argv.map((entry) => entry.split('=').map(cleanString).join('=')).join(' ');
 }
 exports.cleanRawInput = cleanRawInput;
+function checkForDeprecatedOptions(argv, deprecatedOptions) {
+    for (const option of deprecatedOptions) {
+        if (argv[option]) {
+            process.stderr.write((0, colorette_1.yellow)(`[WARNING] "${String(option)}" option is deprecated and will be removed in a future release. \n\n`));
+        }
+    }
+}
+exports.checkForDeprecatedOptions = checkForDeprecatedOptions;

package/package.json

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

package/src/__mocks__/utils.ts

@@ -19,3 +19,4 @@ export const checkIfRulesetExist = jest.fn();
 export const sortTopLevelKeysForOas = jest.fn((document) => document);
 export const getAndValidateFileExtension = jest.fn((fileName: string) => fileName.split('.').pop());
 export const writeToFileByExtension = jest.fn();
+export const checkForDeprecatedOptions = jest.fn();

package/src/__tests__/utils.test.ts

@@ -295,6 +295,24 @@ describe('langToExt', () => {
     ['javascript', '.js'],
     ['js', '.js'],
     ['python', '.py'],
+    ['c', '.c'],
+    ['c++', '.cpp'],
+    ['coffeescript', '.litcoffee'],
+    ['dart', '.dart'],
+    ['elixir', '.ex'],
+    ['go', '.go'],
+    ['groovy', '.groovy'],
+    ['java', '.java'],
+    ['kotlin', '.kt'],
+    ['objective-c', '.m'],
+    ['perl', '.pl'],
+    ['powershell', '.ps1'],
+    ['ruby', '.rb'],
+    ['rust', '.rs'],
+    ['scala', '.sc'],
+    ['swift', '.swift'],
+    ['typescript', '.ts'],
+    ['tsx', '.tsx'],
   ])('should infer file extension from lang - %s', (lang, expected) => {
     expect(langToExt(lang)).toBe(expected);
   });

package/src/commands/bundle.ts

@@ -23,6 +23,7 @@ import type { OutputExtensions, Skips, Totals } from '../types';
 import { performance } from 'perf_hooks';
 import { blue, gray, green, yellow } from 'colorette';
 import { writeFileSync } from 'fs';
+import { checkForDeprecatedOptions } from '../utils';
 
 export type BundleOptions = {
   apis?: string[];
@@ -47,8 +48,15 @@ export async function handleBundle(argv: BundleOptions, config: Config, version:
   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',
+  ];
 
-  checkForDeprecatedOptions(argv);
+  checkForDeprecatedOptions(argv, deprecatedOptions);
 
   for (const { path, alias } of apis) {
     try {
@@ -177,23 +185,3 @@ export async function handleBundle(argv: BundleOptions, config: Config, version:
     throw new Error('Bundle failed.');
   }
 }
-
-function checkForDeprecatedOptions(argv: BundleOptions) {
-  const deprecatedOptions: Array<keyof BundleOptions> = [
-    'lint',
-    'format',
-    'skip-rule',
-    'extends',
-    'max-problems',
-  ];
-
-  for (const option of deprecatedOptions) {
-    if (argv[option]) {
-      process.stderr.write(
-        yellow(
-          `[WARNING] "${option}" option is deprecated and will be removed in a future release. \n\n`
-        )
-      );
-    }
-  }
-}