@redocly/cli 1.18.0 → 1.19.0

package/lib/commands/lint.d.ts

@@ -1,7 +1,7 @@
-import { Config } from '@redocly/openapi-core';
 import type { OutputFormat, RuleSeverity } from '@redocly/openapi-core';
 import type { RawConfigProcessor } from '@redocly/openapi-core/lib/config';
 import type { CommandOptions, Skips } from '../types';
+import type { CommandArgs } from '../wrapper';
 export type LintOptions = {
     apis?: string[];
     'max-problems': number;
@@ -11,5 +11,5 @@ export type LintOptions = {
     'generate-ignore-file'?: boolean;
     'lint-config'?: RuleSeverity;
 } & Omit<Skips, 'skip-decorator'>;
-export declare function handleLint(argv: LintOptions, config: Config, version: string): Promise<void>;
+export declare function handleLint({ argv, config, version, collectSpecData, }: CommandArgs<LintOptions>): Promise<void>;
 export declare function lintConfigCallback(argv: CommandOptions & Record<string, undefined>, version: string): RawConfigProcessor | undefined;

package/lib/commands/lint.js

@@ -1,88 +1,78 @@
 "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.lintConfigCallback = exports.handleLint = void 0;
+exports.handleLint = handleLint;
+exports.lintConfigCallback = lintConfigCallback;
+const colorette_1 = require("colorette");
+const perf_hooks_1 = require("perf_hooks");
 const openapi_core_1 = require("@redocly/openapi-core");
 const config_1 = require("@redocly/openapi-core/lib/config");
 const miscellaneous_1 = require("../utils/miscellaneous");
-const colorette_1 = require("colorette");
-const perf_hooks_1 = require("perf_hooks");
 const getCommandNameFromArgs_1 = require("../utils/getCommandNameFromArgs");
-function handleLint(argv, config, version) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const apis = yield (0, miscellaneous_1.getFallbackApisOrExit)(argv.apis, config);
-        if (!apis.length) {
-            (0, miscellaneous_1.exitWithError)('No APIs were provided.');
-        }
-        if (argv['generate-ignore-file']) {
-            config.styleguide.ignore = {}; // clear ignore
-        }
-        const totals = { errors: 0, warnings: 0, ignored: 0 };
-        let totalIgnored = 0;
-        // TODO: use shared externalRef resolver, blocked by preprocessors now as they can mutate documents
-        for (const { path, alias } of apis) {
-            try {
-                const startedAt = perf_hooks_1.performance.now();
-                const resolvedConfig = (0, openapi_core_1.getMergedConfig)(config, alias);
-                const { styleguide } = resolvedConfig;
-                (0, miscellaneous_1.checkIfRulesetExist)(styleguide.rules);
-                styleguide.skipRules(argv['skip-rule']);
-                styleguide.skipPreprocessors(argv['skip-preprocessor']);
-                if (styleguide.recommendedFallback) {
-                    process.stderr.write(`No configurations were provided -- using built in ${(0, colorette_1.blue)('recommended')} configuration by default.\n\n`);
-                }
-                process.stderr.write((0, colorette_1.gray)(`validating ${path.replace(process.cwd(), '')}...\n`));
-                const results = yield (0, openapi_core_1.lint)({
-                    ref: path,
-                    config: resolvedConfig,
-                });
-                const fileTotals = (0, openapi_core_1.getTotals)(results);
-                totals.errors += fileTotals.errors;
-                totals.warnings += fileTotals.warnings;
-                totals.ignored += fileTotals.ignored;
-                if (argv['generate-ignore-file']) {
-                    for (const m of results) {
-                        config.styleguide.addIgnore(m);
-                        totalIgnored++;
-                    }
-                }
-                else {
-                    (0, openapi_core_1.formatProblems)(results, {
-                        format: argv.format,
-                        maxProblems: argv['max-problems'],
-                        totals: fileTotals,
-                        version,
-                    });
+async function handleLint({ argv, config, version, collectSpecData, }) {
+    const apis = await (0, miscellaneous_1.getFallbackApisOrExit)(argv.apis, config);
+    if (!apis.length) {
+        (0, miscellaneous_1.exitWithError)('No APIs were provided.');
+    }
+    if (argv['generate-ignore-file']) {
+        config.styleguide.ignore = {}; // clear ignore
+    }
+    const totals = { errors: 0, warnings: 0, ignored: 0 };
+    let totalIgnored = 0;
+    // TODO: use shared externalRef resolver, blocked by preprocessors now as they can mutate documents
+    for (const { path, alias } of apis) {
+        try {
+            const startedAt = perf_hooks_1.performance.now();
+            const resolvedConfig = (0, openapi_core_1.getMergedConfig)(config, alias);
+            const { styleguide } = resolvedConfig;
+            (0, miscellaneous_1.checkIfRulesetExist)(styleguide.rules);
+            styleguide.skipRules(argv['skip-rule']);
+            styleguide.skipPreprocessors(argv['skip-preprocessor']);
+            if (styleguide.recommendedFallback) {
+                process.stderr.write(`No configurations were provided -- using built in ${(0, colorette_1.blue)('recommended')} configuration by default.\n\n`);
+            }
+            process.stderr.write((0, colorette_1.gray)(`validating ${path.replace(process.cwd(), '')}...\n`));
+            const results = await (0, openapi_core_1.lint)({
+                ref: path,
+                config: resolvedConfig,
+                collectSpecData,
+            });
+            const fileTotals = (0, openapi_core_1.getTotals)(results);
+            totals.errors += fileTotals.errors;
+            totals.warnings += fileTotals.warnings;
+            totals.ignored += fileTotals.ignored;
+            if (argv['generate-ignore-file']) {
+                for (const m of results) {
+                    config.styleguide.addIgnore(m);
+                    totalIgnored++;
                 }
-                const elapsed = (0, miscellaneous_1.getExecutionTime)(startedAt);
-                process.stderr.write((0, colorette_1.gray)(`${path.replace(process.cwd(), '')}: validated in ${elapsed}\n\n`));
             }
-            catch (e) {
-                (0, miscellaneous_1.handleError)(e, path);
+            else {
+                (0, openapi_core_1.formatProblems)(results, {
+                    format: argv.format,
+                    maxProblems: argv['max-problems'],
+                    totals: fileTotals,
+                    version,
+                });
             }
+            const elapsed = (0, miscellaneous_1.getExecutionTime)(startedAt);
+            process.stderr.write((0, colorette_1.gray)(`${path.replace(process.cwd(), '')}: validated in ${elapsed}\n\n`));
         }
-        if (argv['generate-ignore-file']) {
-            config.styleguide.saveIgnore();
-            process.stderr.write(`Generated ignore file with ${totalIgnored} ${(0, miscellaneous_1.pluralize)('problem', totalIgnored)}.\n\n`);
-        }
-        else {
-            (0, miscellaneous_1.printLintTotals)(totals, apis.length);
-        }
-        (0, miscellaneous_1.printUnusedWarnings)(config.styleguide);
-        if (!(totals.errors === 0 || argv['generate-ignore-file'])) {
-            throw new Error('Lint failed.');
+        catch (e) {
+            (0, miscellaneous_1.handleError)(e, path);
         }
-    });
+    }
+    if (argv['generate-ignore-file']) {
+        config.styleguide.saveIgnore();
+        process.stderr.write(`Generated ignore file with ${totalIgnored} ${(0, miscellaneous_1.pluralize)('problem', totalIgnored)}.\n\n`);
+    }
+    else {
+        (0, miscellaneous_1.printLintTotals)(totals, apis.length);
+    }
+    (0, miscellaneous_1.printUnusedWarnings)(config.styleguide);
+    if (!(totals.errors === 0 || argv['generate-ignore-file'])) {
+        throw new Error('Lint failed.');
+    }
 }
-exports.handleLint = handleLint;
 function lintConfigCallback(argv, version) {
     if (argv['lint-config'] === 'off') {
         return;
@@ -91,8 +81,12 @@ function lintConfigCallback(argv, version) {
         // we can't print config lint results as it will break json output
         return;
     }
-    return ({ document, resolvedRefMap, config }) => __awaiter(this, void 0, void 0, function* () {
-        const problems = yield (0, openapi_core_1.lintConfig)({
+    return async ({ document, resolvedRefMap, config, parsed: { theme = {} } }) => {
+        const command = argv ? (0, getCommandNameFromArgs_1.getCommandNameFromArgs)(argv) : undefined;
+        if (command === 'check-config') {
+            (0, miscellaneous_1.notifyAboutIncompatibleConfigOptions)(theme.openapi);
+        }
+        const problems = await (0, openapi_core_1.lintConfig)({
             document,
             resolvedRefMap,
             config,
@@ -105,11 +99,9 @@ function lintConfigCallback(argv, version) {
             totals: fileTotals,
             version,
         });
-        const command = argv ? (0, getCommandNameFromArgs_1.getCommandNameFromArgs)(argv) : undefined;
         (0, miscellaneous_1.printConfigLintTotals)(fileTotals, command);
         if (fileTotals.errors > 0) {
             throw new config_1.ConfigValidationError();
         }
-    });
+    };
 }
-exports.lintConfigCallback = lintConfigCallback;

package/lib/commands/login.d.ts

@@ -1,8 +1,9 @@
-import { Region, Config } from '@redocly/openapi-core';
+import { Region } from '@redocly/openapi-core';
+import type { CommandArgs } from '../wrapper';
 export declare function promptClientToken(domain: string): Promise<string>;
 export type LoginOptions = {
     verbose?: boolean;
     region?: Region;
     config?: string;
 };
-export declare function handleLogin(argv: LoginOptions, config: Config): Promise<void>;
+export declare function handleLogin({ argv, config }: CommandArgs<LoginOptions>): Promise<void>;

package/lib/commands/login.js

@@ -1,30 +1,18 @@
 "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.handleLogin = exports.promptClientToken = void 0;
+exports.promptClientToken = promptClientToken;
+exports.handleLogin = handleLogin;
 const openapi_core_1 = require("@redocly/openapi-core");
 const colorette_1 = require("colorette");
 const miscellaneous_1 = require("../utils/miscellaneous");
 function promptClientToken(domain) {
     return (0, miscellaneous_1.promptUser)((0, colorette_1.green)(`\n  🔑 Copy your API key from ${(0, colorette_1.blue)(`https://app.${domain}/profile`)} and paste it below`), true);
 }
-exports.promptClientToken = promptClientToken;
-function handleLogin(argv, config) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const region = argv.region || config.region;
-        const client = new openapi_core_1.RedoclyClient(region);
-        const clientToken = yield promptClientToken(client.domain);
-        process.stdout.write((0, colorette_1.gray)('\n  Logging in...\n'));
-        yield client.login(clientToken, argv.verbose);
-        process.stdout.write((0, colorette_1.green)('  Authorization confirmed. ✅\n\n'));
-    });
+async function handleLogin({ argv, config }) {
+    const region = argv.region || config.region;
+    const client = new openapi_core_1.RedoclyClient(region);
+    const clientToken = await promptClientToken(client.domain);
+    process.stdout.write((0, colorette_1.gray)('\n  Logging in...\n'));
+    await client.login(clientToken, argv.verbose);
+    process.stdout.write((0, colorette_1.green)('  Authorization confirmed. ✅\n\n'));
 }
-exports.handleLogin = handleLogin;

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

@@ -1,5 +1,5 @@
-import { Config } from '@redocly/openapi-core';
 import type { Skips } from '../../types';
+import type { CommandArgs } from '../../wrapper';
 export type PreviewDocsOptions = {
     port: number;
     host: string;
@@ -8,5 +8,5 @@ export type PreviewDocsOptions = {
     api?: string;
     force?: boolean;
 } & Omit<Skips, 'skip-rule'>;
-export declare function previewDocs(argv: PreviewDocsOptions, configFromFile: Config): Promise<void>;
+export declare function previewDocs({ argv, config: configFromFile, }: CommandArgs<PreviewDocsOptions>): Promise<void>;
 export declare function debounce(func: Function, wait: number, immediate?: boolean): (...args: any[]) => void;

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

@@ -1,122 +1,109 @@
 "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.debounce = exports.previewDocs = void 0;
+exports.previewDocs = previewDocs;
+exports.debounce = debounce;
 const colorette = require("colorette");
 const chockidar = require("chokidar");
 const openapi_core_1 = require("@redocly/openapi-core");
 const miscellaneous_1 = require("../../utils/miscellaneous");
 const preview_server_1 = require("./preview-server/preview-server");
-function previewDocs(argv, configFromFile) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let isAuthorizedWithRedocly = false;
-        let redocOptions = {};
-        let config = yield reloadConfig(configFromFile);
-        const apis = yield (0, miscellaneous_1.getFallbackApisOrExit)(argv.api ? [argv.api] : [], config);
-        const api = apis[0];
-        let cachedBundle;
-        const deps = new Set();
-        function getBundle() {
-            return __awaiter(this, void 0, void 0, function* () {
-                return cachedBundle;
+async function previewDocs({ argv, config: configFromFile, }) {
+    let isAuthorizedWithRedocly = false;
+    let redocOptions = {};
+    let config = await reloadConfig(configFromFile);
+    const apis = await (0, miscellaneous_1.getFallbackApisOrExit)(argv.api ? [argv.api] : [], config);
+    const api = apis[0];
+    let cachedBundle;
+    const deps = new Set();
+    async function getBundle() {
+        return cachedBundle;
+    }
+    async function updateBundle() {
+        process.stdout.write('\nBundling...\n\n');
+        try {
+            const { bundle: openapiBundle, problems, fileDependencies, } = await (0, openapi_core_1.bundle)({
+                ref: api.path,
+                config,
             });
+            const removed = [...deps].filter((x) => !fileDependencies.has(x));
+            watcher.unwatch(removed);
+            watcher.add([...fileDependencies]);
+            deps.clear();
+            fileDependencies.forEach(deps.add, deps);
+            const fileTotals = (0, openapi_core_1.getTotals)(problems);
+            if (fileTotals.errors === 0) {
+                process.stdout.write(fileTotals.errors === 0
+                    ? `Created a bundle for ${api.alias || api.path} ${fileTotals.warnings > 0 ? 'with warnings' : 'successfully'}\n`
+                    : colorette.yellow(`Created a bundle for ${api.alias || api.path} with errors. Docs may be broken or not accurate\n`));
+            }
+            return openapiBundle.parsed;
         }
-        function updateBundle() {
-            return __awaiter(this, void 0, void 0, function* () {
-                process.stdout.write('\nBundling...\n\n');
-                try {
-                    const { bundle: openapiBundle, problems, fileDependencies, } = yield (0, openapi_core_1.bundle)({
-                        ref: api.path,
-                        config,
-                    });
-                    const removed = [...deps].filter((x) => !fileDependencies.has(x));
-                    watcher.unwatch(removed);
-                    watcher.add([...fileDependencies]);
-                    deps.clear();
-                    fileDependencies.forEach(deps.add, deps);
-                    const fileTotals = (0, openapi_core_1.getTotals)(problems);
-                    if (fileTotals.errors === 0) {
-                        process.stdout.write(fileTotals.errors === 0
-                            ? `Created a bundle for ${api.alias || api.path} ${fileTotals.warnings > 0 ? 'with warnings' : 'successfully'}\n`
-                            : colorette.yellow(`Created a bundle for ${api.alias || api.path} with errors. Docs may be broken or not accurate\n`));
-                    }
-                    return openapiBundle.parsed;
-                }
-                catch (e) {
-                    (0, miscellaneous_1.handleError)(e, api.path);
-                }
-            });
+        catch (e) {
+            (0, miscellaneous_1.handleError)(e, api.path);
         }
-        setImmediate(() => {
-            cachedBundle = updateBundle();
-        }); // initial cache
-        const isAuthorized = isAuthorizedWithRedocly || redocOptions.licenseKey;
-        if (!isAuthorized) {
-            process.stderr.write(`Using Redoc community edition.\nLogin with redocly ${colorette.blue('login')} or use an enterprise license key to preview with the premium docs.\n\n`);
+    }
+    setImmediate(() => {
+        cachedBundle = updateBundle();
+    }); // initial cache
+    const isAuthorized = isAuthorizedWithRedocly || redocOptions.licenseKey;
+    if (!isAuthorized) {
+        process.stderr.write(`Using Redoc community edition.\nLogin with redocly ${colorette.blue('login')} or use an enterprise license key to preview with the premium docs.\n\n`);
+    }
+    const hotClients = await (0, preview_server_1.default)(argv.port, argv.host, {
+        getBundle,
+        getOptions: () => redocOptions,
+        useRedocPro: isAuthorized && !redocOptions.useCommunityEdition,
+    });
+    const watchPaths = [api.path, config.configFile].filter((e) => !!e);
+    const watcher = chockidar.watch(watchPaths, {
+        disableGlobbing: true,
+        ignoreInitial: true,
+    });
+    const debouncedUpdatedBundle = debounce(async () => {
+        cachedBundle = updateBundle();
+        await cachedBundle;
+        hotClients.broadcast('{"type": "reload", "bundle": true}');
+    }, 2000);
+    const changeHandler = async (type, file) => {
+        process.stdout.write(`${colorette.green('watch')} ${type} ${colorette.blue(file)}\n`);
+        if (file === config.configFile) {
+            config = await reloadConfig();
+            hotClients.broadcast(JSON.stringify({ type: 'reload' }));
+            return;
         }
-        const hotClients = yield (0, preview_server_1.default)(argv.port, argv.host, {
-            getBundle,
-            getOptions: () => redocOptions,
-            useRedocPro: isAuthorized && !redocOptions.useCommunityEdition,
-        });
-        const watchPaths = [api.path, config.configFile].filter((e) => !!e);
-        const watcher = chockidar.watch(watchPaths, {
-            disableGlobbing: true,
-            ignoreInitial: true,
-        });
-        const debouncedUpdatedBundle = debounce(() => __awaiter(this, void 0, void 0, function* () {
-            cachedBundle = updateBundle();
-            yield cachedBundle;
-            hotClients.broadcast('{"type": "reload", "bundle": true}');
-        }), 2000);
-        const changeHandler = (type, file) => __awaiter(this, void 0, void 0, function* () {
-            process.stdout.write(`${colorette.green('watch')} ${type} ${colorette.blue(file)}\n`);
-            if (file === config.configFile) {
-                config = yield reloadConfig();
-                hotClients.broadcast(JSON.stringify({ type: 'reload' }));
-                return;
+        debouncedUpdatedBundle();
+    };
+    watcher.on('change', changeHandler.bind(undefined, 'changed'));
+    watcher.on('add', changeHandler.bind(undefined, 'added'));
+    watcher.on('unlink', changeHandler.bind(undefined, 'removed'));
+    watcher.on('ready', () => {
+        process.stdout.write(`\n  👀  Watching ${colorette.blue(api.path)} and all related resources for changes\n\n`);
+    });
+    async function reloadConfig(config) {
+        if (!config) {
+            try {
+                config = (await (0, miscellaneous_1.loadConfigAndHandleErrors)({ configPath: argv.config }));
+            }
+            catch (err) {
+                config = new openapi_core_1.Config({ apis: {}, styleguide: {} });
             }
-            debouncedUpdatedBundle();
-        });
-        watcher.on('change', changeHandler.bind(undefined, 'changed'));
-        watcher.on('add', changeHandler.bind(undefined, 'added'));
-        watcher.on('unlink', changeHandler.bind(undefined, 'removed'));
-        watcher.on('ready', () => {
-            process.stdout.write(`\n  👀  Watching ${colorette.blue(api.path)} and all related resources for changes\n\n`);
-        });
-        function reloadConfig(config) {
-            var _a;
-            return __awaiter(this, void 0, void 0, function* () {
-                if (!config) {
-                    try {
-                        config = (yield (0, miscellaneous_1.loadConfigAndHandleErrors)({ configPath: argv.config }));
-                    }
-                    catch (err) {
-                        config = new openapi_core_1.Config({ apis: {}, styleguide: {} });
-                    }
-                }
-                const redoclyClient = new openapi_core_1.RedoclyClient();
-                isAuthorizedWithRedocly = yield redoclyClient.isAuthorizedWithRedocly();
-                const resolvedConfig = (0, openapi_core_1.getMergedConfig)(config, argv.api);
-                const { styleguide } = resolvedConfig;
-                styleguide.skipPreprocessors(argv['skip-preprocessor']);
-                styleguide.skipDecorators(argv['skip-decorator']);
-                const referenceDocs = (_a = resolvedConfig.theme) === null || _a === void 0 ? void 0 : _a.openapi;
-                redocOptions = Object.assign(Object.assign({}, referenceDocs), { useCommunityEdition: argv['use-community-edition'] || (referenceDocs === null || referenceDocs === void 0 ? void 0 : referenceDocs.useCommunityEdition), licenseKey: process.env.REDOCLY_LICENSE_KEY || (referenceDocs === null || referenceDocs === void 0 ? void 0 : referenceDocs.licenseKey), whiteLabel: true });
-                return resolvedConfig;
-            });
         }
-    });
+        const redoclyClient = new openapi_core_1.RedoclyClient();
+        isAuthorizedWithRedocly = await redoclyClient.isAuthorizedWithRedocly();
+        const resolvedConfig = (0, openapi_core_1.getMergedConfig)(config, argv.api);
+        const { styleguide } = resolvedConfig;
+        styleguide.skipPreprocessors(argv['skip-preprocessor']);
+        styleguide.skipDecorators(argv['skip-decorator']);
+        const referenceDocs = resolvedConfig.theme?.openapi;
+        redocOptions = {
+            ...referenceDocs,
+            useCommunityEdition: argv['use-community-edition'] || referenceDocs?.useCommunityEdition,
+            licenseKey: process.env.REDOCLY_LICENSE_KEY || referenceDocs?.licenseKey,
+            whiteLabel: true,
+        };
+        return resolvedConfig;
+    }
 }
-exports.previewDocs = previewDocs;
 function debounce(func, wait, immediate) {
     let timeout;
     return function executedFunction(...args) {
@@ -137,4 +124,3 @@ function debounce(func, wait, immediate) {
             func.apply(context, args);
     };
 }
-exports.debounce = debounce;