@redocly/cli 1.0.2 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @redocly/cli
 
+## 1.2.0
+
+### Minor Changes
+
+- Added support for linting AsyncAPI v2 files, so that a wider range of API descriptions can use the Redocly linting workflow.
+
+### Patch Changes
+
+- Renamed API definition to API description for consistency.
+- Updated @redocly/openapi-core to v1.2.0.
+
+## 1.1.0
+
+### Minor Changes
+
+- Added `ignoreCase` option for `tags-alphabetical` rule.
+- Added `join` support for OAS 3.1 definitions.
+- Added support for Redoc v2.1.2, and aligned the dependencies for both projects.
+
+### Patch Changes
+
+- Fixed an issue where the `--remove-unused-components` option removed used components that were referenced as child objects.
+- Updated Redocly config validation.
+- Fixed the location pointer when reporting on the `no-path-trailing-slash` rule.
+- Updated minimum required version of Node.js to v14 and removed deprecated packages.
+- Updated @redocly/openapi-core to v1.1.0.
+
 ## 1.0.2
 
 ### Patch Changes

package/README.md

@@ -30,8 +30,8 @@ redocly lint path-to-root-file.yaml
 
 ### Docker
 
-To give the Docker container access to the OpenAPI definition files, you need to
-mount the containing directory as a volume. Assuming the OAS definition is rooted
+To give the Docker container access to the OpenAPI description files, you need to
+mount the containing directory as a volume. Assuming the API description is rooted
 in the current working directory, you need the following command:
 
 ```
@@ -93,7 +93,7 @@ This tool [collects data](./docs/usage-data.md) to help Redocly improve our prod
 
 ## Credits
 
-Thanks to [graphql-js](https://github.com/graphql/graphql-js) and [eslint](https://github.com/eslint/eslint) for inspiration of the definition traversal approach and to [Swagger](https://github.com/swagger-api/swagger-editor), [Spectral](https://github.com/stoplightio/spectral), and [OAS-Kit](https://github.com/Mermade/oas-kit) for inspiring the recommended ruleset.
+Thanks to [graphql-js](https://github.com/graphql/graphql-js) and [eslint](https://github.com/eslint/eslint) for inspiration of the API description traversal approach and to [Swagger](https://github.com/swagger-api/swagger-editor), [Spectral](https://github.com/stoplightio/spectral), and [OAS-Kit](https://github.com/Mermade/oas-kit) for inspiring the recommended ruleset.
 
 ## Development
 

package/lib/__mocks__/@redocly/openapi-core.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="jest" />
-import { Document } from '@redocly/openapi-core';
+import type { Document } from '@redocly/openapi-core';
 export declare const __redoclyClient: {
     isAuthorizedWithRedocly: jest.Mock<any, any>;
     isAuthorizedWithRedoclyByRegion: jest.Mock<any, any>;
@@ -61,7 +61,7 @@ export declare const doesYamlFileExist: jest.Mock<any, any>;
 export declare const bundleDocument: jest.Mock<Promise<{
     problems: {};
 }>, []>;
-export declare const detectOpenAPI: jest.Mock<any, any>;
+export declare const detectSpec: jest.Mock<any, any>;
 export declare const isAbsoluteUrl: jest.Mock<any, any>;
 export declare class BaseResolver {
     cache: Map<string, Promise<Document | ResolveError>>;
@@ -79,10 +79,11 @@ export declare class YamlParseError extends Error {
     originalError: Error;
     constructor(originalError: Error);
 }
-export declare enum OasVersion {
-    Version2 = "oas2",
-    Version3_0 = "oas3_0",
-    Version3_1 = "oas3_1"
+export declare enum SpecVersion {
+    OAS2 = "oas2",
+    OAS3_0 = "oas3_0",
+    OAS3_1 = "oas3_1",
+    Async2 = "async2"
 }
 export declare enum Oas3Operations {
     get = "get",

package/lib/__mocks__/@redocly/openapi-core.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Oas3Operations = exports.OasVersion = exports.YamlParseError = exports.ResolveError = exports.BaseResolver = exports.isAbsoluteUrl = exports.detectOpenAPI = exports.bundleDocument = exports.doesYamlFileExist = exports.findConfig = exports.slash = exports.formatProblems = exports.getTotals = exports.bundle = exports.lint = exports.getMergedConfig = exports.loadConfig = exports.RedoclyClient = exports.__redoclyClient = void 0;
+exports.Oas3Operations = exports.SpecVersion = exports.YamlParseError = exports.ResolveError = exports.BaseResolver = exports.isAbsoluteUrl = exports.detectSpec = exports.bundleDocument = exports.doesYamlFileExist = exports.findConfig = exports.slash = exports.formatProblems = exports.getTotals = exports.bundle = exports.lint = exports.getMergedConfig = exports.loadConfig = exports.RedoclyClient = exports.__redoclyClient = void 0;
 const config_1 = require("./../../__tests__/fixtures/config");
 const documents_1 = require("../documents");
 exports.__redoclyClient = {
@@ -28,7 +28,7 @@ exports.slash = jest.fn();
 exports.findConfig = jest.fn();
 exports.doesYamlFileExist = jest.fn();
 exports.bundleDocument = jest.fn(() => Promise.resolve({ problems: {} }));
-exports.detectOpenAPI = jest.fn();
+exports.detectSpec = jest.fn();
 exports.isAbsoluteUrl = jest.fn();
 class BaseResolver {
     constructor() {
@@ -60,12 +60,13 @@ class YamlParseError extends Error {
     }
 }
 exports.YamlParseError = YamlParseError;
-var OasVersion;
-(function (OasVersion) {
-    OasVersion["Version2"] = "oas2";
-    OasVersion["Version3_0"] = "oas3_0";
-    OasVersion["Version3_1"] = "oas3_1";
-})(OasVersion = exports.OasVersion || (exports.OasVersion = {}));
+var SpecVersion;
+(function (SpecVersion) {
+    SpecVersion["OAS2"] = "oas2";
+    SpecVersion["OAS3_0"] = "oas3_0";
+    SpecVersion["OAS3_1"] = "oas3_1";
+    SpecVersion["Async2"] = "async2";
+})(SpecVersion = exports.SpecVersion || (exports.SpecVersion = {}));
 var Oas3Operations;
 (function (Oas3Operations) {
     Oas3Operations["get"] = "get";

package/lib/__tests__/commands/build-docs.test.js

@@ -31,9 +31,6 @@ jest.mock('react-dom/server', () => ({
 jest.mock('handlebars', () => ({
     compile: jest.fn(() => jest.fn(() => '<html></html>')),
 }));
-jest.mock('mkdirp', () => ({
-    sync: jest.fn(),
-}));
 describe('build-docs', () => {
     it('should return correct html and call function for ssr', () => __awaiter(void 0, void 0, void 0, function* () {
         const result = yield utils_1.getPageHTML({}, '../some-path/openapi.yaml', Object.assign(Object.assign({}, config), { redocCurrentVersion: '2.0.0' }));

package/lib/__tests__/commands/join.test.js

@@ -41,21 +41,37 @@ describe('handleJoin fails', () => {
         }, {}, 'cli-version');
         expect(utils_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one! \n\n`);
     }));
