@redocly/cli 1.0.0-beta.125 → 1.0.0-beta.127

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

@@ -1,5 +1,5 @@
 /// <reference types="jest" />
-import { Document, ResolveError } from '@redocly/openapi-core';
+import { Document } from '@redocly/openapi-core';
 export declare const __redoclyClient: {
     isAuthorizedWithRedocly: jest.Mock<any, any>;
     isAuthorizedWithRedoclyByRegion: jest.Mock<any, any>;
@@ -31,6 +31,16 @@ export declare const loadConfig: jest.Mock<{
         saveIgnore: jest.Mock<any, any>;
         skipDecorators: jest.Mock<any, any>;
         ignore: null;
+        decorators: {
+            oas2: {};
+            oas3_0: {};
+            oas3_1: {};
+        };
+        preprocessors: {
+            oas2: {};
+            oas3_0: {};
+            oas3_1: {};
+        };
     };
 }, []>;
 export declare const getMergedConfig: jest.Mock<any, any>;
@@ -54,13 +64,21 @@ export declare const bundleDocument: jest.Mock<Promise<{
 export declare const detectOpenAPI: jest.Mock<any, any>;
 export declare const isAbsoluteUrl: jest.Mock<any, any>;
 export declare class BaseResolver {
-    cache: Map<string, Promise<ResolveError | Document>>;
+    cache: Map<string, Promise<Document | ResolveError>>;
     getFiles: jest.Mock<any, any>;
     resolveExternalRef: jest.Mock<any, any>;
     loadExternalRef: typeof jest.fn;
     parseDocument: jest.Mock<any, any>;
     resolveDocument: jest.Mock<any, any>;
 }
+export declare class ResolveError extends Error {
+    originalError: Error;
+    constructor(originalError: Error);
+}
+export declare class YamlParseError extends Error {
+    originalError: Error;
+    constructor(originalError: Error);
+}
 export declare enum OasVersion {
     Version2 = "oas2",
     Version3_0 = "oas3_0",

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Oas3Operations = exports.OasVersion = 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.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;
 const config_1 = require("./../../__tests__/fixtures/config");
 const documents_1 = require("../documents");
 exports.__redoclyClient = {
@@ -44,6 +44,22 @@ class BaseResolver {
     }
 }
 exports.BaseResolver = BaseResolver;
+class ResolveError extends Error {
+    constructor(originalError) {
+        super(originalError.message);
+        this.originalError = originalError;
+        Object.setPrototypeOf(this, ResolveError.prototype);
+    }
+}
+exports.ResolveError = ResolveError;
+class YamlParseError extends Error {
+    constructor(originalError) {
+        super(originalError.message);
+        this.originalError = originalError;
+        Object.setPrototypeOf(this, YamlParseError.prototype);
+    }
+}
+exports.YamlParseError = YamlParseError;
 var OasVersion;
 (function (OasVersion) {
     OasVersion["Version2"] = "oas2";

package/lib/__mocks__/utils.d.ts

@@ -23,5 +23,17 @@ export declare const loadConfigAndHandleErrors: jest.Mock<{
         saveIgnore: jest.Mock<any, any>;
         skipDecorators: jest.Mock<any, any>;
         ignore: null;
+        decorators: {
+            oas2: {};
+            oas3_0: {};
+            oas3_1: {};
+        };
+        preprocessors: {
+            oas2: {};
+            oas3_0: {};
+            oas3_1: {};
+        };
     };
 }, []>;
+export declare const checkIfRulesetExist: jest.Mock<any, any>;
+export declare const sortTopLevelKeysForOas: jest.Mock<any, [document: any]>;

package/lib/__mocks__/utils.js

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

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

@@ -13,6 +13,7 @@ const join_1 = require("../../commands/join");
 const utils_1 = require("../../utils");
 const colorette_1 = require("colorette");
 const openapi_core_1 = require("@redocly/openapi-core");
+const openapi_core_2 = require("../../__mocks__/@redocly/openapi-core");
 jest.mock('../../utils');
 jest.mock('colorette');
 describe('handleJoin fails', () => {
@@ -60,4 +61,24 @@ describe('handleJoin fails', () => {
         }, 'cli-version');
         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');
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+        }, 'cli-version');
+        const config = openapi_core_2.loadConfig();
+        expect(config.styleguide.skipDecorators).toHaveBeenCalled();
+        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');
+        yield join_1.handleJoin({
+            apis: ['first.yaml', 'second.yaml'],
+            decorate: true,
+            preprocess: true,
+        }, 'cli-version');
+        const config = openapi_core_2.loadConfig();
+        expect(config.styleguide.skipDecorators).not.toHaveBeenCalled();
+        expect(config.styleguide.skipPreprocessors).not.toHaveBeenCalled();
+    }));
 });

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

