@redocly/cli 1.0.0-beta.99 → 1.0.0-rc.2

package/lib/fetch-with-timeout.js

@@ -0,0 +1,30 @@
+"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 });
+const node_fetch_1 = require("node-fetch");
+const TIMEOUT = 3000;
+exports.default = (url, options = {}) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        if (!global.AbortController) {
+            return node_fetch_1.default(url, options);
+        }
+        const controller = new AbortController();
+        const timeout = setTimeout(() => {
+            controller.abort();
+        }, TIMEOUT);
+        const res = yield node_fetch_1.default(url, Object.assign({ signal: controller.signal }, options));
+        clearTimeout(timeout);
+        return res;
+    }
+    catch (e) {
+        return;
+    }
+});

package/lib/index.js

@@ -22,20 +22,28 @@ const push_1 = require("./commands/push");
 const lint_1 = require("./commands/lint");
 const bundle_1 = require("./commands/bundle");
 const login_1 = require("./commands/login");
-const version = require('../package.json').version;
+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");
+update_version_notifier_1.cacheLatestVersion();
 yargs
-    .version('version', 'Show version number.', version)
+    .version('version', 'Show version number.', update_version_notifier_2.version)
     .help('help', 'Show help.')
-    .command('stats [entrypoint]', 'Gathering statistics for a document.', (yargs) => yargs.positional('entrypoint', { type: 'string' }).option({
-    config: { description: 'Specify path to the config file.', type: 'string' },
+    .parserConfiguration({ 'greedy-arrays': false, 'camel-case-expansion': false })
+    .command('stats [api]', 'Show statistics for an API description.', (yargs) => yargs.positional('api', { type: 'string' }).option({
+    config: { description: 'Path to the config file.', type: 'string' },
     format: {
         description: 'Use a specific output format.',
         choices: ['stylish', 'json'],
         default: 'stylish',
     },
-}), stats_1.handleStats)
-    .command('split [entrypoint]', 'Split definition into a multi-file structure.', (yargs) => yargs
-    .positional('entrypoint', {
+}), (argv) => {
+    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
+    .positional('api', {
     description: 'API definition file that you want to split',
     type: 'string',
 })
@@ -51,16 +59,26 @@ yargs
         type: 'string',
         default: '_',
     },
+    config: {
+        description: 'Path to the config file.',
+        requiresArg: true,
+        type: 'string',
+    },
 })
-    .demandOption('entrypoint'), split_1.handleSplit)
-    .command('join [entrypoints...]', 'Join definitions [experimental].', (yargs) => yargs
-    .positional('entrypoints', {
+    .demandOption('api'), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'split';
+    wrapper_1.commandWrapper(split_1.handleSplit)(argv);
+})
+    .command('join [apis...]', 'Join definitions [experimental].', (yargs) => yargs
+    .positional('apis', {
     array: true,
     type: 'string',
     demandOption: true,
 })
     .option({
     lint: { description: 'Lint definitions', type: 'boolean', default: false },
+    decorate: { description: 'Run decorators', type: 'boolean', default: false },
+    preprocess: { description: 'Run preprocessors', type: 'boolean', default: false },
     'prefix-tags-with-info-prop': {
         description: 'Prefix tags with property value from info object.',
         requiresArg: true,
@@ -76,29 +94,94 @@ yargs
         requiresArg: true,
         type: 'string',
     },
+    'without-x-tag-groups': {
+        description: 'Skip automated x-tagGroups creation',
+        type: 'boolean',
+    },
+    output: {
+        describe: 'Output file',
+        alias: 'o',
+        type: 'string',
+        default: 'openapi.yaml',
+    },
+    config: {
+        description: 'Path to the config file.',
+        requiresArg: true,
+        type: 'string',
+    },
 }), (argv) => {
-    join_1.handleJoin(argv, version);
+    process.env.REDOCLY_CLI_COMMAND = 'join';
+    wrapper_1.commandWrapper(join_1.handleJoin)(argv);
 })
-    .command('push [maybeEntrypointOrAliasOrDestination] [maybeDestination] [maybeBranchName]', 'Push an API definition to the Redocly API registry.', (yargs) => yargs
-    .positional('maybeEntrypointOrAliasOrDestination', { type: 'string' })
+    .command('push [api] [maybeDestination] [maybeBranchName]', 'Push an API definition to the Redocly API registry.', (yargs) => yargs
+    .usage('push [api]')
+    .positional('api', { type: 'string' })
     .positional('maybeDestination', { type: 'string' })
-    .positional('maybeBranchName', { type: 'string' })
+    .hide('maybeDestination')
+    .hide('maybeBranchName')
     .option({
-    branch: { type: 'string', alias: 'b' },
-    upsert: { type: 'boolean', alias: 'u' },
-    'run-id': { type: 'string', requiresArg: true },
+    organization: {
+        description: 'Name of the organization to push to.',
+        type: 'string',
+        alias: 'o',
+    },
+    destination: {
+        description: 'API name and version in the format `name@version`.',
+        type: 'string',
+        alias: 'd',
+    },
+    branch: {
+        description: 'Branch name to push to.',
+        type: 'string',
+        alias: 'b',
+    },
+    upsert: {
+        description: "Create the specified API version if it doesn't exist, update if it does exist.",
+        type: 'boolean',
+        alias: 'u',
+    },
+    'batch-id': {
+        description: 'Specifies the ID of the CI job that the current push will be associated with.',
+        type: 'string',
+        requiresArg: true,
+        deprecated: true,
+        hidden: true,
+    },
+    'job-id': {
+        description: 'ID of the CI job that the current push will be associated with.',
+        type: 'string',
+        requiresArg: true,
+    },
+    'batch-size': {
+        description: 'Number of CI pushes to expect in a batch.',
+        type: 'number',
+        requiresArg: true,
+    },
     region: { description: 'Specify a region.', alias: 'r', choices: types_1.regionChoices },
     'skip-decorator': {
         description: 'Ignore certain decorators.',
         array: true,
         type: 'string',
     },
-    'public': {
-        description: 'Make API registry available to the public',
+    public: {
+        description: 'Make the API definition available to the public',
         type: 'boolean',
     },
-}), push_1.transformPush(push_1.handlePush))
-    .command('lint [entrypoints...]', 'Lint definition.', (yargs) => yargs.positional('entrypoints', { array: true, type: 'string', demandOption: true }).option({
+    files: {
+        description: 'List of other folders and files to upload',
+        array: true,
+        type: 'string',
+    },
+})
+    .deprecateOption('batch-id', 'use --job-id')
+    .deprecateOption('maybeDestination')
+    .implies('job-id', 'batch-size')
+    .implies('batch-id', 'batch-size')
+    .implies('batch-size', 'job-id'), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'push';
+    wrapper_1.commandWrapper(push_1.transformPush(push_1.handlePush))(argv);
+})
+    .command('lint [apis...]', 'Lint definition.', (yargs) => yargs.positional('apis', { array: true, type: 'string', demandOption: true }).option({
     format: {
         description: 'Use a specific output format.',
         choices: [
@@ -107,17 +190,18 @@ yargs
             'json',
             'checkstyle',
             'codeclimate',
+            'summary',
         ],
         default: 'codeframe',
     },
     'max-problems': {
         requiresArg: true,
-        description: 'Reduce output to max N problems.',
+        description: 'Reduce output to a maximum of N problems.',
         type: 'number',
         default: 100,
     },
     'generate-ignore-file': {
-        description: 'Generate ignore file.',
+        description: 'Generate an ignore file.',
         type: 'boolean',
     },
     'skip-rule': {
@@ -130,8 +214,13 @@ yargs
         array: true,
         type: 'string',
     },
+    'lint-config': {
+        description: 'Severity level for config file linting.',
+        choices: ['warn', 'error', 'off'],
+        default: 'warn',
+    },
     config: {
-        description: 'Specify path to the config file.',
+        description: 'Path to the config file.',
         requiresArg: true,
         type: 'string',
     },
@@ -142,9 +231,10 @@ yargs
         type: 'string',
     },
 }), (argv) => {
-    lint_1.handleLint(argv, version);
+    process.env.REDOCLY_CLI_COMMAND = 'lint';
+    wrapper_1.commandWrapper(lint_1.handleLint)(argv);
 })
-    .command('bundle [entrypoints...]', 'Bundle definition.', (yargs) => yargs.positional('entrypoints', { array: true, type: 'string', demandOption: true }).options({
+    .command('bundle [apis...]', 'Bundle definition.', (yargs) => yargs.positional('apis', { array: true, type: 'string', demandOption: true }).options({
     output: { type: 'string', alias: 'o' },
     format: {
         description: 'Use a specific output format.',
@@ -153,7 +243,7 @@ yargs
     },
     'max-problems': {
         requiresArg: true,
-        description: 'Reduce output to max N problems.',
+        description: 'Reduce output to a maximum of N problems.',
         type: 'number',
         default: 100,
     },
@@ -180,7 +270,7 @@ yargs
     dereferenced: {
         alias: 'd',
         type: 'boolean',
-        description: 'Produce fully dereferenced bundle.',
+        description: 'Produce a fully dereferenced bundle.',
     },
     force: {
         alias: 'f',
@@ -188,11 +278,11 @@ yargs
         description: 'Produce bundle output even when errors occur.',
     },
     config: {
-        description: 'Specify path to the config file.',
+        description: 'Path to the config file.',
         type: 'string',
     },
     lint: {
-        description: 'Lint definitions',
+        description: 'Lint API definitions',
         type: 'boolean',
         default: false,
     },
@@ -211,8 +301,14 @@ yargs
         type: 'boolean',
         default: false,
     },
+    'keep-url-references': {
+        description: 'Keep absolute url references.',
+        type: 'boolean',
+        alias: 'k',
+    },
 }), (argv) => {
-    bundle_1.handleBundle(argv, version);
+    process.env.REDOCLY_CLI_COMMAND = 'bundle';
+    wrapper_1.commandWrapper(bundle_1.handleBundle)(argv);
 })
     .command('login', 'Login to the Redocly API registry with an access token.', (yargs) => __awaiter(void 0, void 0, void 0, function* () {
     return yargs.options({
@@ -225,14 +321,25 @@ yargs
             alias: 'r',
             choices: types_1.regionChoices,
         },
+        config: {
+            description: 'Path to the config file.',
+            requiresArg: true,
+            type: 'string',
+        },
     });
-}), login_1.handleLogin)
-    .command('logout', 'Clear your stored credentials for the Redocly API registry.', (yargs) => yargs, () => __awaiter(void 0, void 0, void 0, function* () {
-    const client = new openapi_core_1.RedoclyClient();
-    client.logout();
-    process.stdout.write('Logged out from the Redocly account. ✋\n');
+}), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'login';
+    wrapper_1.commandWrapper(login_1.handleLogin)(argv);
+})
+    .command('logout', 'Clear your stored credentials for the Redocly API registry.', (yargs) => yargs, (argv) => __awaiter(void 0, void 0, void 0, function* () {
+    process.env.REDOCLY_CLI_COMMAND = 'logout';
+    yield wrapper_1.commandWrapper(() => __awaiter(void 0, void 0, void 0, function* () {
+        const client = new openapi_core_1.RedoclyClient();
+        client.logout();
+        process.stdout.write('Logged out from the Redocly account. ✋\n');
+    }))(argv);
 }))
-    .command('preview-docs [entrypoint]', 'Preview API reference docs for the specified definition.', (yargs) => yargs.positional('entrypoint', { type: 'string' }).options({
+    .command('preview-docs [api]', 'Preview API reference docs for the specified definition.', (yargs) => yargs.positional('api', { type: 'string' }).options({
     port: {
         alias: 'p',
         type: 'number',
@@ -256,7 +363,7 @@ yargs
         type: 'string',
     },
     'use-community-edition': {
-        description: 'Force using Redoc CE for docs preview.',
+        description: 'Use Redoc CE for documentation preview.',
         type: 'boolean',
     },
     force: {
@@ -265,10 +372,57 @@ yargs
         description: 'Produce bundle output even when errors occur.',
     },
     config: {
-        description: 'Specify path to the config file.',
+        description: 'Path to the config file.',
         type: 'string',
     },
-}), preview_docs_1.previewDocs)
+}), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'preview-docs';
+    wrapper_1.commandWrapper(preview_docs_1.previewDocs)(argv);
+})
+    .command('build-docs [api]', 'Produce API documentation as an HTML file', (yargs) => yargs
+    .positional('api', { type: 'string' })
+    .options({
+    o: {
+        describe: 'Output destination file.',
+        alias: 'output',
+        type: 'string',
+        default: 'redoc-static.html',
+    },
+    title: {
+        describe: 'Page title.',
+        type: 'string',
+    },
+    disableGoogleFont: {
+        describe: 'Disable Google fonts.',
+        type: 'boolean',
+        default: false,
+    },
+    t: {
+        alias: 'template',
+        describe: 'Path to handlebars page template, see https://git.io/vh8fP for the example.',
+        type: 'string',
+    },
+    templateOptions: {
+        describe: 'Additional options to pass to the template. Use dot notation, e.g. templateOptions.metaDescription',
+    },
+    theme: {
+        describe: 'Redoc theme.openapi configuration. Use dot notation, e.g. theme.openapi.nativeScrollbars',
+    },
+    config: {
+        describe: 'Path to the config file.',
+        type: 'string',
+    },
+})
+    .check((argv) => {
+    var _a;
+    if (argv.theme && !((_a = argv.theme) === null || _a === void 0 ? void 0 : _a.openapi))
+        throw Error('Invalid option: theme.openapi not set');
+    return true;
+}), (argv) => __awaiter(void 0, void 0, void 0, function* () {
+    process.env.REDOCLY_CLI_COMMAND = 'build-docs';
+    wrapper_1.commandWrapper(build_docs_1.handlerBuildCommand)(argv);
+}))
     .completion('completion', 'Generate completion script.')
     .demandCommand(1)
+    .middleware([update_version_notifier_1.notifyUpdateCliVersion])
     .strict().argv;

package/lib/js-utils.d.ts

@@ -1,3 +1,4 @@
 export declare function isObject(obj: any): boolean;
 export declare function isEmptyObject(obj: any): boolean;
 export declare function isString(str: string): boolean;
+export declare function keysOf<T>(obj: T): (keyof T)[];

package/lib/js-utils.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isString = exports.isEmptyObject = exports.isObject = void 0;
+exports.keysOf = exports.isString = exports.isEmptyObject = exports.isObject = void 0;
 function isObject(obj) {
     const type = typeof obj;
-    return type === 'function' || type === 'object' && !!obj;
+    return type === 'function' || (type === 'object' && !!obj);
 }
 exports.isObject = isObject;
 function isEmptyObject(obj) {
@@ -11,6 +11,12 @@ function isEmptyObject(obj) {
 }
 exports.isEmptyObject = isEmptyObject;
 function isString(str) {
-    return Object.prototype.toString.call(str) === "[object String]";
+    return Object.prototype.toString.call(str) === '[object String]';
 }
 exports.isString = isString;
+function keysOf(obj) {
+    if (!obj)
+        return [];
+    return Object.keys(obj);
+}
+exports.keysOf = keysOf;

package/lib/types.d.ts

@@ -1,4 +1,13 @@
-import { BundleOutputFormat, Region } from '@redocly/openapi-core';
+import type { BundleOutputFormat, Region, Config } from '@redocly/openapi-core';
+import type { LintOptions } from './commands/lint';
+import type { BundleOptions } from './commands/bundle';
+import type { JoinOptions } from './commands/join';
+import type { LoginOptions } from './commands/login';
+import type { PushOptions } from './commands/push';
+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';
 export declare type Totals = {
     errors: number;
     warnings: number;
@@ -11,3 +20,10 @@ export declare type Entrypoint = {
 export declare const outputExtensions: readonly BundleOutputFormat[];
 export declare type OutputExtensions = 'json' | 'yaml' | 'yml' | undefined;
 export declare const regionChoices: readonly Region[];
+export declare type CommandOptions = StatsOptions | SplitOptions | JoinOptions | PushOptions | LintOptions | BundleOptions | LoginOptions | PreviewDocsOptions | BuildDocsArgv;
+export declare type Skips = {
+    'skip-rule'?: string[];
+    'skip-decorator'?: string[];
+    'skip-preprocessor'?: string[];
+};
+export declare type ConfigApis = Pick<Config, 'apis' | 'configFile'>;

package/lib/update-version-notifier.d.ts

@@ -0,0 +1,3 @@
+export declare const version: any, name: any;
+export declare const notifyUpdateCliVersion: () => void;
+export declare const cacheLatestVersion: () => void;

package/lib/update-version-notifier.js

@@ -0,0 +1,105 @@
+"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());
+    });
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cacheLatestVersion = exports.notifyUpdateCliVersion = exports.name = exports.version = void 0;
+const os_1 = require("os");
+const path_1 = require("path");
+const fs_1 = require("fs");
+const semver_1 = require("semver");
+const fetch_with_timeout_1 = require("./fetch-with-timeout");
+const colorette_1 = require("colorette");
+const utils_1 = require("./utils");
+_a = require('../package.json'), exports.version = _a.version, exports.name = _a.name;
+const VERSION_CACHE_FILE = 'redocly-cli-version';
+const SPACE_TO_BORDER = 4;
+const INTERVAL_TO_CHECK = 1000 * 60 * 60 * 12;
+const SHOULD_NOT_NOTIFY = process.env.NODE_ENV === 'test' || process.env.CI || !!process.env.LAMBDA_TASK_ROOT;
+const notifyUpdateCliVersion = () => {
+    if (SHOULD_NOT_NOTIFY) {
+        return;
+    }
+    try {
+        const latestVersion = fs_1.readFileSync(path_1.join(os_1.tmpdir(), VERSION_CACHE_FILE)).toString();
+        if (isNewVersionAvailable(exports.version, latestVersion)) {
+            renderUpdateBanner(exports.version, latestVersion);
+        }
+    }
+    catch (e) {
+        return;
+    }
+};
+exports.notifyUpdateCliVersion = notifyUpdateCliVersion;
+const isNewVersionAvailable = (current, latest) => semver_1.compare(current, latest) < 0;
+const getLatestVersion = (packageName) => __awaiter(void 0, void 0, void 0, function* () {
+    const latestUrl = `http://registry.npmjs.org/${packageName}/latest`;
+    const response = yield fetch_with_timeout_1.default(latestUrl);
+    if (!response)
+        return;
+    const info = yield response.json();
+    return info.version;
+});
+const cacheLatestVersion = () => {
+    if (!isNeedToBeCached() || SHOULD_NOT_NOTIFY) {
+        return;
+    }
+    getLatestVersion(exports.name)
+        .then((version) => {
+        if (version) {
+            const lastCheckFile = path_1.join(os_1.tmpdir(), VERSION_CACHE_FILE);
+            fs_1.writeFileSync(lastCheckFile, version);
+        }
+    })
+        .catch(() => { });
+};
+exports.cacheLatestVersion = cacheLatestVersion;
+const renderUpdateBanner = (current, latest) => {
+    const messageLines = [
+        `A new version of ${colorette_1.cyan('Redocly CLI')} (${colorette_1.green(latest)}) is available.`,
+        `Update now: \`${colorette_1.cyan('npm i -g @redocly/cli@latest')}\`.`,
+        `Changelog: https://redocly.com/docs/cli/changelog/`,
+    ];
+    const maxLength = Math.max(...messageLines.map((line) => utils_1.cleanColors(line).length));
+    const border = colorette_1.yellow('═'.repeat(maxLength + SPACE_TO_BORDER));
+    const banner = `
+    ${colorette_1.yellow('╔' + border + '╗')}
+    ${colorette_1.yellow('║' + ' '.repeat(maxLength + SPACE_TO_BORDER) + '║')}
+    ${messageLines
+        .map((line, index) => {
+        return getLineWithPadding(maxLength, line, index);
+    })
+        .join('\n')}
+    ${colorette_1.yellow('║' + ' '.repeat(maxLength + SPACE_TO_BORDER) + '║')}
+    ${colorette_1.yellow('╚' + border + '╝')}
+  `;
+    process.stderr.write(banner);
+};
+const getLineWithPadding = (maxLength, line, index) => {
+    const padding = ' '.repeat(maxLength - utils_1.cleanColors(line).length);
+    const extraSpaces = index !== 0 ? ' '.repeat(SPACE_TO_BORDER) : '';
+    return `${extraSpaces}${colorette_1.yellow('║')}  ${line}${padding}  ${colorette_1.yellow('║')}`;
+};
+const isNeedToBeCached = () => {
+    try {
+        // Last version from npm is stored in a file in the OS temp folder
+        const versionFile = path_1.join(os_1.tmpdir(), VERSION_CACHE_FILE);
+        if (!fs_1.existsSync(versionFile)) {
+            return true;
+        }
+        const now = new Date().getTime();
+        const stats = fs_1.statSync(versionFile);
+        const lastCheck = stats.mtime.getTime();
+        return now - lastCheck >= INTERVAL_TO_CHECK;
+    }
+    catch (e) {
+        return false;
+    }
+};

package/lib/utils.d.ts

@@ -1,10 +1,12 @@
-import { BundleOutputFormat, Config, LintConfig } from '@redocly/openapi-core';
-import { Totals, Entrypoint } from './types';
-export declare function getFallbackEntryPointsOrExit(argsEntrypoints: string[] | undefined, config: Config): Promise<Entrypoint[]>;
+import { BundleOutputFormat, StyleguideConfig, RawConfig, Region, Config, Oas3Definition, Oas2Definition } from '@redocly/openapi-core';
+import { Totals, Entrypoint, ConfigApis, CommandOptions } from './types';
+import { Arguments } from 'yargs';
+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, entrypoint: string): void;
+export declare function printExecutionTime(commandName: string, startedAt: number, api: string): void;
 export declare function pathToFilename(path: string, pathSeparator: string): string;
 export declare function escapeLanguageName(lang: string): string;
+export declare function langToExt(lang: string): any;
 export declare class CircularJSONNotSupportedError extends Error {
     originalError: Error;
     constructor(originalError: Error);
@@ -16,14 +18,45 @@ export declare function readYaml(filename: string): unknown;
 export declare function writeYaml(data: any, filename: string, noRefs?: boolean): void;
 export declare function pluralize(label: string, num: number): string;
 export declare function handleError(e: Error, ref: string): void;
+export declare class HandledError extends Error {
+}
 export declare function printLintTotals(totals: Totals, definitionsCount: number): void;
+export declare function printConfigLintTotals(totals: Totals): void;
 export declare function getOutputFileName(entrypoint: string, entries: number, output?: string, ext?: BundleOutputFormat): {
     outputFile: string;
     ext: BundleOutputFormat;
 };
-export declare function printUnusedWarnings(config: LintConfig): void;
+export declare function printUnusedWarnings(config: StyleguideConfig): void;
 export declare function exitWithError(message: string): void;
 /**
  * Checks if dir is subdir of parent
  */
 export declare function isSubdir(parent: string, dir: string): boolean;
+export declare function loadConfigAndHandleErrors(options?: {
+    configPath?: string;
+    customExtends?: string[];
+    processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>;
+    files?: string[];
+    region?: Region;
+}): Promise<Config | void>;
+export declare function sortTopLevelKeysForOas(document: Oas3Definition | Oas2Definition): Oas3Definition | Oas2Definition;
+export declare function checkIfRulesetExist(rules: typeof StyleguideConfig.prototype.rules): void;
+export declare function cleanColors(input: string): string;
+export declare function sendTelemetry(argv: Arguments | undefined, exit_code: ExitCode, has_config: boolean | undefined): Promise<void>;
+export declare type ExitCode = 0 | 1 | 2;
+export declare type Analytics = {
+    event: string;
+    event_time: string;
+    logged_in: boolean;
+    command: string | number;
+    arguments: Record<string, unknown>;
+    node_version: string;
+    version: string;
+    exit_code: ExitCode;
+    environment?: string;
+    environment_ci?: string;
+    raw_input: string;
+    has_config?: boolean;
+};
+export declare function cleanArgs(args: CommandOptions): Record<string, unknown>;
+export declare function cleanRawInput(argv: string[]): string;