@redocly/cli 1.0.0-beta.103 → 1.0.0-beta.106

package/lib/commands/push.js

@@ -20,7 +20,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getApiEntrypoint = exports.transformPush = exports.getDestinationProps = exports.handlePush = void 0;
+exports.getApiRoot = exports.transformPush = exports.getDestinationProps = exports.handlePush = void 0;
 const fs = require("fs");
 const path = require("path");
 const node_fetch_1 = require("node-fetch");
@@ -53,9 +53,9 @@ function handlePush(argv) {
         if (!organizationId) {
             return utils_1.exitWithError(`No organization provided, please use the right format: ${colorette_1.yellow('<@organization-id/api-name@api-version>')} or specify the 'organization' field in the config file.`);
         }
-        const entrypoint = argv.entrypoint || (name && version && getApiEntrypoint({ name, version, config }));
-        if (name && version && !entrypoint) {
-            utils_1.exitWithError(`No entrypoint found that matches ${colorette_1.blue(`${name}@${version}`)}. Please make sure you have provided the correct data in the config file.`);
+        const api = argv.api || (name && version && getApiRoot({ name, version, config }));
+        if (name && version && !api) {
+            utils_1.exitWithError(`No api found that matches ${colorette_1.blue(`${name}@${version}`)}. Please make sure you have provided the correct data in the config file.`);
         }
         if (batchId && !batchId.trim()) {
             utils_1.exitWithError(`The ${colorette_1.blue(`batch-id`)} option value is not valid, please avoid using an empty string.`);
@@ -63,15 +63,15 @@ function handlePush(argv) {
         if (batchSize && batchSize < 2) {
             utils_1.exitWithError(`The ${colorette_1.blue(`batch-size`)} option value is not valid, please use the integer bigger than 1.`);
         }
-        const apis = entrypoint ? { [`${name}@${version}`]: { root: entrypoint } } : config.apis;
-        for (const [apiNameAndVersion, { root: entrypoint }] of Object.entries(apis)) {
+        const apis = api ? { [`${name}@${version}`]: { root: api } } : config.apis;
+        for (const [apiNameAndVersion, { root: api }] of Object.entries(apis)) {
             const resolvedConfig = openapi_core_1.getMergedConfig(config, apiNameAndVersion);
-            resolvedConfig.lint.skipDecorators(argv['skip-decorator']);
+            resolvedConfig.styleguide.skipDecorators(argv['skip-decorator']);
             const [name, version = DEFAULT_VERSION] = apiNameAndVersion.split('@');
             try {
                 let rootFilePath = '';
                 const filePaths = [];
-                const filesToUpload = yield collectFilesToUpload(entrypoint, resolvedConfig);
+                const filesToUpload = yield collectFilesToUpload(api, resolvedConfig);
                 const filesHash = hashFiles(filesToUpload.files);
                 process.stdout.write(`Uploading ${filesToUpload.files.length} ${utils_1.pluralize('file', filesToUpload.files.length)}:\n`);
                 let uploaded = 0;
@@ -120,9 +120,9 @@ function handlePush(argv) {
                 }
                 throw error;
             }
-            process.stdout.write(`Definition: ${colorette_1.blue(entrypoint)} is successfully pushed to Redocly API Registry \n`);
+            process.stdout.write(`Definition: ${colorette_1.blue(api)} is successfully pushed to Redocly API Registry \n`);
         }
-        utils_1.printExecutionTime('push', startedAt, entrypoint || `apis in organization ${organizationId}`);
+        utils_1.printExecutionTime('push', startedAt, api || `apis in organization ${organizationId}`);
     });
 }
 exports.handlePush = handlePush;
@@ -140,25 +140,25 @@ function getFilesList(dir, files) {
     }
     return files;
 }
-function collectFilesToUpload(entrypoint, config) {
+function collectFilesToUpload(api, config) {
     return __awaiter(this, void 0, void 0, function* () {
         let files = [];
-        const [{ path: entrypointPath }] = yield utils_1.getFallbackEntryPointsOrExit([entrypoint], config);
+        const [{ path: apiPath }] = yield utils_1.getFallbackApisOrExit([api], config);
         process.stdout.write('Bundling definition\n');
         const { bundle: openapiBundle, problems } = yield openapi_core_1.bundle({
             config,
-            ref: entrypointPath,
+            ref: apiPath,
             skipRedoclyRegistryRefs: true,
         });
         const fileTotals = openapi_core_1.getTotals(problems);
         if (fileTotals.errors === 0) {
-            process.stdout.write(`Created a bundle for ${colorette_1.blue(entrypoint)} ${fileTotals.warnings > 0 ? 'with warnings' : ''}\n`);
+            process.stdout.write(`Created a bundle for ${colorette_1.blue(api)} ${fileTotals.warnings > 0 ? 'with warnings' : ''}\n`);
         }
         else {
-            utils_1.exitWithError(`Failed to create a bundle for ${colorette_1.blue(entrypoint)}\n`);
+            utils_1.exitWithError(`Failed to create a bundle for ${colorette_1.blue(api)}\n`);
         }
-        const fileExt = path.extname(entrypointPath).split('.').pop();
-        files.push(getFileEntry(entrypointPath, utils_1.dumpBundle(openapiBundle.parsed, fileExt)));
+        const fileExt = path.extname(apiPath).split('.').pop();
+        files.push(getFileEntry(apiPath, utils_1.dumpBundle(openapiBundle.parsed, fileExt)));
         if (fs.existsSync('package.json')) {
             files.push(getFileEntry('package.json'));
         }
@@ -167,14 +167,14 @@ function collectFilesToUpload(entrypoint, config) {
         }
         if (config.configFile) {
             // All config file paths including the root one
-            files.push(...[...new Set(config.lint.extendPaths)].map((f) => getFileEntry(f)));
+            files.push(...[...new Set(config.styleguide.extendPaths)].map((f) => getFileEntry(f)));
             if (config['features.openapi'].htmlTemplate) {
                 const dir = getFolder(config['features.openapi'].htmlTemplate);
                 const fileList = getFilesList(dir, []);
                 files.push(...fileList.map((f) => getFileEntry(f)));
             }
             let pluginFiles = new Set();
-            for (const plugin of config.lint.pluginPaths) {
+            for (const plugin of config.styleguide.pluginPaths) {
                 if (typeof plugin !== 'string')
                     continue;
                 const fileList = getFilesList(getFolder(plugin), []);
@@ -184,7 +184,7 @@ function collectFilesToUpload(entrypoint, config) {
         }
         return {
             files,
-            root: path.resolve(entrypointPath),
+            root: path.resolve(apiPath),
         };
         function filterPluginFilesByExt(files) {
             return files.filter((file) => {
@@ -228,21 +228,21 @@ function getDestinationProps(destination, organization) {
 }
 exports.getDestinationProps = getDestinationProps;
 const transformPush = (callback) => (_a) => {
-    var { maybeEntrypointOrAliasOrDestination, maybeDestination, maybeBranchName, branch } = _a, rest = __rest(_a, ["maybeEntrypointOrAliasOrDestination", "maybeDestination", "maybeBranchName", "branch"]);
+    var { maybeApiOrDestination, maybeDestination, maybeBranchName, branch } = _a, rest = __rest(_a, ["maybeApiOrDestination", "maybeDestination", "maybeBranchName", "branch"]);
     if (!!maybeBranchName) {
         process.stderr.write(colorette_1.yellow('Deprecation warning: Do not use the third parameter as a branch name. Please use a separate --branch option instead.'));
     }
-    const entrypoint = maybeDestination ? maybeEntrypointOrAliasOrDestination : undefined;
-    const destination = maybeDestination || maybeEntrypointOrAliasOrDestination;
+    const api = maybeDestination ? maybeApiOrDestination : undefined;
+    const destination = maybeDestination || maybeApiOrDestination;
     return callback(Object.assign(Object.assign({}, rest), { destination,
-        entrypoint, branchName: branch !== null && branch !== void 0 ? branch : maybeBranchName }));
+        api, branchName: branch !== null && branch !== void 0 ? branch : maybeBranchName }));
 };
 exports.transformPush = transformPush;
-function getApiEntrypoint({ name, version, config: { apis }, }) {
+function getApiRoot({ name, version, config: { apis }, }) {
     const api = (apis === null || apis === void 0 ? void 0 : apis[`${name}@${version}`]) || (version === DEFAULT_VERSION && (apis === null || apis === void 0 ? void 0 : apis[name]));
     return api === null || api === void 0 ? void 0 : api.root;
 }
-exports.getApiEntrypoint = getApiEntrypoint;
+exports.getApiRoot = getApiRoot;
 function uploadFileToS3(url, filePathOrBuffer) {
     const fileSizeInBytes = typeof filePathOrBuffer === 'string'
         ? fs.statSync(filePathOrBuffer).size

package/lib/commands/split/__tests__/index.test.js

@@ -20,10 +20,10 @@ describe('#split', () => {
     const openapiDir = 'test';
     const componentsFiles = {};
     it('should split the file and show the success message', () => __awaiter(void 0, void 0, void 0, function* () {
-        const filePath = "packages/cli/src/commands/split/__tests__/fixtures/spec.json";
+        const filePath = 'packages/cli/src/commands/split/__tests__/fixtures/spec.json';
         jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
         yield index_1.handleSplit({
-            entrypoint: filePath,
+            api: filePath,
             outDir: openapiDir,
             separator: '_',
         });
@@ -33,10 +33,10 @@ describe('#split', () => {
         expect(process.stderr.write.mock.calls[1][0]).toContain(`${filePath}: split processed in <test>ms`);
     }));
     it('should use the correct separator', () => __awaiter(void 0, void 0, void 0, function* () {
-        const filePath = "packages/cli/src/commands/split/__tests__/fixtures/spec.json";
+        const filePath = 'packages/cli/src/commands/split/__tests__/fixtures/spec.json';
         jest.spyOn(utils, 'pathToFilename').mockImplementation(() => 'newFilePath');
         yield index_1.handleSplit({
-            entrypoint: filePath,
+            api: filePath,
             outDir: openapiDir,
             separator: '_',
         });
@@ -44,7 +44,7 @@ describe('#split', () => {
         utils.pathToFilename.mockRestore();
     }));
     it('should have correct path with paths', () => {
-        const openapi = require("./fixtures/spec.json");
+        const openapi = require('./fixtures/spec.json');
         jest.spyOn(openapiCore, 'slash').mockImplementation(() => 'paths/test.yaml');
         jest.spyOn(path, 'relative').mockImplementation(() => 'paths/test.yaml');
         index_1.iteratePathItems(openapi.paths, openapiDir, path.join(openapiDir, 'paths'), componentsFiles, '_');
@@ -52,7 +52,7 @@ describe('#split', () => {
         expect(path.relative).toHaveBeenCalledWith('test', 'test/paths/test.yaml');
     });
     it('should have correct path with webhooks', () => {
-        const openapi = require("./fixtures/webhooks.json");
+        const openapi = require('./fixtures/webhooks.json');
         jest.spyOn(openapiCore, 'slash').mockImplementation(() => 'webhooks/test.yaml');
         jest.spyOn(path, 'relative').mockImplementation(() => 'webhooks/test.yaml');
         index_1.iteratePathItems(openapi.webhooks, openapiDir, path.join(openapiDir, 'webhooks'), componentsFiles, 'webhook_');
@@ -60,7 +60,7 @@ describe('#split', () => {
         expect(path.relative).toHaveBeenCalledWith('test', 'test/webhooks/test.yaml');
     });
     it('should have correct path with x-webhooks', () => {
-        const openapi = require("./fixtures/spec.json");
+        const openapi = require('./fixtures/spec.json');
         jest.spyOn(openapiCore, 'slash').mockImplementation(() => 'webhooks/test.yaml');
         jest.spyOn(path, 'relative').mockImplementation(() => 'webhooks/test.yaml');
         index_1.iteratePathItems(openapi['x-webhooks'], openapiDir, path.join(openapiDir, 'webhooks'), componentsFiles, 'webhook_');
@@ -68,7 +68,7 @@ describe('#split', () => {
         expect(path.relative).toHaveBeenCalledWith('test', 'test/webhooks/test.yaml');
     });
     it('should create correct folder name for code samples', () => __awaiter(void 0, void 0, void 0, function* () {
-        const openapi = require("./fixtures/samples.json");
+        const openapi = require('./fixtures/samples.json');
         const fs = require('fs');
         jest.spyOn(fs, 'writeFileSync').mockImplementation(() => { });
         jest.spyOn(utils, 'escapeLanguageName');

package/lib/commands/split/index.d.ts

@@ -1,6 +1,6 @@
 import { Oas3PathItem, Referenced } from './types';
 export declare function handleSplit(argv: {
-    entrypoint: string;
+    api: string;
     outDir: string;
     separator: string;
 }): Promise<void>;

package/lib/commands/split/index.js

@@ -22,13 +22,13 @@ const types_1 = require("./types");
 function handleSplit(argv) {
     return __awaiter(this, void 0, void 0, function* () {
         const startedAt = perf_hooks_1.performance.now();
-        const { entrypoint, outDir, separator } = argv;
-        validateDefinitionFileName(entrypoint);
-        const openapi = utils_1.readYaml(entrypoint);
+        const { api, outDir, separator } = argv;
+        validateDefinitionFileName(api);
+        const openapi = utils_1.readYaml(api);
         splitDefinition(openapi, outDir, separator);
-        process.stderr.write(`🪓 Document: ${colorette_1.blue(entrypoint)} ${colorette_1.green('is successfully split')}
+        process.stderr.write(`🪓 Document: ${colorette_1.blue(api)} ${colorette_1.green('is successfully split')}
     and all related files are saved to the directory: ${colorette_1.blue(outDir)} \n`);
-        utils_1.printExecutionTime('split', startedAt, entrypoint);
+        utils_1.printExecutionTime('split', startedAt, api);
     });
 }
 exports.handleSplit = handleSplit;
@@ -76,7 +76,7 @@ function langToExt(lang) {
         bash: '.sh',
         javascript: '.js',
         js: '.js',
-        python: '.py'
+        python: '.py',
     };
     return langObj[lang];
 }
@@ -169,8 +169,7 @@ function isNotSecurityComponentType(componentType) {
     return componentType !== types_1.OPENAPI3_COMPONENT.SecuritySchemes;
 }
 function findComponentTypes(components) {
-    return types_1.OPENAPI3_COMPONENT_NAMES
-        .filter(item => isNotSecurityComponentType(item) && Object.keys(components).includes(item));
+    return types_1.OPENAPI3_COMPONENT_NAMES.filter((item) => isNotSecurityComponentType(item) && Object.keys(components).includes(item));
 }
 function doesFileDiffer(filename, componentData) {
     return fs.existsSync(filename) && !isEqual(utils_1.readYaml(filename), componentData);
@@ -198,7 +197,9 @@ function gatherComponentsFiles(components, componentsFiles, componentType, compo
     var _a, _b;
     let inherits = [];
     if (componentType === types_1.OPENAPI3_COMPONENT.Schemas) {
-        inherits = (((_b = (_a = components === null || components === void 0 ? void 0 : components[componentType]) === null || _a === void 0 ? void 0 : _a[componentName]) === null || _b === void 0 ? void 0 : _b.allOf) || []).map((s) => s.$ref).filter(Boolean);
+        inherits = (((_b = (_a = components === null || components === void 0 ? void 0 : components[componentType]) === null || _a === void 0 ? void 0 : _a[componentName]) === null || _b === void 0 ? void 0 : _b.allOf) || [])
+            .map((s) => s.$ref)
+            .filter(Boolean);
     }
     componentsFiles[componentType] = componentsFiles[componentType] || {};
     componentsFiles[componentType][componentName] = { inherits, filename };
@@ -226,13 +227,13 @@ function iteratePathItems(pathItems, openapiDir, outDir, componentsFiles, pathSe
                 fs.writeFileSync(sampleFileName, sample.source);
                 // @ts-ignore
                 sample.source = {
-                    $ref: openapi_core_1.slash(path.relative(outDir, sampleFileName))
+                    $ref: openapi_core_1.slash(path.relative(outDir, sampleFileName)),
                 };
             }
         }
         utils_1.writeYaml(pathData, pathFile);
         pathItems[pathName] = {
-            $ref: openapi_core_1.slash(path.relative(openapiDir, pathFile))
+            $ref: openapi_core_1.slash(path.relative(openapiDir, pathFile)),
         };
         traverseDirectoryDeep(outDir, traverseDirectoryDeepCallback, componentsFiles);
     }

package/lib/commands/split/types.d.ts

@@ -1,5 +1,5 @@
-import { Oas3Schema, Oas3_1Schema, Oas3Definition, Oas3_1Definition, Oas3Components, Oas3PathItem, Oas3Paths, Oas3ComponentName, Oas3_1Webhooks, Oas2Definition, Referenced } from "@redocly/openapi-core";
-export { Oas3_1Definition, Oas3Definition, Oas2Definition, Oas3Components, Oas3Paths, Oas3PathItem, Oas3ComponentName, Oas3_1Schema, Oas3Schema, Oas3_1Webhooks, Referenced };
+import { Oas3Schema, Oas3_1Schema, Oas3Definition, Oas3_1Definition, Oas3Components, Oas3PathItem, Oas3Paths, Oas3ComponentName, Oas3_1Webhooks, Oas2Definition, Referenced } from '@redocly/openapi-core';
+export { Oas3_1Definition, Oas3Definition, Oas2Definition, Oas3Components, Oas3Paths, Oas3PathItem, Oas3ComponentName, Oas3_1Schema, Oas3Schema, Oas3_1Webhooks, Referenced, };
 export declare type Definition = Oas3_1Definition | Oas3Definition | Oas2Definition;
 export interface ComponentsFiles {
     [schemas: string]: any;

package/lib/commands/split/types.js

@@ -25,7 +25,7 @@ exports.OPENAPI3_METHOD_NAMES = [
     OPENAPI3_METHOD.Options,
     OPENAPI3_METHOD.Head,
     OPENAPI3_METHOD.Patch,
-    OPENAPI3_METHOD.Trace
+    OPENAPI3_METHOD.Trace,
 ];
 var OPENAPI3_COMPONENT;
 (function (OPENAPI3_COMPONENT) {
@@ -48,5 +48,5 @@ exports.OPENAPI3_COMPONENT_NAMES = [
     OPENAPI3_COMPONENT.Headers,
     OPENAPI3_COMPONENT.Links,
     OPENAPI3_COMPONENT.Callbacks,
-    OPENAPI3_COMPONENT.SecuritySchemes
+    OPENAPI3_COMPONENT.SecuritySchemes,
 ];

package/lib/commands/stats.d.ts

@@ -1,5 +1,5 @@
 export declare function handleStats(argv: {
     config?: string;
-    entrypoint?: string;
+    api?: string;
     format: string;
 }): Promise<void>;

package/lib/commands/stats.js

@@ -41,8 +41,8 @@ function printStatsJson(statsAccumulator) {
     }
     process.stdout.write(JSON.stringify(json, null, 2));
 }
-function printStats(statsAccumulator, entrypoint, format) {
-    process.stderr.write(`Document: ${colors.magenta(entrypoint)} stats:\n\n`);
+function printStats(statsAccumulator, api, format) {
+    process.stderr.write(`Document: ${colors.magenta(api)} stats:\n\n`);
     switch (format) {
         case 'stylish':
             printStatsStylish(statsAccumulator);
@@ -55,10 +55,10 @@ function printStats(statsAccumulator, entrypoint, format) {
 function handleStats(argv) {
     return __awaiter(this, void 0, void 0, function* () {
         const config = yield openapi_core_1.loadConfig(argv.config);
-        const [{ path }] = yield utils_1.getFallbackEntryPointsOrExit(argv.entrypoint ? [argv.entrypoint] : [], config);
+        const [{ path }] = yield utils_1.getFallbackApisOrExit(argv.api ? [argv.api] : [], config);
         const externalRefResolver = new openapi_core_1.BaseResolver(config.resolve);
         const { bundle: document } = yield openapi_core_1.bundle({ config, ref: path });
-        const lintConfig = config.lint;
+        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);
@@ -73,11 +73,13 @@ function handleStats(argv) {
             rootType: types.DefinitionRoot,
             externalRefResolver,
         });
-        const statsVisitor = openapi_core_1.normalizeVisitors([{
+        const statsVisitor = openapi_core_1.normalizeVisitors([
+            {
                 severity: 'warn',
                 ruleId: 'stats',
-                visitor: openapi_core_1.Stats(statsAccumulator)
-            }], types);
+                visitor: openapi_core_1.Stats(statsAccumulator),
+            },
+        ], types);
         openapi_core_1.walkDocument({
             document,
             rootType: types.DefinitionRoot,

package/lib/index.js

@@ -26,7 +26,7 @@ const version = require('../package.json').version;
 yargs
     .version('version', 'Show version number.', version)
     .help('help', 'Show help.')
-    .command('stats [entrypoint]', 'Gathering statistics for a document.', (yargs) => yargs.positional('entrypoint', { type: 'string' }).option({
+    .command('stats [api]', 'Gathering statistics for a document.', (yargs) => yargs.positional('api', { type: 'string' }).option({
     config: { description: 'Specify path to the config file.', type: 'string' },
     format: {
         description: 'Use a specific output format.',
@@ -34,8 +34,8 @@ yargs
         default: 'stylish',
     },
 }), stats_1.handleStats)
-    .command('split [entrypoint]', 'Split definition into a multi-file structure.', (yargs) => yargs
-    .positional('entrypoint', {
+    .command('split [api]', 'Split definition into a multi-file structure.', (yargs) => yargs
+    .positional('api', {
     description: 'API definition file that you want to split',
     type: 'string',
 })
@@ -52,9 +52,9 @@ yargs
         default: '_',
     },
 })
-    .demandOption('entrypoint'), split_1.handleSplit)
-    .command('join [entrypoints...]', 'Join definitions [experimental].', (yargs) => yargs
-    .positional('entrypoints', {
+    .demandOption('api'), split_1.handleSplit)
+    .command('join [apis...]', 'Join definitions [experimental].', (yargs) => yargs
+    .positional('apis', {
     array: true,
     type: 'string',
     demandOption: true,
@@ -83,8 +83,8 @@ yargs
 }), (argv) => {
     join_1.handleJoin(argv, version);
 })
-    .command('push [maybeEntrypointOrAliasOrDestination] [maybeDestination] [maybeBranchName]', 'Push an API definition to the Redocly API registry.', (yargs) => yargs
-    .positional('maybeEntrypointOrAliasOrDestination', { type: 'string' })
+    .command('push [maybeApiOrDestination] [maybeDestination] [maybeBranchName]', 'Push an API definition to the Redocly API registry.', (yargs) => yargs
+    .positional('maybeApiOrDestination', { type: 'string' })
     .positional('maybeDestination', { type: 'string' })
     .positional('maybeBranchName', { type: 'string' })
     .option({
@@ -113,7 +113,7 @@ yargs
 })
     .implies('batch-id', 'batch-size')
     .implies('batch-size', 'batch-id'), push_1.transformPush(push_1.handlePush))
-    .command('lint [entrypoints...]', 'Lint definition.', (yargs) => yargs.positional('entrypoints', { array: true, type: 'string', demandOption: true }).option({
+    .command('lint [apis...]', 'Lint definition.', (yargs) => yargs.positional('apis', { array: true, type: 'string', demandOption: true }).option({
     format: {
         description: 'Use a specific output format.',
         choices: [
@@ -147,11 +147,7 @@ yargs
     },
     'lint-config': {
         description: 'Apply severity for linting the config file.',
-        choices: [
-            'warn',
-            'error',
-            'off',
-        ],
+        choices: ['warn', 'error', 'off'],
         default: 'warn',
     },
     config: {
@@ -168,7 +164,7 @@ yargs
 }), (argv) => {
     lint_1.handleLint(argv, version);
 })
-    .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.',
@@ -256,7 +252,7 @@ yargs
     client.logout();
     process.stdout.write('Logged out from the Redocly account. ✋\n');
 }))
-    .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',

package/lib/js-utils.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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,6 @@ 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;

package/lib/types.d.ts

@@ -1,4 +1,4 @@
-import { BundleOutputFormat, Region } from '@redocly/openapi-core';
+import type { BundleOutputFormat, OutputFormat, Region } from '@redocly/openapi-core';
 export declare type Totals = {
     errors: number;
     warnings: number;
@@ -11,3 +11,15 @@ 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 CommonOptions = {
+    apis: string[];
+    'max-problems'?: number;
+    extends?: string[];
+    config?: string;
+    format: OutputFormat;
+};
+export declare type Skips = {
+    'skip-rule'?: string[];
+    'skip-decorator'?: string[];
+    'skip-preprocessor'?: string[];
+};

package/lib/utils.d.ts

@@ -1,8 +1,8 @@
-import { BundleOutputFormat, Config, LintConfig } from '@redocly/openapi-core';
+import { BundleOutputFormat, Config, StyleguideConfig } from '@redocly/openapi-core';
 import { Totals, Entrypoint } from './types';
-export declare function getFallbackEntryPointsOrExit(argsEntrypoints: string[] | undefined, config: Config): Promise<Entrypoint[]>;
+export declare function getFallbackApisOrExit(argsApis: string[] | undefined, config: Config): 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 class CircularJSONNotSupportedError extends Error {
@@ -22,7 +22,7 @@ export declare function getOutputFileName(entrypoint: string, entries: number, o
     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

package/lib/utils.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSubdir = exports.exitWithError = exports.printUnusedWarnings = exports.getOutputFileName = exports.printConfigLintTotals = exports.printLintTotals = exports.handleError = exports.pluralize = exports.writeYaml = exports.readYaml = exports.promptUser = exports.saveBundle = exports.dumpBundle = exports.CircularJSONNotSupportedError = exports.escapeLanguageName = exports.pathToFilename = exports.printExecutionTime = exports.getExecutionTime = exports.getFallbackEntryPointsOrExit = void 0;
+exports.isSubdir = exports.exitWithError = exports.printUnusedWarnings = exports.getOutputFileName = exports.printConfigLintTotals = exports.printLintTotals = exports.handleError = exports.pluralize = exports.writeYaml = exports.readYaml = exports.promptUser = exports.saveBundle = exports.dumpBundle = exports.CircularJSONNotSupportedError = exports.escapeLanguageName = exports.pathToFilename = exports.printExecutionTime = exports.getExecutionTime = exports.getFallbackApisOrExit = void 0;
 const path_1 = require("path");
 const colorette_1 = require("colorette");
 const perf_hooks_1 = require("perf_hooks");
@@ -20,24 +20,24 @@ const readline = require("readline");
 const stream_1 = require("stream");
 const openapi_core_1 = require("@redocly/openapi-core");
 const types_1 = require("./types");
-function getFallbackEntryPointsOrExit(argsEntrypoints, config) {
+function getFallbackApisOrExit(argsApis, config) {
     return __awaiter(this, void 0, void 0, function* () {
         const { apis } = config;
-        const shouldFallbackToAllDefinitions = !isNotEmptyArray(argsEntrypoints) && apis && Object.keys(apis).length > 0;
+        const shouldFallbackToAllDefinitions = !isNotEmptyArray(argsApis) && apis && Object.keys(apis).length > 0;
         const res = shouldFallbackToAllDefinitions
             ? Object.entries(apis).map(([alias, { root }]) => ({
                 path: path_1.resolve(getConfigDirectory(config), root),
                 alias,
             }))
-            : (yield expandGlobsInEntrypoints(argsEntrypoints, config));
+            : yield expandGlobsInEntrypoints(argsApis, config);
         if (!isNotEmptyArray(res)) {
-            process.stderr.write('error: missing required argument `entrypoints`.\n');
+            process.stderr.write('error: missing required argument `apis`.\n');
             process.exit(1);
         }
         return res;
     });
 }
-exports.getFallbackEntryPointsOrExit = getFallbackEntryPointsOrExit;
+exports.getFallbackApisOrExit = getFallbackApisOrExit;
 function getConfigDirectory(config) {
     return config.configFile ? path_1.dirname(config.configFile) : process.cwd();
 }
@@ -65,9 +65,9 @@ function getExecutionTime(startedAt) {
         : `${Math.ceil(perf_hooks_1.performance.now() - startedAt)}ms`;
 }
 exports.getExecutionTime = getExecutionTime;
-function printExecutionTime(commandName, startedAt, entrypoint) {
+function printExecutionTime(commandName, startedAt, api) {
     const elapsed = getExecutionTime(startedAt);
-    process.stderr.write(colorette_1.gray(`\n${entrypoint}: ${commandName} processed in ${elapsed}\n\n`));
+    process.stderr.write(colorette_1.gray(`\n${api}: ${commandName} processed in ${elapsed}\n\n`));
 }
 exports.printExecutionTime = printExecutionTime;
 function pathToFilename(path, pathSeparator) {
@@ -79,10 +79,7 @@ function pathToFilename(path, pathSeparator) {
 }
 exports.pathToFilename = pathToFilename;
 function escapeLanguageName(lang) {
-    return lang
-        .replace(/#/g, "_sharp")
-        .replace(/\//, '_')
-        .replace(/\s/g, '');
+    return lang.replace(/#/g, '_sharp').replace(/\//, '_').replace(/\s/g, '');
 }
 exports.escapeLanguageName = escapeLanguageName;
 class CircularJSONNotSupportedError extends Error {
@@ -171,22 +168,24 @@ function pluralize(label, num) {
 exports.pluralize = pluralize;
 function handleError(e, ref) {
     if (e instanceof openapi_core_1.ResolveError) {
-        process.stderr.write(`Failed to resolve entrypoint definition at ${ref}:\n\n  - ${e.message}.\n\n`);
+        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 entrypoint definition at ${ref}:\n\n  - ${e.message}.\n\n`);
+        process.stderr.write(`Failed to parse api definition at ${ref}:\n\n  - ${e.message}.\n\n`);
         // TODO: codeframe
     }
-    else { // @ts-ignore
+    else {
+        // @ts-ignore
         if (e instanceof CircularJSONNotSupportedError) {
             process.stderr.write(colorette_1.red(`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')}.\n\n`);
         }
         else {
             process.stderr.write(`Something went wrong when processing ${ref}:\n\n  - ${e.message}.\n\n`);
-            throw e;
         }
     }
+    process.exitCode = 1;
+    throw e;
 }
 exports.handleError = handleError;
 function printLintTotals(totals, definitionsCount) {
@@ -220,7 +219,6 @@ function printConfigLintTotals(totals) {
     else if (totals.warnings > 0) {
         process.stderr.write(colorette_1.yellow(`You have ${totals.warnings} ${pluralize('warning', totals.warnings)}.\n`));
     }
-    ;
 }
 exports.printConfigLintTotals = printConfigLintTotals;
 function getOutputFileName(entrypoint, entries, output, ext) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.0.0-beta.103",
+  "version": "1.0.0-beta.106",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -35,7 +35,7 @@
     "Andriy Leliv <andriy@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.0.0-beta.103",
+    "@redocly/openapi-core": "1.0.0-beta.106",
     "assert-node-version": "^1.0.3",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",

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

@@ -24,3 +24,4 @@ export const getTotals = jest.fn(() => ({ errors: 0 }));
 export const formatProblems = jest.fn();
 export const slash = jest.fn();
 export const findConfig = jest.fn();
+export const doesYamlFileExist = jest.fn();

package/src/__mocks__/perf_hooks.ts

@@ -1,3 +1,3 @@
 export const performance = {
-    now: jest.fn()
-}
+  now: jest.fn(),
+};

package/src/__mocks__/utils.ts

@@ -1,4 +1,6 @@
-export const getFallbackEntryPointsOrExit = jest.fn((entrypoints) => entrypoints.map(() => ({ path: '' })));
+export const getFallbackApisOrExit = jest.fn((entrypoints) =>
+  entrypoints.map((path: string) => ({ path }))
+);
 export const dumpBundle = jest.fn(() => '');
 export const slash = jest.fn();
 export const pluralize = jest.fn();