-    it('should call exitWithError because Only OpenAPI 3 is supported', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('should call exitWithError because Only OpenAPI 3.0 and OpenAPI 3.1 are supported', () => __awaiter(void 0, void 0, void 0, function* () {
         yield join_1.handleJoin({
             apis: ['first.yaml', 'second.yaml'],
         }, config_1.ConfigFixture, 'cli-version');
-        expect(utils_1.exitWithError).toHaveBeenCalledWith('Only OpenAPI 3 is supported: undefined \n\n');
+        expect(utils_1.exitWithError).toHaveBeenCalledWith('Only OpenAPI 3.0 and OpenAPI 3.1 are supported: undefined \n\n');
+    }));
+    it('should call exitWithError if mixing OpenAPI 3.0 and 3.1', () => __awaiter(void 0, void 0, void 0, function* () {
+        openapi_core_1.detectSpec
+            .mockImplementationOnce(() => 'oas3_0')
+            .mockImplementationOnce(() => 'oas3_1');
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+        }, config_1.ConfigFixture, 'cli-version');
+        expect(utils_1.exitWithError).toHaveBeenCalledWith('All APIs must use the same OpenAPI version: undefined \n\n');
     }));
     it('should call writeYaml function', () => __awaiter(void 0, void 0, void 0, function* () {
-        openapi_core_1.detectOpenAPI.mockReturnValue('oas3_0');
+        openapi_core_1.detectSpec.mockReturnValue('oas3_0');
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+        }, config_1.ConfigFixture, 'cli-version');
+        expect(utils_1.writeYaml).toHaveBeenCalledWith(expect.any(Object), 'openapi.yaml', expect.any(Boolean));
+    }));
+    it('should call writeYaml function for OpenAPI 3.1', () => __awaiter(void 0, void 0, void 0, function* () {
+        openapi_core_1.detectSpec.mockReturnValue('oas3_1');
         yield join_1.handleJoin({
             apis: ['first.yaml', 'second.yaml'],
         }, config_1.ConfigFixture, 'cli-version');
         expect(utils_1.writeYaml).toHaveBeenCalledWith(expect.any(Object), 'openapi.yaml', expect.any(Boolean));
     }));
     it('should call writeYaml function with custom output file', () => __awaiter(void 0, void 0, void 0, function* () {
-        openapi_core_1.detectOpenAPI.mockReturnValue('oas3_0');
+        openapi_core_1.detectSpec.mockReturnValue('oas3_0');
         yield join_1.handleJoin({
             apis: ['first.yaml', 'second.yaml'],
             output: 'output.yml',
@@ -63,7 +79,7 @@ describe('handleJoin fails', () => {
         expect(utils_1.writeYaml).toHaveBeenCalledWith(expect.any(Object), 'output.yml', expect.any(Boolean));
     }));
     it('should call skipDecorators and skipPreprocessors', () => __awaiter(void 0, void 0, void 0, function* () {
-        openapi_core_1.detectOpenAPI.mockReturnValue('oas3_0');
+        openapi_core_1.detectSpec.mockReturnValue('oas3_0');
         yield join_1.handleJoin({
             apis: ['first.yaml', 'second.yaml'],
         }, config_1.ConfigFixture, 'cli-version');
@@ -72,7 +88,7 @@ describe('handleJoin fails', () => {
         expect(config.styleguide.skipPreprocessors).toHaveBeenCalled();
     }));
     it('should not call skipDecorators and skipPreprocessors', () => __awaiter(void 0, void 0, void 0, function* () {
-        openapi_core_1.detectOpenAPI.mockReturnValue('oas3_0');
+        openapi_core_1.detectSpec.mockReturnValue('oas3_0');
         yield join_1.handleJoin({
             apis: ['first.yaml', 'second.yaml'],
             decorate: true,

package/lib/__tests__/utils.test.js

@@ -338,13 +338,13 @@ describe('handleErrors', () => {
         const resolveError = new openapi_core_1.ResolveError(new Error('File not found'));
         expect(() => utils_1.handleError(resolveError, ref)).toThrowError(utils_1.HandledError);
         expect(redColoretteMocks).toHaveBeenCalledTimes(1);
-        expect(process.stderr.write).toHaveBeenCalledWith(`Failed to resolve api definition at openapi/test.yaml:\n\n  - File not found.\n\n`);
+        expect(process.stderr.write).toHaveBeenCalledWith(`Failed to resolve API description at openapi/test.yaml:\n\n  - File not found.\n\n`);
     });
     it('should handle YamlParseError', () => {
         const yamlParseError = new openapi_core_1.YamlParseError(new Error('Invalid yaml'), {});
         expect(() => utils_1.handleError(yamlParseError, ref)).toThrowError(utils_1.HandledError);
         expect(redColoretteMocks).toHaveBeenCalledTimes(1);
-        expect(process.stderr.write).toHaveBeenCalledWith(`Failed to parse api definition at openapi/test.yaml:\n\n  - Invalid yaml.\n\n`);
+        expect(process.stderr.write).toHaveBeenCalledWith(`Failed to parse API description at openapi/test.yaml:\n\n  - Invalid yaml.\n\n`);
     });
     it('should handle CircularJSONNotSupportedError', () => {
         const circularError = new utils_1.CircularJSONNotSupportedError(new Error('Circular json'));
@@ -376,6 +376,7 @@ describe('checkIfRulesetExist', () => {
             oas2: {},
             oas3_0: {},
             oas3_1: {},
+            async2: {},
         };
         expect(() => utils_1.checkIfRulesetExist(rules)).toThrowError('⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/');
     });

package/lib/assert-node-version.js

@@ -1,10 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const semver = require("semver");
 const path = require("path");
-const utils_1 = require("./utils");
+const process = require("process");
+const colorette_1 = require("colorette");
 try {
-    require('assert-node-version')(path.join(__dirname, '../'));
+    const { engines } = require(path.join(__dirname, '../package.json'));
+    const version = engines.node;
+    if (!semver.satisfies(process.version, version)) {
+        process.stderr.write(colorette_1.yellow(`\n⚠️ Warning: failed to satisfy expected node version. Expected: "${version}", Current "${process.version}"\n\n`));
+    }
 }
-catch (err) {
-    utils_1.exitWithError(err.message);
+catch (e) {
+    // Do nothing
 }

package/lib/commands/join.js

@@ -73,11 +73,16 @@ function handleJoin(argv, config, packageVersion) {
                 utils_1.exitWithError(`❌ Errors encountered while bundling ${colorette_1.blue(document.source.absoluteRef)}: join will not proceed.\n`);
             }
         }
+        let oasVersion = null;
         for (const document of documents) {
             try {
-                const version = openapi_core_1.detectOpenAPI(document.parsed);
-                if (version !== openapi_core_1.OasVersion.Version3_0) {
-                    return utils_1.exitWithError(`Only OpenAPI 3 is supported: ${colorette_1.blue(document.source.absoluteRef)} \n\n`);
+                const version = openapi_core_1.detectSpec(document.parsed);
+                if (version !== openapi_core_1.SpecVersion.OAS3_0 && version !== openapi_core_1.SpecVersion.OAS3_1) {
+                    return utils_1.exitWithError(`Only OpenAPI 3.0 and OpenAPI 3.1 are supported: ${colorette_1.blue(document.source.absoluteRef)} \n\n`);
+                }
+                oasVersion = oasVersion !== null && oasVersion !== void 0 ? oasVersion : version;
+                if (oasVersion !== version) {
+                    return utils_1.exitWithError(`All APIs must use the same OpenAPI version: ${colorette_1.blue(document.source.absoluteRef)} \n\n`);
                 }
             }
             catch (e) {
@@ -94,7 +99,7 @@ function handleJoin(argv, config, packageVersion) {
             tags: {},
             paths: {},
             components: {},
-            xWebhooks: {},
+            webhooks: {},
         };
         addInfoSectionAndSpecVersion(documents, prefixComponentsWithInfoProp);
         for (const document of documents) {
@@ -125,7 +130,7 @@ function handleJoin(argv, config, packageVersion) {
             collectExternalDocs(openapi, context);
             collectPaths(openapi, context);
             collectComponents(openapi, context);
-            collectXWebhooks(openapi, context);
+            collectWebhooks(oasVersion, openapi, context);
             if (componentsPrefix) {
                 replace$Refs(openapi, componentsPrefix);
             }
@@ -411,28 +416,28 @@ function handleJoin(argv, config, packageVersion) {
                 }
             }
         }
-        function collectXWebhooks(openapi, { apiFilename, api, potentialConflicts, tagsPrefix, componentsPrefix }) {
-            const xWebhooks = 'x-webhooks';
-            const openapiXWebhooks = openapi[xWebhooks];
-            if (openapiXWebhooks) {
-                if (!joinedDef.hasOwnProperty(xWebhooks)) {
-                    joinedDef[xWebhooks] = {};
-                }
-                for (const webhook of Object.keys(openapiXWebhooks)) {
-                    joinedDef[xWebhooks][webhook] = openapiXWebhooks[webhook];
-                    if (!potentialConflicts.xWebhooks.hasOwnProperty(webhook)) {
-                        potentialConflicts.xWebhooks[webhook] = {};
+        function collectWebhooks(oasVersion, openapi, { apiFilename, api, potentialConflicts, tagsPrefix, componentsPrefix }) {
+            const webhooks = oasVersion === openapi_core_1.SpecVersion.OAS3_1 ? 'webhooks' : 'x-webhooks';
+            const openapiWebhooks = openapi[webhooks];
+            if (openapiWebhooks) {
+                if (!joinedDef.hasOwnProperty(webhooks)) {
+                    joinedDef[webhooks] = {};
+                }
+                for (const webhook of Object.keys(openapiWebhooks)) {
+                    joinedDef[webhooks][webhook] = openapiWebhooks[webhook];
+                    if (!potentialConflicts.webhooks.hasOwnProperty(webhook)) {
+                        potentialConflicts.webhooks[webhook] = {};
                     }
-                    for (const operation of Object.keys(openapiXWebhooks[webhook])) {
-                        potentialConflicts.xWebhooks[webhook][operation] = [
-                            ...(potentialConflicts.xWebhooks[webhook][operation] || []),
+                    for (const operation of Object.keys(openapiWebhooks[webhook])) {
+                        potentialConflicts.webhooks[webhook][operation] = [
+                            ...(potentialConflicts.webhooks[webhook][operation] || []),
                             api,
                         ];
                     }
-                    for (const operationKey of Object.keys(joinedDef[xWebhooks][webhook])) {
-                        const { tags } = joinedDef[xWebhooks][webhook][operationKey];
+                    for (const operationKey of Object.keys(joinedDef[webhooks][webhook])) {
+                        const { tags } = joinedDef[webhooks][webhook][operationKey];
                         if (tags) {
-                            joinedDef[xWebhooks][webhook][operationKey].tags = tags.map((tag) => addPrefix(tag, tagsPrefix));
+                            joinedDef[webhooks][webhook][operationKey].tags = tags.map((tag) => addPrefix(tag, tagsPrefix));
                             populateTags({
                                 api,
                                 apiFilename,

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

@@ -51,7 +51,7 @@ function previewDocs(argv, configFromFile) {
                     return openapiBundle.parsed;
                 }
                 catch (e) {
-                    handleError(e, api.path);
+                    utils_1.handleError(e, api.path);
                 }
             });
         }
@@ -138,14 +138,3 @@ function debounce(func, wait, immediate) {
     };
 }
 exports.debounce = debounce;
-function handleError(e, ref) {
-    if (e instanceof openapi_core_1.ResolveError) {
-        process.stderr.write(`Failed to resolve api definition at ${ref}:\n\n  - ${e.message}.\n\n`);
-    }
-    else if (e instanceof openapi_core_1.YamlParseError) {
-        process.stderr.write(`Failed to parse api definition at ${ref}:\n\n  - ${e.message}.\n\n`);
-    }
-    else {
-        process.stderr.write(`Something went wrong when processing ${ref}:\n\n  - ${e.message}.\n\n`);
-    }
-}

package/lib/commands/preview-docs/preview-server/preview-server.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const handlebars_1 = require("handlebars");
 const colorette = require("colorette");
-const portfinder = require("portfinder");
+const get_port_please_1 = require("get-port-please");
 const fs_1 = require("fs");
 const path = require("path");
 const server_1 = require("./server");
@@ -113,7 +113,7 @@ function startPreviewServer(port, host, { getBundle, getOptions, useRedocPro, })
             }
             console.timeEnd(colorette.dim(`GET ${request.url}`));
         });
-        const wsPort = yield portfinder.getPortPromise({ port: 32201 });
+        const wsPort = yield get_port_please_1.getPort({ portRange: [32201, 32301] });
         const server = server_1.startHttpServer(port, host, handler);
         server.on('listening', () => {
             process.stdout.write(`\n  🔎  Preview server running at ${colorette.blue(`http://${host}:${port}\n`)}`);

package/lib/commands/stats.js

@@ -58,13 +58,12 @@ function handleStats(argv, config) {
         const externalRefResolver = new openapi_core_1.BaseResolver(config.resolve);
         const { bundle: document } = yield openapi_core_1.bundle({ config, ref: path });
         const lintConfig = config.styleguide;
-        const oasVersion = openapi_core_1.detectOpenAPI(document.parsed);
-        const oasMajorVersion = openapi_core_1.openAPIMajor(oasVersion);
-        const types = openapi_core_1.normalizeTypes(lintConfig.extendTypes(oasMajorVersion === openapi_core_1.OasMajorVersion.Version3 ? openapi_core_1.Oas3Types : openapi_core_1.Oas2Types, oasVersion), lintConfig);
+        const specVersion = openapi_core_1.detectSpec(document.parsed);
+        const types = openapi_core_1.normalizeTypes(lintConfig.extendTypes(openapi_core_1.getTypes(specVersion), specVersion), lintConfig);
         const startedAt = perf_hooks_1.performance.now();
         const ctx = {
             problems: [],
-            oasVersion: oasVersion,
+            oasVersion: specVersion,
             visitorsData: {},
         };
         const resolvedRefMap = yield openapi_core_1.resolveDocument({

package/lib/index.js

@@ -26,6 +26,9 @@ 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");
+if (!('replaceAll' in String.prototype)) {
+    require('core-js/actual/string/replace-all');
+}
 update_version_notifier_1.cacheLatestVersion();
 yargs
     .version('version', 'Show version number.', update_version_notifier_2.version)
@@ -42,9 +45,9 @@ yargs
     process.env.REDOCLY_CLI_COMMAND = 'stats';
     wrapper_1.commandWrapper(stats_1.handleStats)(argv);
 })
-    .command('split [api]', 'Split an API definition into a multi-file structure.', (yargs) => yargs
+    .command('split [api]', 'Split an API description into a multi-file structure.', (yargs) => yargs
     .positional('api', {
-    description: 'API definition file that you want to split',
+    description: 'API description file that you want to split',
     type: 'string',
 })
     .option({
@@ -113,7 +116,7 @@ yargs
     process.env.REDOCLY_CLI_COMMAND = 'join';
     wrapper_1.commandWrapper(join_1.handleJoin)(argv);
 })
-    .command('push [api] [maybeDestination] [maybeBranchName]', 'Push an API definition to the Redocly API registry.', (yargs) => yargs
+    .command('push [api] [maybeDestination] [maybeBranchName]', 'Push an API description to the Redocly API registry.', (yargs) => yargs
     .usage('push [api]')
     .positional('api', { type: 'string' })
     .positional('maybeDestination', { type: 'string' })
@@ -164,7 +167,7 @@ yargs
         type: 'string',
     },
     public: {
-        description: 'Make the API definition available to the public',
+        description: 'Make the API description available to the public',
         type: 'boolean',
     },
     files: {
@@ -282,7 +285,7 @@ yargs
         type: 'string',
     },
     lint: {
-        description: 'Lint API definitions',
+        description: 'Lint API descriptions',
         type: 'boolean',
         default: false,
     },

package/lib/utils.js

@@ -25,7 +25,7 @@ const fetch_with_timeout_1 = require("./fetch-with-timeout");
 const path_1 = require("path");
 const colorette_1 = require("colorette");
 const perf_hooks_1 = require("perf_hooks");
-const glob = require("glob-promise");
+const glob = require("glob");
 const fs = require("fs");
 const readline = require("readline");
 const stream_1 = require("stream");
@@ -87,7 +87,7 @@ function expandGlobsInEntrypoints(args, config) {
     return __awaiter(this, void 0, void 0, function* () {
         return (yield Promise.all(args.map((aliasOrPath) => __awaiter(this, void 0, void 0, function* () {
             return glob.hasMagic(aliasOrPath) && !openapi_core_1.isAbsoluteUrl(aliasOrPath)
-                ? (yield glob(aliasOrPath)).map((g) => getAliasOrPath(config, g))
+                ? (yield glob.__promisify__(aliasOrPath)).map((g) => getAliasOrPath(config, g))
                 : getAliasOrPath(config, aliasOrPath);
         })))).flat();
     });
@@ -222,10 +222,9 @@ function handleError(e, ref) {
             throw e;
         }
         case openapi_core_1.ResolveError:
-            return exitWithError(`Failed to resolve api definition at ${ref}:\n\n  - ${e.message}.`);
+            return exitWithError(`Failed to resolve API description at ${ref}:\n\n  - ${e.message}.`);
         case openapi_core_1.YamlParseError:
-            return exitWithError(`Failed to parse api definition at ${ref}:\n\n  - ${e.message}.`);
-        // TODO: codeframe
+            return exitWithError(`Failed to parse API description at ${ref}:\n\n  - ${e.message}.`);
         case CircularJSONNotSupportedError: {
             return exitWithError(`Detected circular reference which can't be converted to JSON.\n` +
                 `Try to use ${colorette_1.blue('yaml')} output or remove ${colorette_1.blue('--dereferenced')}.`);
@@ -251,11 +250,11 @@ function printLintTotals(totals, definitionsCount) {
             : ''}.\n${ignored}`));
     }
     else if (totals.warnings > 0) {
-        process.stderr.write(colorette_1.green(`Woohoo! Your OpenAPI ${pluralize('definition is', definitionsCount)} valid. 🎉\n`));
+        process.stderr.write(colorette_1.green(`Woohoo! Your API ${pluralize('description is', definitionsCount)} valid. 🎉\n`));
         process.stderr.write(colorette_1.yellow(`You have ${totals.warnings} ${pluralize('warning', totals.warnings)}.\n${ignored}`));
     }
     else {
-        process.stderr.write(colorette_1.green(`Woohoo! Your OpenAPI ${pluralize('definition is', definitionsCount)} valid. 🎉\n${ignored}`));
+        process.stderr.write(colorette_1.green(`Woohoo! Your API ${pluralize('description is', definitionsCount)} valid. 🎉\n${ignored}`));
     }
     if (totals.errors > 0) {
         process.stderr.write(colorette_1.gray(`run \`redocly lint --generate-ignore-file\` to add all problems to the ignore file.\n`));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -8,7 +8,7 @@
     "redocly": "bin/cli.js"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "engineStrict": true,
   "scripts": {
@@ -28,36 +28,36 @@
     "Swagger",
     "OpenAPI linter",
     "Swagger linter",
+    "AsyncAPI linter",
     "oas"
   ],
   "contributors": [
     "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.0.2",
-    "assert-node-version": "^1.0.3",
+    "@redocly/openapi-core": "1.2.0",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",
+    "core-js": "^3.32.1",
+    "get-port-please": "^3.0.1",
     "glob": "^7.1.6",
-    "glob-promise": "^3.4.0",
     "handlebars": "^4.7.6",
-    "portfinder": "^1.0.26",
-    "redoc": "~2.0.0",
+    "mobx": "^6.0.4",
+    "react": "^17.0.0 || ^18.2.0",
+    "react-dom": "^17.0.0 || ^18.2.0",
+    "redoc": "~2.1.2",
     "semver": "^7.5.2",
     "simple-websocket": "^9.0.0",
-    "yargs": "17.0.1",
-    "mobx": "^6.0.4",
-    "react": "^17.0.0",
-    "react-dom": "^17.0.0",
-    "styled-components": "^5.1.1"
+    "styled-components": "^6.0.7",
+    "yargs": "17.0.1"
   },
   "devDependencies": {
     "@types/configstore": "^5.0.1",
-    "@types/react": "^17.0.8",
-    "@types/react-dom": "^17.0.5",
-    "@types/styled-components": "^5.1.1",
-    "@types/yargs": "17.0.5",
+    "@types/glob": "^8.1.0",
+    "@types/react": "^17.0.0 || ^18.2.21",
+    "@types/react-dom": "^17.0.0 || ^18.2.7",
     "@types/semver": "^7.5.0",
+    "@types/yargs": "17.0.5",
     "typescript": "^4.0.3"
   }
 }

package/src/__mocks__/@redocly/openapi-core.ts

@@ -1,7 +1,8 @@
 import { ConfigFixture } from './../../__tests__/fixtures/config';
-import { Document } from '@redocly/openapi-core';
 import { firstDocument, secondDocument } from '../documents';
 
+import type { Document } from '@redocly/openapi-core';
+
 export const __redoclyClient = {
   isAuthorizedWithRedocly: jest.fn().mockResolvedValue(true),
   isAuthorizedWithRedoclyByRegion: jest.fn().mockResolvedValue(true),
@@ -28,7 +29,7 @@ export const slash = jest.fn();
 export const findConfig = jest.fn();
 export const doesYamlFileExist = jest.fn();
 export const bundleDocument = jest.fn(() => Promise.resolve({ problems: {} }));
-export const detectOpenAPI = jest.fn();
+export const detectSpec = jest.fn();
 export const isAbsoluteUrl = jest.fn();
 
 export class BaseResolver {
@@ -62,10 +63,11 @@ export class YamlParseError extends Error {
   }
 }
 
-export enum OasVersion {
-  Version2 = 'oas2',
-  Version3_0 = 'oas3_0',
-  Version3_1 = 'oas3_1',
+export enum SpecVersion {
+  OAS2 = 'oas2',
+  OAS3_0 = 'oas3_0',
+  OAS3_1 = 'oas3_1',
+  Async2 = 'async2',
 }
 
 export enum Oas3Operations {

package/src/__tests__/commands/build-docs.test.ts

@@ -26,10 +26,6 @@ jest.mock('handlebars', () => ({
   compile: jest.fn(() => jest.fn(() => '<html></html>')),
 }));
 
-jest.mock('mkdirp', () => ({
-  sync: jest.fn(),
-}));
-
 describe('build-docs', () => {
   it('should return correct html and call function for ssr', async () => {
     const result = await getPageHTML({}, '../some-path/openapi.yaml', {