@@ -68,6 +68,15 @@ describe('handleLint', () => {
             yield lint_1.handleLint(Object.assign(Object.assign({}, argvMock), { 'generate-ignore-file': true }), versionMock);
             expect(getMergedConfigMock).toHaveBeenCalled();
         }));
+        it('should check if ruleset exist', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield lint_1.handleLint(argvMock, versionMock);
+            expect(utils_1.checkIfRulesetExist).toHaveBeenCalledTimes(1);
+        }));
+        it('should fail if apis not provided', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield lint_1.handleLint(Object.assign(Object.assign({}, argvMock), { apis: [] }), versionMock);
+            expect(utils_1.getFallbackApisOrExit).toHaveBeenCalledTimes(1);
+            expect(utils_1.exitWithError).toHaveBeenCalledWith('No APIs were provided');
+        }));
     });
     describe('loop through entrypints and lint stage', () => {
         it('should call getMergedConfig and lint ', () => __awaiter(void 0, void 0, void 0, function* () {

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

@@ -173,6 +173,22 @@ describe('push', () => {
         expect(utils_1.exitWithError).toBeCalledTimes(1);
         expect(utils_1.exitWithError).toHaveBeenLastCalledWith('Api not found. Please make sure you have provided the correct data in the config file.');
     }));
+    it('push should work and encode name with spaces', () => __awaiter(void 0, void 0, void 0, function* () {
+        const encodeURIComponentSpy = jest.spyOn(global, 'encodeURIComponent');
+        utils_1.loadConfigAndHandleErrors.mockImplementation(() => {
+            return Object.assign(Object.assign({}, config_1.ConfigFixture), { organization: 'test_org', apis: { 'my test api@v1': { root: 'path' } } });
+        });
+        yield push_1.handlePush({
+            upsert: true,
+            destination: 'my test api@v1',
+            branchName: 'test',
+            public: true,
+            'batch-id': '123',
+            'batch-size': 2,
+        });
+        expect(encodeURIComponentSpy).toHaveReturnedWith('my%20test%20api');
+        expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
+    }));
 });
 describe('transformPush', () => {
     it('should adapt the existing syntax', () => {

package/lib/__tests__/fixtures/config.d.ts

@@ -8,5 +8,15 @@ export declare const ConfigFixture: {
         saveIgnore: jest.Mock<any, any>;
         skipDecorators: jest.Mock<any, any>;
         ignore: null;
+        decorators: {
+            oas2: {};
+            oas3_0: {};
+            oas3_1: {};
+        };
+        preprocessors: {
+            oas2: {};
+            oas3_0: {};
+            oas3_1: {};
+        };
     };
 };

package/lib/__tests__/fixtures/config.js

@@ -10,5 +10,15 @@ exports.ConfigFixture = {
         saveIgnore: jest.fn(),
         skipDecorators: jest.fn(),
         ignore: null,
+        decorators: {
+            oas2: {},
+            oas3_0: {},
+            oas3_1: {},
+        },
+        preprocessors: {
+            oas2: {},
+            oas3_0: {},
+            oas3_1: {},
+        },
     },
 };

package/lib/__tests__/utils.test.js

@@ -14,6 +14,7 @@ const openapi_core_1 = require("@redocly/openapi-core");
 const colorette_1 = require("colorette");
 const fs_1 = require("fs");
 const path = require("path");
+const process = require("process");
 jest.mock('os');
 jest.mock('colorette');
 jest.mock('fs');
@@ -213,3 +214,153 @@ describe('langToExt', () => {
         expect(utils_1.langToExt('JavaScript')).toBe('.js');
     });
 });
+describe('sorTopLevelKeysForOas', () => {
+    it('should sort oas3 top level keys', () => {
+        const openApi = {
+            openapi: '3.0.0',
+            components: {},
+            security: [],
+            tags: [],
+            servers: [],
+            paths: {},
+            info: {},
+            externalDocs: {},
+            webhooks: [],
+            'x-webhooks': [],
+            jsonSchemaDialect: '',
+        };
+        const orderedKeys = [
+            'openapi',
+            'info',
+            'jsonSchemaDialect',
+            'servers',
+            'security',
+            'tags',
+            'externalDocs',
+            'paths',
+            'webhooks',
+            'x-webhooks',
+            'components',
+        ];
+        const result = utils_1.sortTopLevelKeysForOas(openApi);
+        Object.keys(result).forEach((key, index) => {
+            expect(key).toEqual(orderedKeys[index]);
+        });
+    });
+    it('should sort oas2 top level keys', () => {
+        const openApi = {
+            swagger: '2.0.0',
+            security: [],
+            tags: [],
+            paths: {},
+            info: {},
+            externalDocs: {},
+            host: '',
+            basePath: '',
+            securityDefinitions: [],
+            schemes: [],
+            consumes: [],
+            parameters: [],
+            produces: [],
+            definitions: [],
+            responses: [],
+        };
+        const orderedKeys = [
+            'swagger',
+            'info',
+            'host',
+            'basePath',
+            'schemes',
+            'consumes',
+            'produces',
+            'security',
+            'tags',
+            'externalDocs',
+            'paths',
+            'definitions',
+            'parameters',
+            'responses',
+            'securityDefinitions',
+        ];
+        const result = utils_1.sortTopLevelKeysForOas(openApi);
+        Object.keys(result).forEach((key, index) => {
+            expect(key).toEqual(orderedKeys[index]);
+        });
+    });
+});
+describe('handleErrors', () => {
+    const ref = 'openapi/test.yaml';
+    const redColoretteMocks = colorette_1.red;
+    beforeEach(() => {
+        jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
+        jest.spyOn(process, 'exit').mockImplementation((code) => code);
+        redColoretteMocks.mockImplementation((text) => text);
+    });
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+    it('should handle ResolveError', () => {
+        const resolveError = new openapi_core_1.ResolveError(new Error('File not found'));
+        utils_1.handleError(resolveError, ref);
+        expect(redColoretteMocks).toHaveBeenCalledTimes(1);
+        expect(process.exit).toHaveBeenCalledWith(1);
+        expect(process.stderr.write).toHaveBeenCalledWith(`Failed to resolve api definition 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'), {});
+        utils_1.handleError(yamlParseError, ref);
+        expect(redColoretteMocks).toHaveBeenCalledTimes(1);
+        expect(process.exit).toHaveBeenCalledWith(1);
+        expect(process.stderr.write).toHaveBeenCalledWith(`Failed to parse api definition at openapi/test.yaml:\n\n  - Invalid yaml.\n\n`);
+    });
+    it('should handle CircularJSONNotSupportedError', () => {
+        const circularError = new utils_1.CircularJSONNotSupportedError(new Error('Circular json'));
+        utils_1.handleError(circularError, ref);
+        expect(process.exit).toHaveBeenCalledWith(1);
+        expect(process.stderr.write).toHaveBeenCalledWith(`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`);
+    });
+    it('should throw unknown error', () => {
+        const testError = new Error('Test error');
+        try {
+            utils_1.handleError(testError, ref);
+        }
+        catch (e) {
+            expect(e).toEqual(testError);
+        }
+        expect(process.stderr.write).toHaveBeenCalledWith(`Something went wrong when processing openapi/test.yaml:\n\n  - Test error.\n\n`);
+    });
+});
+describe('checkIfRulesetExist', () => {
+    beforeEach(() => {
+        jest.spyOn(process, 'exit').mockImplementation((code) => code);
+    });
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+    it('should exit if rules not provided', () => {
+        const rules = {
+            oas2: {},
+            oas3_0: {},
+            oas3_1: {},
+        };
+        utils_1.checkIfRulesetExist(rules);
+        expect(process.exit).toHaveBeenCalledWith(1);
+    });
+    it('should not exit if rules provided', () => {
+        const rules = {
+            oas2: { 'operation-4xx-response': 'error' },
+            oas3_0: {},
+            oas3_1: {},
+        };
+        utils_1.checkIfRulesetExist(rules);
+        expect(process.exit).not.toHaveBeenCalled();
+    });
+});
+describe('cleanColors', () => {
+    it('should remove colors from string', () => {
+        const stringWithColors = `String for ${colorette_1.red('test')}`;
+        const result = utils_1.cleanColors(stringWithColors);
+        expect(result).not.toMatch(/\x1b\[\d+m/g);
+    });
+});

package/lib/commands/build-docs/utils.js

@@ -40,7 +40,7 @@ function getObjectOrJSON(openapiOptions, config) {
             break;
         default: {
             if (config) {
-                process.stderr.write(`Found ${config.configFile} and using theme.openapi options`);
+                process.stderr.write(`Found ${config.configFile} and using theme.openapi options\n`);
                 return config.theme.openapi ? config.theme.openapi : {};
             }
             return {};
@@ -58,7 +58,11 @@ function getPageHTML(api, pathToApi, { cdn, title, disableGoogleFont, templateFi
         const html = server_1.renderToString(sheet.collectStyles(react_1.createElement(redoc_1.Redoc, { store })));
         const state = yield store.toJS();
         const css = sheet.getStyleTags();
-        templateFileName = templateFileName ? templateFileName : path_1.join(__dirname, './template.hbs');
+        templateFileName = templateFileName
+            ? templateFileName
+            : (redocOptions === null || redocOptions === void 0 ? void 0 : redocOptions.htmlTemplate)
+                ? redocOptions.htmlTemplate
+                : path_1.join(__dirname, './template.hbs');
         const template = handlebars_1.compile(fs_1.readFileSync(templateFileName).toString());
         return template({
             redocHTML: `

package/lib/commands/bundle.js

@@ -47,6 +47,7 @@ function handleBundle(argv, version) {
                 styleguide.skipPreprocessors(argv['skip-preprocessor']);
                 styleguide.skipDecorators(argv['skip-decorator']);
                 if (argv.lint) {
+                    utils_1.checkIfRulesetExist(styleguide.rules);
                     if (config.styleguide.recommendedFallback) {
                         process.stderr.write(`No configurations were provided -- using built in ${colorette_1.blue('recommended')} configuration by default.\n\n`);
                     }
@@ -78,11 +79,11 @@ function handleBundle(argv, version) {
                 const { outputFile, ext } = utils_1.getOutputFileName(path, apis.length, argv.output, argv.ext);
                 if (fileTotals.errors === 0 || argv.force) {
                     if (!argv.output) {
-                        const output = utils_1.dumpBundle(result.parsed, argv.ext || 'yaml', argv.dereferenced);
+                        const output = utils_1.dumpBundle(utils_1.sortTopLevelKeysForOas(result.parsed), argv.ext || 'yaml', argv.dereferenced);
                         process.stdout.write(output);
                     }
                     else {
-                        const output = utils_1.dumpBundle(result.parsed, ext, argv.dereferenced);
+                        const output = utils_1.dumpBundle(utils_1.sortTopLevelKeysForOas(result.parsed), ext, argv.dereferenced);
                         utils_1.saveBundle(outputFile, output);
                     }
                 }

package/lib/commands/join.d.ts

@@ -1,6 +1,8 @@
 declare type JoinArgv = {
     apis: string[];
     lint?: boolean;
+    decorate?: boolean;
+    preprocess?: boolean;
     'prefix-tags-with-info-prop'?: string;
     'prefix-tags-with-filename'?: boolean;
     'prefix-components-with-info-prop'?: string;

package/lib/commands/join.js

@@ -41,6 +41,22 @@ function handleJoin(argv, packageVersion) {
         const apis = yield utils_1.getFallbackApisOrExit(argv.apis, config);
         const externalRefResolver = new openapi_core_1.BaseResolver(config.resolve);
         const documents = yield Promise.all(apis.map(({ path }) => externalRefResolver.resolveDocument(null, path, true)));
+        if (!argv.decorate) {
+            const decorators = new Set([
+                ...Object.keys(config.styleguide.decorators.oas3_0),
+                ...Object.keys(config.styleguide.decorators.oas3_1),
+                ...Object.keys(config.styleguide.decorators.oas2),
+            ]);
+            config.styleguide.skipDecorators(Array.from(decorators));
+        }
+        if (!argv.preprocess) {
+            const preprocessors = new Set([
+                ...Object.keys(config.styleguide.preprocessors.oas3_0),
+                ...Object.keys(config.styleguide.preprocessors.oas3_1),
+                ...Object.keys(config.styleguide.preprocessors.oas2),
+            ]);
+            config.styleguide.skipPreprocessors(Array.from(preprocessors));
+        }
         const bundleResults = yield Promise.all(documents.map((document) => openapi_core_1.bundleDocument({
             document,
             config: config.styleguide,
@@ -120,7 +136,7 @@ function handleJoin(argv, packageVersion) {
         if (potentialConflictsTotal) {
             return utils_1.exitWithError(`Please fix conflicts before running ${colorette_1.yellow('join')}.`);
         }
-        utils_1.writeYaml(joinedDef, specFilename, noRefs);
+        utils_1.writeYaml(utils_1.sortTopLevelKeysForOas(joinedDef), specFilename, noRefs);
         utils_1.printExecutionTime('join', startedAt, specFilename);
         function populateTags({ api, apiFilename, tags, potentialConflicts, tagsPrefix, componentsPrefix, }) {
             if (!joinedDef.hasOwnProperty(Tags)) {

package/lib/commands/lint.js

@@ -25,6 +25,9 @@ function handleLint(argv, version) {
             processRawConfig: lintConfigCallback(argv, version),
         });
         const apis = yield utils_1.getFallbackApisOrExit(argv.apis, config);
+        if (!apis.length) {
+            return utils_1.exitWithError('No APIs were provided');
+        }
         if (argv['generate-ignore-file']) {
             config.styleguide.ignore = {}; // clear ignore
         }
@@ -36,6 +39,7 @@ function handleLint(argv, version) {
                 const startedAt = perf_hooks_1.performance.now();
                 const resolvedConfig = openapi_core_1.getMergedConfig(config, alias);
                 const { styleguide } = resolvedConfig;
+                utils_1.checkIfRulesetExist(styleguide.rules);
                 styleguide.skipRules(argv['skip-rule']);
                 styleguide.skipPreprocessors(argv['skip-preprocessor']);
                 if (styleguide.recommendedFallback) {

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

@@ -103,7 +103,7 @@ function previewDocs(argv) {
                 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) });
+                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;
             });
         }

package/lib/commands/push.js

@@ -70,6 +70,7 @@ function handlePush(argv) {
             const resolvedConfig = openapi_core_1.getMergedConfig(config, apiNameAndVersion);
             resolvedConfig.styleguide.skipDecorators(argv['skip-decorator']);
             const [name, version = DEFAULT_VERSION] = apiNameAndVersion.split('@');
+            const encodedName = encodeURIComponent(name);
             try {
                 let rootFilePath = '';
                 const filePaths = [];
@@ -80,7 +81,7 @@ function handlePush(argv) {
                 for (const file of filesToUpload.files) {
                     const { signedUploadUrl, filePath } = yield client.registryApi.prepareFileUpload({
                         organizationId,
-                        name,
+                        name: encodedName,
                         version,
                         filesHash,
                         filename: file.keyOnS3,
@@ -101,7 +102,7 @@ function handlePush(argv) {
                 process.stdout.write('\n');
                 yield client.registryApi.pushApi({
                     organizationId,
-                    name,
+                    name: encodedName,
                     version,
                     rootFilePath,
                     filePaths,
@@ -234,7 +235,6 @@ function parseDestination(destination) {
 function getDestinationProps(destination, organization) {
     const groups = destination && parseDestination(destination);
     if (groups) {
-        groups.name && (groups.name = encodeURIComponent(groups.name));
         return {
             organizationId: groups.organizationId || organization,
             name: groups.name,

package/lib/index.js

@@ -23,10 +23,13 @@ const lint_1 = require("./commands/lint");
 const bundle_1 = require("./commands/bundle");
 const login_1 = require("./commands/login");
 const build_docs_1 = require("./commands/build-docs");
+const update_version_notifier_1 = require("./update-version-notifier");
 const version = require('../package.json').version;
+update_version_notifier_1.cacheLatestVersion();
 yargs
     .version('version', 'Show version number.', version)
     .help('help', 'Show help.')
+    .parserConfiguration({ 'greedy-arrays': false })
     .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: {
@@ -68,6 +71,8 @@ yargs
 })
     .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,
@@ -376,4 +381,5 @@ yargs
 }))
     .completion('completion', 'Generate completion script.')
     .demandCommand(1)
+    .middleware([update_version_notifier_1.notifyUpdateCliVersion])
     .strict().argv;

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

@@ -0,0 +1,2 @@
+export declare const notifyUpdateCliVersion: () => void;
+export declare const cacheLatestVersion: () => void;