@redocly/cli 1.12.2 → 1.14.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @redocly/cli
 
+## 1.14.0
+
+### Minor Changes
+
+- Added the ability to exclude some operations or entire paths from the `security-defined` rule.
+
+### Patch Changes
+
+- Improved error messages.
+- Updated @redocly/openapi-core to v1.14.0.
+
+## 1.13.0
+
+### Minor Changes
+
+- Added support for the linting command to output markdown format.
+
+### Patch Changes
+
+- Updated @redocly/openapi-core to v1.13.0.
+
 ## 1.12.2
 
 ### Patch Changes

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

@@ -22,7 +22,7 @@ describe('handleJoin', () => {
     colloreteYellowMock.mockImplementation((string) => string);
     it('should call exitWithError because only one entrypoint', () => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, join_1.handleJoin)({ apis: ['first.yaml'] }, {}, 'cli-version');
-        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided. \n\n`);
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided.`);
     }));
     it('should call exitWithError because passed all 3 options for tags', () => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, join_1.handleJoin)({
@@ -31,7 +31,7 @@ describe('handleJoin', () => {
             'without-x-tag-groups': true,
             'prefix-tags-with-filename': true,
         }, {}, 'cli-version');
-        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, prefix-tags-with-info-prop, without-x-tag-groups together.\nPlease choose only one! \n\n`);
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, prefix-tags-with-info-prop, without-x-tag-groups together.\nPlease choose only one!`);
     }));
     it('should call exitWithError because passed all 2 options for tags', () => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, join_1.handleJoin)({
@@ -39,13 +39,13 @@ describe('handleJoin', () => {
             'without-x-tag-groups': true,
             'prefix-tags-with-filename': true,
         }, {}, 'cli-version');
-        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one! \n\n`);
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one!`);
     }));
     it('should call exitWithError because Only OpenAPI 3.0 and OpenAPI 3.1 are supported', () => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, join_1.handleJoin)({
             apis: ['first.yaml', 'second.yaml'],
         }, config_1.ConfigFixture, 'cli-version');
-        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('Only OpenAPI 3.0 and OpenAPI 3.1 are supported: undefined \n\n');
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('Only OpenAPI 3.0 and OpenAPI 3.1 are supported: undefined.');
     }));
     it('should call exitWithError if mixing OpenAPI 3.0 and 3.1', () => __awaiter(void 0, void 0, void 0, function* () {
         openapi_core_1.detectSpec
@@ -54,7 +54,7 @@ describe('handleJoin', () => {
         yield (0, join_1.handleJoin)({
             apis: ['first.yaml', 'second.yaml'],
         }, config_1.ConfigFixture, 'cli-version');
-        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('All APIs must use the same OpenAPI version: undefined \n\n');
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('All APIs must use the same OpenAPI version: undefined.');
     }));
     it('should call writeToFileByExtension function', () => __awaiter(void 0, void 0, void 0, function* () {
         openapi_core_1.detectSpec.mockReturnValue('oas3_0');

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

@@ -48,7 +48,7 @@ describe('handleLint', () => {
     describe('loadConfig and getEnrtypoints stage', () => {
         it('should fail if config file does not exist', () => __awaiter(void 0, void 0, void 0, function* () {
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { config: 'config.yaml' }));
-            expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('Please, provide valid path to the configuration file');
+            expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('Please provide a valid path to the configuration file.');
         }));
         it('should call loadConfigAndHandleErrors and getFallbackApisOrExit', () => __awaiter(void 0, void 0, void 0, function* () {
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(argvMock);
@@ -78,7 +78,7 @@ describe('handleLint', () => {
         it('should fail if apis not provided', () => __awaiter(void 0, void 0, void 0, function* () {
             yield (0, wrapper_1.commandWrapper)(lint_1.handleLint)(Object.assign(Object.assign({}, argvMock), { apis: [] }));
             expect(miscellaneous_1.getFallbackApisOrExit).toHaveBeenCalledTimes(1);
-            expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('No APIs were provided');
+            expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith('No APIs were provided.');
         }));
     });
     describe('loop through entrypoints and lint stage', () => {

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

@@ -186,7 +186,7 @@ describe('push', () => {
             'job-id': '123',
             'batch-size': 2,
         }, mockConfig);
-        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`Destination argument value is not valid, please use the right format: ${(0, colorette_1.yellow)('<api-name@api-version>')}`);
+        expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`Destination argument value is not valid, please use the right format: ${(0, colorette_1.yellow)('<api-name@api-version>')}.`);
     }));
     it('push should work and encode name with spaces', () => __awaiter(void 0, void 0, void 0, function* () {
         const encodeURIComponentSpy = jest.spyOn(global, 'encodeURIComponent');

package/lib/cms/commands/push.js

@@ -25,7 +25,7 @@ function handlePush(argv, config) {
         const { organization, project: projectId, 'mount-path': mountPath, verbose } = argv;
         const orgId = organization || config.organization;
         if (!argv.message || !argv.author || !argv.branch) {
-            (0, miscellaneous_1.exitWithError)('Error: message, author and branch are required for push to the CMS');
+            (0, miscellaneous_1.exitWithError)('Error: message, author and branch are required for push to the CMS.');
         }
         if (!orgId) {
             return (0, miscellaneous_1.exitWithError)(`No organization provided, please use --organization option or specify the 'organization' field in the config file.`);

package/lib/commands/join.js

@@ -26,7 +26,7 @@ function handleJoin(argv, config, packageVersion) {
     return __awaiter(this, void 0, void 0, function* () {
         const startedAt = perf_hooks_1.performance.now();
         if (argv.apis.length < 2) {
-            return (0, miscellaneous_1.exitWithError)(`At least 2 apis should be provided. \n\n`);
+            return (0, miscellaneous_1.exitWithError)(`At least 2 apis should be provided.`);
         }
         const fileExtension = (0, miscellaneous_1.getAndValidateFileExtension)(argv.output || argv.apis[0]);
         const { 'prefix-components-with-info-prop': prefixComponentsWithInfoProp, 'prefix-tags-with-filename': prefixTagsWithFilename, 'prefix-tags-with-info-prop': prefixTagsWithInfoProp, 'without-x-tag-groups': withoutXTagGroups, output: specFilename = `openapi.${fileExtension}`, } = argv;
@@ -36,7 +36,7 @@ function handleJoin(argv, config, packageVersion) {
             withoutXTagGroups && 'without-x-tag-groups',
         ].filter(Boolean);
         if (usedTagsOptions.length > 1) {
-            return (0, miscellaneous_1.exitWithError)(`You use ${(0, colorette_1.yellow)(usedTagsOptions.join(', '))} together.\nPlease choose only one! \n\n`);
+            return (0, miscellaneous_1.exitWithError)(`You use ${(0, colorette_1.yellow)(usedTagsOptions.join(', '))} together.\nPlease choose only one!`);
         }
         const apis = yield (0, miscellaneous_1.getFallbackApisOrExit)(argv.apis, config);
         const externalRefResolver = new openapi_core_1.BaseResolver(config.resolve);
@@ -67,7 +67,7 @@ function handleJoin(argv, config, packageVersion) {
                     totals: fileTotals,
                     version: packageVersion,
                 });
-                (0, miscellaneous_1.exitWithError)(`❌ Errors encountered while bundling ${(0, colorette_1.blue)(document.source.absoluteRef)}: join will not proceed.\n`);
+                (0, miscellaneous_1.exitWithError)(`❌ Errors encountered while bundling ${(0, colorette_1.blue)(document.source.absoluteRef)}: join will not proceed.`);
             }
         }
         let oasVersion = null;
@@ -75,15 +75,15 @@ function handleJoin(argv, config, packageVersion) {
             try {
                 const version = (0, openapi_core_1.detectSpec)(document.parsed);
                 if (version !== openapi_core_1.SpecVersion.OAS3_0 && version !== openapi_core_1.SpecVersion.OAS3_1) {
-                    return (0, miscellaneous_1.exitWithError)(`Only OpenAPI 3.0 and OpenAPI 3.1 are supported: ${(0, colorette_1.blue)(document.source.absoluteRef)} \n\n`);
+                    return (0, miscellaneous_1.exitWithError)(`Only OpenAPI 3.0 and OpenAPI 3.1 are supported: ${(0, colorette_1.blue)(document.source.absoluteRef)}.`);
                 }
                 oasVersion = oasVersion !== null && oasVersion !== void 0 ? oasVersion : version;
                 if (oasVersion !== version) {
-                    return (0, miscellaneous_1.exitWithError)(`All APIs must use the same OpenAPI version: ${(0, colorette_1.blue)(document.source.absoluteRef)} \n\n`);
+                    return (0, miscellaneous_1.exitWithError)(`All APIs must use the same OpenAPI version: ${(0, colorette_1.blue)(document.source.absoluteRef)}.`);
                 }
             }
             catch (e) {
-                return (0, miscellaneous_1.exitWithError)(`${e.message}: ${(0, colorette_1.blue)(document.source.absoluteRef)}`);
+                return (0, miscellaneous_1.exitWithError)(`${e.message}: ${(0, colorette_1.blue)(document.source.absoluteRef)}.`);
             }
         }
         const joinedDef = {};
@@ -276,7 +276,7 @@ function handleJoin(argv, config, packageVersion) {
                     for (const pathServer of joinedDef.paths[path].servers) {
                         if (pathServer.url === server.url) {
                             if (!isServersEqual(pathServer, server)) {
-                                (0, miscellaneous_1.exitWithError)(`Different server values for (${server.url}) in ${path}`);
+                                (0, miscellaneous_1.exitWithError)(`Different server values for (${server.url}) in ${path}.`);
                             }
                             isFoundServer = true;
                         }
@@ -307,7 +307,7 @@ function handleJoin(argv, config, packageVersion) {
                         if (!(0, openapi_core_1.isRef)(pathParameter) && !(0, openapi_core_1.isRef)(parameter)) {
                             if (pathParameter.name === parameter.name && pathParameter.in === parameter.in) {
                                 if (!isEqual(pathParameter.schema, parameter.schema)) {
-                                    (0, miscellaneous_1.exitWithError)(`Different parameter schemas for (${parameter.name}) in ${path}`);
+                                    (0, miscellaneous_1.exitWithError)(`Different parameter schemas for (${parameter.name}) in ${path}.`);
                                 }
                                 isFoundParameter = true;
                             }
@@ -441,9 +441,9 @@ function handleJoin(argv, config, packageVersion) {
             const openapi = firstApi.parsed;
             const componentsPrefix = getInfoPrefix(openapi.info, prefixComponentsWithInfoProp, types_1.COMPONENTS);
             if (!openapi.openapi)
-                (0, miscellaneous_1.exitWithError)('Version of specification is not found in. \n');
+                (0, miscellaneous_1.exitWithError)('Version of specification is not found.');
             if (!openapi.info)
-                (0, miscellaneous_1.exitWithError)('Info section is not found in specification. \n');
+                (0, miscellaneous_1.exitWithError)('Info section is not found in specification.');
             if ((_a = openapi.info) === null || _a === void 0 ? void 0 : _a.description) {
                 openapi.info.description = addComponentsPrefix(openapi.info.description, componentsPrefix);
             }
@@ -542,13 +542,13 @@ function getInfoPrefix(info, prefixArg, type) {
     if (!prefixArg)
         return '';
     if (!info)
-        (0, miscellaneous_1.exitWithError)('Info section is not found in specification. \n');
+        (0, miscellaneous_1.exitWithError)('Info section is not found in specification.');
     if (!info[prefixArg])
-        (0, miscellaneous_1.exitWithError)(`${(0, colorette_1.yellow)(`prefix-${type}-with-info-prop`)} argument value is not found in info section. \n`);
+        (0, miscellaneous_1.exitWithError)(`${(0, colorette_1.yellow)(`prefix-${type}-with-info-prop`)} argument value is not found in info section.`);
     if (!(0, js_utils_1.isString)(info[prefixArg]))
-        (0, miscellaneous_1.exitWithError)(`${(0, colorette_1.yellow)(`prefix-${type}-with-info-prop`)} argument value should be string. \n\n`);
+        (0, miscellaneous_1.exitWithError)(`${(0, colorette_1.yellow)(`prefix-${type}-with-info-prop`)} argument value should be string.`);
     if (info[prefixArg].length > 50)
-        (0, miscellaneous_1.exitWithError)(`${(0, colorette_1.yellow)(`prefix-${type}-with-info-prop`)} argument value length should not exceed 50 characters. \n\n`);
+        (0, miscellaneous_1.exitWithError)(`${(0, colorette_1.yellow)(`prefix-${type}-with-info-prop`)} argument value length should not exceed 50 characters.`);
     return info[prefixArg].replaceAll(/\s/g, '_');
 }
 function replace$Refs(obj, componentsPrefix) {

package/lib/commands/lint.js

@@ -20,7 +20,7 @@ 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');
+            (0, miscellaneous_1.exitWithError)('No APIs were provided.');
         }
         if (argv['generate-ignore-file']) {
             config.styleguide.ignore = {}; // clear ignore

package/lib/commands/push.js

@@ -53,7 +53,7 @@ function handlePush(argv, config) {
         const jobId = argv['job-id'];
         const batchSize = argv['batch-size'];
         if (destination && !exports.DESTINATION_REGEX.test(destination)) {
-            (0, miscellaneous_1.exitWithError)(`Destination argument value is not valid, please use the right format: ${(0, colorette_1.yellow)('<api-name@api-version>')}`);
+            (0, miscellaneous_1.exitWithError)(`Destination argument value is not valid, please use the right format: ${(0, colorette_1.yellow)('<api-name@api-version>')}.`);
         }
         const destinationProps = getDestinationProps(destination, config.organization);
         const organizationId = argv.organization || destinationProps.organizationId;
@@ -108,7 +108,7 @@ function handlePush(argv, config) {
                     const uploadResponse = yield uploadFileToS3(signedUploadUrl, file.contents || file.filePath);
                     const fileCounter = `(${++uploaded}/${filesToUpload.files.length})`;
                     if (!uploadResponse.ok) {
-                        (0, miscellaneous_1.exitWithError)(`✗ ${fileCounter}\nFile upload failed\n`);
+                        (0, miscellaneous_1.exitWithError)(`✗ ${fileCounter}\nFile upload failed.`);
                     }
                     process.stdout.write((0, colorette_1.green)(`✓ ${fileCounter}\n`));
                 }
@@ -128,14 +128,14 @@ function handlePush(argv, config) {
             }
             catch (error) {
                 if (error.message === 'ORGANIZATION_NOT_FOUND') {
-                    (0, miscellaneous_1.exitWithError)(`Organization ${(0, colorette_1.blue)(organizationId)} not found`);
+                    (0, miscellaneous_1.exitWithError)(`Organization ${(0, colorette_1.blue)(organizationId)} not found.`);
                 }
                 if (error.message === 'API_VERSION_NOT_FOUND') {
-                    (0, miscellaneous_1.exitWithError)(`The definition version ${(0, colorette_1.blue)(`${name}@${version}`)} does not exist in organization ${(0, colorette_1.blue)(organizationId)}!\n${(0, colorette_1.yellow)('Suggestion:')} please use ${(0, colorette_1.blue)('-u')} or ${(0, colorette_1.blue)('--upsert')} to create definition.\n\n`);
+                    (0, miscellaneous_1.exitWithError)(`The definition version ${(0, colorette_1.blue)(`${name}@${version}`)} does not exist in organization ${(0, colorette_1.blue)(organizationId)}!\n${(0, colorette_1.yellow)('Suggestion:')} please use ${(0, colorette_1.blue)('-u')} or ${(0, colorette_1.blue)('--upsert')} to create definition.`);
                 }
                 throw error;
             }
-            process.stdout.write(`Definition: ${(0, colorette_1.blue)(api)} is successfully pushed to Redocly API Registry \n`);
+            process.stdout.write(`Definition: ${(0, colorette_1.blue)(api)} is successfully pushed to Redocly API Registry.\n`);
         }
         (0, miscellaneous_1.printExecutionTime)('push', startedAt, api || `apis in organization ${organizationId}`);
     });
@@ -171,7 +171,7 @@ function collectFilesToUpload(api, config) {
             process.stdout.write(`Created a bundle for ${(0, colorette_1.blue)(api)} ${fileTotals.warnings > 0 ? 'with warnings' : ''}\n`);
         }
         else {
-            (0, miscellaneous_1.exitWithError)(`Failed to create a bundle for ${(0, colorette_1.blue)(api)}\n`);
+            (0, miscellaneous_1.exitWithError)(`Failed to create a bundle for ${(0, colorette_1.blue)(api)}.`);
         }
         const fileExt = path.extname(apiPath).split('.').pop();
         files.push(getFileEntry(apiPath, (0, miscellaneous_1.dumpBundle)(openapiBundle.parsed, fileExt)));

package/lib/commands/split/index.js

@@ -61,12 +61,12 @@ function loadFile(fileName) {
 }
 function validateDefinitionFileName(fileName) {
     if (!fs.existsSync(fileName))
-        (0, miscellaneous_1.exitWithError)(`File ${(0, colorette_1.blue)(fileName)} does not exist \n`);
+        (0, miscellaneous_1.exitWithError)(`File ${(0, colorette_1.blue)(fileName)} does not exist.`);
     const file = loadFile(fileName);
     if (file.swagger)
-        (0, miscellaneous_1.exitWithError)('OpenAPI 2 is not supported by this command');
+        (0, miscellaneous_1.exitWithError)('OpenAPI 2 is not supported by this command.');
     if (!file.openapi)
-        (0, miscellaneous_1.exitWithError)('File does not conform to the OpenAPI Specification. OpenAPI version is not specified');
+        (0, miscellaneous_1.exitWithError)('File does not conform to the OpenAPI Specification. OpenAPI version is not specified.');
     return true;
 }
 function traverseDirectoryDeep(directory, callback, componentsFiles) {

package/lib/index.js

@@ -364,6 +364,7 @@ yargs
             'checkstyle',
             'codeclimate',
             'summary',
+            'markdown',
             'github-actions',
         ],
         default: 'codeframe',
@@ -636,7 +637,7 @@ yargs
     },
     t: {
         alias: 'template',
-        describe: 'Path to handlebars page template, see https://git.io/vh8fP for the example.',
+        describe: 'Path to handlebars page template, see https://github.com/Redocly/redocly-cli/blob/main/packages/cli/src/commands/build-docs/template.hbs for the example.',
         type: 'string',
     },
     templateOptions: {

package/lib/wrapper.js

@@ -21,7 +21,7 @@ function commandWrapper(commandHandler) {
         let telemetry;
         try {
             if (argv.config && !(0, openapi_core_1.doesYamlFileExist)(argv.config)) {
-                (0, miscellaneous_1.exitWithError)('Please, provide valid path to the configuration file');
+                (0, miscellaneous_1.exitWithError)('Please provide a valid path to the configuration file.');
             }
             const config = (yield (0, miscellaneous_1.loadConfigAndHandleErrors)({
                 configPath: argv.config,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.12.2",
+  "version": "1.14.0",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -36,7 +36,7 @@
     "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.12.2",
+    "@redocly/openapi-core": "1.14.0",
     "abort-controller": "^3.0.0",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",

package/src/__tests__/commands/join.test.ts

@@ -15,7 +15,7 @@ describe('handleJoin', () => {
 
   it('should call exitWithError because only one entrypoint', async () => {
     await handleJoin({ apis: ['first.yaml'] }, {} as any, 'cli-version');
-    expect(exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided. \n\n`);
+    expect(exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided.`);
   });
 
   it('should call exitWithError because passed all 3 options for tags', async () => {
@@ -31,7 +31,7 @@ describe('handleJoin', () => {
     );
 
     expect(exitWithError).toHaveBeenCalledWith(
-      `You use prefix-tags-with-filename, prefix-tags-with-info-prop, without-x-tag-groups together.\nPlease choose only one! \n\n`
+      `You use prefix-tags-with-filename, prefix-tags-with-info-prop, without-x-tag-groups together.\nPlease choose only one!`
     );
   });
 
@@ -47,7 +47,7 @@ describe('handleJoin', () => {
     );
 
     expect(exitWithError).toHaveBeenCalledWith(
-      `You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one! \n\n`
+      `You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one!`
     );
   });
 
@@ -60,7 +60,7 @@ describe('handleJoin', () => {
       'cli-version'
     );
     expect(exitWithError).toHaveBeenCalledWith(
-      'Only OpenAPI 3.0 and OpenAPI 3.1 are supported: undefined \n\n'
+      'Only OpenAPI 3.0 and OpenAPI 3.1 are supported: undefined.'
     );
   });
 
@@ -77,7 +77,7 @@ describe('handleJoin', () => {
     );
 
     expect(exitWithError).toHaveBeenCalledWith(
-      'All APIs must use the same OpenAPI version: undefined \n\n'
+      'All APIs must use the same OpenAPI version: undefined.'
     );
   });
 

package/src/__tests__/commands/lint.test.ts

@@ -62,7 +62,7 @@ describe('handleLint', () => {
     it('should fail if config file does not exist', async () => {
       await commandWrapper(handleLint)({ ...argvMock, config: 'config.yaml' });
       expect(exitWithError).toHaveBeenCalledWith(
-        'Please, provide valid path to the configuration file'
+        'Please provide a valid path to the configuration file.'
       );
     });
 
@@ -102,7 +102,7 @@ describe('handleLint', () => {
     it('should fail if apis not provided', async () => {
       await commandWrapper(handleLint)({ ...argvMock, apis: [] });
       expect(getFallbackApisOrExit).toHaveBeenCalledTimes(1);
-      expect(exitWithError).toHaveBeenCalledWith('No APIs were provided');
+      expect(exitWithError).toHaveBeenCalledWith('No APIs were provided.');
     });
   });
 

package/src/__tests__/commands/push.test.ts

@@ -248,7 +248,7 @@ describe('push', () => {
     expect(exitWithError).toHaveBeenCalledWith(
       `Destination argument value is not valid, please use the right format: ${yellow(
         '<api-name@api-version>'
-      )}`
+      )}.`
     );
   });
 

package/src/cms/commands/push.ts

@@ -51,7 +51,7 @@ export async function handlePush(
   const orgId = organization || config.organization;
 
   if (!argv.message || !argv.author || !argv.branch) {
-    exitWithError('Error: message, author and branch are required for push to the CMS');
+    exitWithError('Error: message, author and branch are required for push to the CMS.');
   }
 
   if (!orgId) {

package/src/commands/join.ts

@@ -68,7 +68,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
   const startedAt = performance.now();
 
   if (argv.apis.length < 2) {
-    return exitWithError(`At least 2 apis should be provided. \n\n`);
+    return exitWithError(`At least 2 apis should be provided.`);
   }
 
   const fileExtension = getAndValidateFileExtension(argv.output || argv.apis[0]);
@@ -89,7 +89,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
 
   if (usedTagsOptions.length > 1) {
     return exitWithError(
-      `You use ${yellow(usedTagsOptions.join(', '))} together.\nPlease choose only one! \n\n`
+      `You use ${yellow(usedTagsOptions.join(', '))} together.\nPlease choose only one!`
     );
   }
 
@@ -137,7 +137,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
       exitWithError(
         `❌ Errors encountered while bundling ${blue(
           document.source.absoluteRef
-        )}: join will not proceed.\n`
+        )}: join will not proceed.`
       );
     }
   }
@@ -148,20 +148,18 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
       const version = detectSpec(document.parsed);
       if (version !== SpecVersion.OAS3_0 && version !== SpecVersion.OAS3_1) {
         return exitWithError(
-          `Only OpenAPI 3.0 and OpenAPI 3.1 are supported: ${blue(
-            document.source.absoluteRef
-          )} \n\n`
+          `Only OpenAPI 3.0 and OpenAPI 3.1 are supported: ${blue(document.source.absoluteRef)}.`
         );
       }
 
       oasVersion = oasVersion ?? version;
       if (oasVersion !== version) {
         return exitWithError(
-          `All APIs must use the same OpenAPI version: ${blue(document.source.absoluteRef)} \n\n`
+          `All APIs must use the same OpenAPI version: ${blue(document.source.absoluteRef)}.`
         );
       }
     } catch (e) {
-      return exitWithError(`${e.message}: ${blue(document.source.absoluteRef)}`);
+      return exitWithError(`${e.message}: ${blue(document.source.absoluteRef)}.`);
     }
   }
 
@@ -417,7 +415,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
         for (const pathServer of joinedDef.paths[path].servers) {
           if (pathServer.url === server.url) {
             if (!isServersEqual(pathServer, server)) {
-              exitWithError(`Different server values for (${server.url}) in ${path}`);
+              exitWithError(`Different server values for (${server.url}) in ${path}.`);
             }
             isFoundServer = true;
           }
@@ -452,7 +450,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
           if (!isRef(pathParameter) && !isRef(parameter)) {
             if (pathParameter.name === parameter.name && pathParameter.in === parameter.in) {
               if (!isEqual(pathParameter.schema, parameter.schema)) {
-                exitWithError(`Different parameter schemas for (${parameter.name}) in ${path}`);
+                exitWithError(`Different parameter schemas for (${parameter.name}) in ${path}.`);
               }
               isFoundParameter = true;
             }
@@ -627,8 +625,8 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     const firstApi = documents[0];
     const openapi = firstApi.parsed;
     const componentsPrefix = getInfoPrefix(openapi.info, prefixComponentsWithInfoProp, COMPONENTS);
-    if (!openapi.openapi) exitWithError('Version of specification is not found in. \n');
-    if (!openapi.info) exitWithError('Info section is not found in specification. \n');
+    if (!openapi.openapi) exitWithError('Version of specification is not found.');
+    if (!openapi.info) exitWithError('Info section is not found in specification.');
     if (openapi.info?.description) {
       openapi.info.description = addComponentsPrefix(openapi.info.description, componentsPrefix);
     }
@@ -749,20 +747,18 @@ function addSecurityPrefix(security: any, componentsPrefix: string) {
 
 function getInfoPrefix(info: any, prefixArg: string | undefined, type: string) {
   if (!prefixArg) return '';
-  if (!info) exitWithError('Info section is not found in specification. \n');
+  if (!info) exitWithError('Info section is not found in specification.');
   if (!info[prefixArg])
     exitWithError(
-      `${yellow(`prefix-${type}-with-info-prop`)} argument value is not found in info section. \n`
+      `${yellow(`prefix-${type}-with-info-prop`)} argument value is not found in info section.`
     );
   if (!isString(info[prefixArg]))
-    exitWithError(
-      `${yellow(`prefix-${type}-with-info-prop`)} argument value should be string. \n\n`
-    );
+    exitWithError(`${yellow(`prefix-${type}-with-info-prop`)} argument value should be string.`);
   if (info[prefixArg].length > 50)
     exitWithError(
       `${yellow(
         `prefix-${type}-with-info-prop`
-      )} argument value length should not exceed 50 characters. \n\n`
+      )} argument value length should not exceed 50 characters.`
     );
   return info[prefixArg].replaceAll(/\s/g, '_');
 }

package/src/commands/lint.ts

@@ -41,7 +41,7 @@ export async function handleLint(argv: LintOptions, config: Config, version: str
   const apis = await getFallbackApisOrExit(argv.apis, config);
 
   if (!apis.length) {
-    exitWithError('No APIs were provided');
+    exitWithError('No APIs were provided.');
   }
 
   if (argv['generate-ignore-file']) {

package/src/commands/push.ts

@@ -76,7 +76,7 @@ export async function handlePush(argv: PushOptions, config: Config): Promise<voi
     exitWithError(
       `Destination argument value is not valid, please use the right format: ${yellow(
         '<api-name@api-version>'
-      )}`
+      )}.`
     );
   }
 
@@ -176,7 +176,7 @@ export async function handlePush(argv: PushOptions, config: Config): Promise<voi
         const fileCounter = `(${++uploaded}/${filesToUpload.files.length})`;
 
         if (!uploadResponse.ok) {
-          exitWithError(`✗ ${fileCounter}\nFile upload failed\n`);
+          exitWithError(`✗ ${fileCounter}\nFile upload failed.`);
         }
 
         process.stdout.write(green(`✓ ${fileCounter}\n`));
@@ -198,7 +198,7 @@ export async function handlePush(argv: PushOptions, config: Config): Promise<voi
       });
     } catch (error) {
       if (error.message === 'ORGANIZATION_NOT_FOUND') {
-        exitWithError(`Organization ${blue(organizationId)} not found`);
+        exitWithError(`Organization ${blue(organizationId)} not found.`);
       }
 
       if (error.message === 'API_VERSION_NOT_FOUND') {
@@ -207,7 +207,7 @@ export async function handlePush(argv: PushOptions, config: Config): Promise<voi
             `${name}@${version}`
           )} does not exist in organization ${blue(organizationId)}!\n${yellow(
             'Suggestion:'
-          )} please use ${blue('-u')} or ${blue('--upsert')} to create definition.\n\n`
+          )} please use ${blue('-u')} or ${blue('--upsert')} to create definition.`
         );
       }
 
@@ -215,7 +215,7 @@ export async function handlePush(argv: PushOptions, config: Config): Promise<voi
     }
 
     process.stdout.write(
-      `Definition: ${blue(api!)} is successfully pushed to Redocly API Registry \n`
+      `Definition: ${blue(api!)} is successfully pushed to Redocly API Registry.\n`
     );
   }
   printExecutionTime('push', startedAt, api || `apis in organization ${organizationId}`);
@@ -254,7 +254,7 @@ async function collectFilesToUpload(api: string, config: Config) {
       `Created a bundle for ${blue(api)} ${fileTotals.warnings > 0 ? 'with warnings' : ''}\n`
     );
   } else {
-    exitWithError(`Failed to create a bundle for ${blue(api)}\n`);
+    exitWithError(`Failed to create a bundle for ${blue(api)}.`);
   }
 
   const fileExt = path.extname(apiPath).split('.').pop();

package/src/commands/split/index.ts

@@ -111,12 +111,13 @@ function loadFile(fileName: string) {
 }
 
 function validateDefinitionFileName(fileName: string) {
-  if (!fs.existsSync(fileName)) exitWithError(`File ${blue(fileName)} does not exist \n`);
+  if (!fs.existsSync(fileName)) exitWithError(`File ${blue(fileName)} does not exist.`);
   const file = loadFile(fileName);
-  if ((file as Oas2Definition).swagger) exitWithError('OpenAPI 2 is not supported by this command');
+  if ((file as Oas2Definition).swagger)
+    exitWithError('OpenAPI 2 is not supported by this command.');
   if (!(file as Oas3Definition | Oas3_1Definition).openapi)
     exitWithError(
-      'File does not conform to the OpenAPI Specification. OpenAPI version is not specified'
+      'File does not conform to the OpenAPI Specification. OpenAPI version is not specified.'
     );
   return true;
 }

package/src/index.ts

@@ -408,6 +408,7 @@ yargs
             'checkstyle',
             'codeclimate',
             'summary',
+            'markdown',
             'github-actions',
           ] as ReadonlyArray<OutputFormat>,
           default: 'codeframe' as OutputFormat,
@@ -725,7 +726,8 @@ yargs
           },
           t: {
             alias: 'template',
-            describe: 'Path to handlebars page template, see https://git.io/vh8fP for the example.',
+            describe:
+              'Path to handlebars page template, see https://github.com/Redocly/redocly-cli/blob/main/packages/cli/src/commands/build-docs/template.hbs for the example.',
             type: 'string',
           },
           templateOptions: {

package/src/wrapper.ts

@@ -19,7 +19,7 @@ export function commandWrapper<T extends CommandOptions>(
     let telemetry;
     try {
       if (argv.config && !doesYamlFileExist(argv.config)) {
-        exitWithError('Please, provide valid path to the configuration file');
+        exitWithError('Please provide a valid path to the configuration file.');
       }
       const config: Config = (await loadConfigAndHandleErrors({
         configPath: argv.config,