@redocly/cli 1.10.6 → 1.12.0

package/lib/index.js

@@ -12,6 +12,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 require("./utils/assert-node-version");
 const yargs = require("yargs");
+const colors = require("colorette");
 const types_1 = require("./types");
 const openapi_core_1 = require("@redocly/openapi-core");
 const preview_docs_1 = require("./commands/preview-docs");
@@ -92,9 +93,6 @@ yargs
     demandOption: true,
 })
     .option({
-    lint: { description: 'Lint descriptions', type: 'boolean', default: false, hidden: true },
-    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,
@@ -129,7 +127,34 @@ yargs
         choices: ['warn', 'error', 'off'],
         default: 'warn',
     },
+    lint: {
+        hidden: true,
+        deprecated: true,
+    },
+    decorate: {
+        hidden: true,
+        deprecated: true,
+    },
+    preprocess: {
+        hidden: true,
+        deprecated: true,
+    },
 }), (argv) => {
+    const DEPRECATED_OPTIONS = ['lint', 'preprocess', 'decorate'];
+    const DECORATORS_DOCUMENTATION_LINK = 'https://redocly.com/docs/cli/decorators/#decorators';
+    const JOIN_COMMAND_DOCUMENTATION_LINK = 'https://redocly.com/docs/cli/commands/join/#join';
+    DEPRECATED_OPTIONS.forEach((option) => {
+        if (argv[option]) {
+            process.stdout.write(`${colors.red(`Option --${option} is no longer supported. Please review join command documentation ${JOIN_COMMAND_DOCUMENTATION_LINK}.`)}`);
+            process.stdout.write('\n\n');
+            if (['preprocess', 'decorate'].includes(option)) {
+                process.stdout.write(`${colors.red(`If you are looking for decorators, please review the decorators documentation ${DECORATORS_DOCUMENTATION_LINK}.`)}`);
+                process.stdout.write('\n\n');
+            }
+            yargs.showHelp();
+            process.exit(1);
+        }
+    });
     process.env.REDOCLY_CLI_COMMAND = 'join';
     (0, wrapper_1.commandWrapper)(join_1.handleJoin)(argv);
 })
@@ -149,9 +174,10 @@ yargs
     project: {
         description: 'Name of the project to push to.',
         type: 'string',
+        required: true,
         alias: 'p',
     },
-    domain: { description: 'Specify a domain.', alias: 'd', type: 'string' },
+    domain: { description: 'Specify a domain.', alias: 'd', type: 'string', required: false },
     wait: {
         description: 'Wait for build to finish.',
         type: 'boolean',
@@ -161,6 +187,11 @@ yargs
         description: 'Maximum execution time in seconds.',
         type: 'number',
     },
+    'continue-on-deploy-failures': {
+        description: 'Command does not fail even if the deployment fails.',
+        type: 'boolean',
+        default: false,
+    },
 }), (argv) => {
     process.env.REDOCLY_CLI_COMMAND = 'push-status';
     (0, wrapper_1.commandWrapper)(push_status_1.handlePushStatus)(argv);
@@ -314,6 +345,11 @@ yargs
         type: 'boolean',
         default: false,
     },
+    'continue-on-deploy-failures': {
+        description: 'Command does not fail even if the deployment fails.',
+        type: 'boolean',
+        default: false,
+    },
 }), (argv) => {
     process.env.REDOCLY_CLI_COMMAND = 'push';
     (0, wrapper_1.commandWrapper)((0, push_1.commonPushHandler)(argv))(argv);
@@ -328,6 +364,7 @@ yargs
             'checkstyle',
             'codeclimate',
             'summary',
+            'github-actions',
         ],
         default: 'codeframe',
     },
@@ -377,28 +414,11 @@ yargs
         description: 'Output file.',
         alias: 'o',
     },
-    format: {
-        description: 'Use a specific output format.',
-        choices: ['stylish', 'codeframe', 'json', 'checkstyle'],
-        hidden: true,
-    },
-    'max-problems': {
-        requiresArg: true,
-        description: 'Reduce output to a maximum of N problems.',
-        type: 'number',
-        hidden: true,
-    },
     ext: {
         description: 'Bundle file extension.',
         requiresArg: true,
         choices: types_1.outputExtensions,
     },
-    'skip-rule': {
-        description: 'Ignore certain rules.',
-        array: true,
-        type: 'string',
-        hidden: true,
-    },
     'skip-preprocessor': {
         description: 'Ignore certain preprocessors.',
         array: true,
@@ -423,12 +443,6 @@ yargs
         description: 'Path to the config file.',
         type: 'string',
     },
-    lint: {
-        description: 'Lint API descriptions',
-        type: 'boolean',
-        default: false,
-        hidden: true,
-    },
     metafile: {
         description: 'Produce metadata about the bundle',
         type: 'string',
@@ -455,7 +469,35 @@ yargs
         choices: ['warn', 'error', 'off'],
         default: 'warn',
     },
+    format: {
+        hidden: true,
+        deprecated: true,
+    },
+    lint: {
+        hidden: true,
+        deprecated: true,
+    },
+    'skip-rule': {
+        hidden: true,
+        deprecated: true,
+        array: true,
+        type: 'string',
+    },
+    'max-problems': {
+        hidden: true,
+        deprecated: true,
+    },
 }), (argv) => {
+    const DEPRECATED_OPTIONS = ['lint', 'format', 'skip-rule', 'max-problems'];
+    const LINT_AND_BUNDLE_DOCUMENTATION_LINK = 'https://redocly.com/docs/cli/guides/lint-and-bundle/#lint-and-bundle-api-descriptions-with-redocly-cli';
+    DEPRECATED_OPTIONS.forEach((option) => {
+        if (argv[option]) {
+            process.stdout.write(`${colors.red(`Option --${option} is no longer supported. Please use separate commands, as described in the ${LINT_AND_BUNDLE_DOCUMENTATION_LINK}.`)}`);
+            process.stdout.write('\n\n');
+            yargs.showHelp();
+            process.exit(1);
+        }
+    });
     process.env.REDOCLY_CLI_COMMAND = 'bundle';
     (0, wrapper_1.commandWrapper)(bundle_1.handleBundle)(argv);
 })

package/lib/utils/miscellaneous.js

@@ -30,6 +30,7 @@ const fs = require("fs");
 const readline = require("readline");
 const stream_1 = require("stream");
 const child_process_1 = require("child_process");
+const util_1 = require("util");
 const openapi_core_1 = require("@redocly/openapi-core");
 const types_1 = require("../types");
 const utils_1 = require("@redocly/openapi-core/lib/utils");
@@ -89,7 +90,7 @@ function expandGlobsInEntrypoints(args, config) {
     return __awaiter(this, void 0, void 0, function* () {
         return (yield Promise.all(args.map((aliasOrPath) => __awaiter(this, void 0, void 0, function* () {
             return glob.hasMagic(aliasOrPath) && !(0, openapi_core_1.isAbsoluteUrl)(aliasOrPath)
-                ? (yield glob.__promisify__(aliasOrPath)).map((g) => getAliasOrPath(config, g))
+                ? (yield (0, util_1.promisify)(glob)(aliasOrPath)).map((g) => getAliasOrPath(config, g))
                 : getAliasOrPath(config, aliasOrPath);
         })))).flat();
     });
@@ -270,9 +271,9 @@ function handleError(e, ref) {
             throw e;
         }
         case openapi_core_1.ResolveError:
-            return exitWithError(`Failed to resolve API description at ${ref}:\n\n  - ${e.message}.`);
+            return exitWithError(`Failed to resolve API description at ${ref}:\n\n  - ${e.message}`);
         case openapi_core_1.YamlParseError:
-            return exitWithError(`Failed to parse API description at ${ref}:\n\n  - ${e.message}.`);
+            return exitWithError(`Failed to parse API description at ${ref}:\n\n  - ${e.message}`);
         case CircularJSONNotSupportedError: {
             return exitWithError(`Detected circular reference which can't be converted to JSON.\n` +
                 `Try to use ${(0, colorette_1.blue)('yaml')} output or remove ${(0, colorette_1.blue)('--dereferenced')}.`);
@@ -282,7 +283,7 @@ function handleError(e, ref) {
         case config_1.ConfigValidationError:
             return exitWithError(e.message);
         default: {
-            exitWithError(`Something went wrong when processing ${ref}:\n\n  - ${e.message}.`);
+            exitWithError(`Something went wrong when processing ${ref}:\n\n  - ${e.message}`);
         }
     }
 }

package/lib/wrapper.d.ts

@@ -1,4 +1,4 @@
 import { Config } from '@redocly/openapi-core';
 import type { Arguments } from 'yargs';
 import type { CommandOptions } from './types';
-export declare function commandWrapper<T extends CommandOptions>(commandHandler?: (argv: T, config: Config, version: string) => Promise<void>): (argv: Arguments<T>) => Promise<void>;
+export declare function commandWrapper<T extends CommandOptions>(commandHandler?: (argv: T, config: Config, version: string) => Promise<unknown>): (argv: Arguments<T>) => Promise<void>;

package/package.json

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

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

@@ -1,4 +1,4 @@
-import { lint, bundle, getTotals, getMergedConfig } from '@redocly/openapi-core';
+import { bundle, getTotals, getMergedConfig } from '@redocly/openapi-core';
 
 import { BundleOptions, handleBundle } from '../../commands/bundle';
 import { handleError } from '../../utils/miscellaneous';
@@ -25,21 +25,18 @@ describe('bundle', () => {
   });
 
   afterEach(() => {
-    (lint as jest.Mock).mockClear();
     (bundle as jest.Mock).mockClear();
     (getTotals as jest.Mock).mockReset();
   });
 
-  it('bundles definitions w/o linting', async () => {
+  it('bundles definitions', async () => {
     const apis = ['foo.yaml', 'bar.yaml'];
 
     await commandWrapper(handleBundle)({
       apis,
       ext: 'yaml',
-      format: 'codeframe',
     } as Arguments<BundleOptions>);
 
-    expect(lint).toBeCalledTimes(0);
     expect(bundle).toBeCalledTimes(apis.length);
   });
 
@@ -49,48 +46,25 @@ describe('bundle', () => {
     await commandWrapper(handleBundle)({
       apis,
       ext: 'yaml',
-      format: 'codeframe',
     } as Arguments<BundleOptions>);
 
     await exitCb?.();
     expect(processExitMock).toHaveBeenCalledWith(0);
   });
 
-  it('bundles definitions w/ linting', async () => {
-    const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-
-    (getTotals as jest.Mock).mockReturnValue({
-      errors: 0,
-      warnings: 0,
-      ignored: 0,
-    });
-
-    await commandWrapper(handleBundle)({
-      apis,
-      ext: 'yaml',
-      format: 'codeframe',
-      lint: true,
-    } as Arguments<BundleOptions>);
-
-    expect(lint).toBeCalledTimes(apis.length);
-    expect(bundle).toBeCalledTimes(apis.length);
-  });
-
-  it('exits with code 0 when bundles definitions w/linting w/o errors', async () => {
+  it('exits with code 0 when bundles definitions w/o errors', async () => {
     const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
 
     await commandWrapper(handleBundle)({
       apis,
       ext: 'yaml',
-      format: 'codeframe',
-      lint: true,
     } as Arguments<BundleOptions>);
 
     await exitCb?.();
     expect(processExitMock).toHaveBeenCalledWith(0);
   });
 
-  it('exits with code 1 when bundles definitions w/linting w/errors', async () => {
+  it('exits with code 1 when bundles definitions w/errors', async () => {
     const apis = ['foo.yaml'];
 
     (getTotals as jest.Mock).mockReturnValue({
@@ -102,11 +76,8 @@ describe('bundle', () => {
     await commandWrapper(handleBundle)({
       apis,
       ext: 'yaml',
-      format: 'codeframe',
-      lint: true,
     } as Arguments<BundleOptions>);
 
-    expect(lint).toBeCalledTimes(apis.length);
     await exitCb?.();
     expect(processExitMock).toHaveBeenCalledWith(1);
   });
@@ -121,8 +92,6 @@ describe('bundle', () => {
     await commandWrapper(handleBundle)({
       apis,
       ext: 'json',
-      format: 'codeframe',
-      lint: false,
     } as Arguments<BundleOptions>);
 
     expect(handleError).toHaveBeenCalledTimes(1);
@@ -141,8 +110,6 @@ describe('bundle', () => {
     await commandWrapper(handleBundle)({
       apis,
       ext: 'yaml',
-      format: 'codeframe',
-      lint: false,
     } as Arguments<BundleOptions>);
 
     expect(handleError).toHaveBeenCalledTimes(0);

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

@@ -165,23 +165,6 @@ describe('handleJoin', () => {
     expect(config.styleguide.skipPreprocessors).toHaveBeenCalled();
   });
 
-  it('should not call skipDecorators and skipPreprocessors', async () => {
-    (detectSpec as jest.Mock).mockReturnValue('oas3_0');
-    await handleJoin(
-      {
-        apis: ['first.yaml', 'second.yaml'],
-        decorate: true,
-        preprocess: true,
-      },
-      ConfigFixture as any,
-      'cli-version'
-    );
-
-    const config = loadConfig();
-    expect(config.styleguide.skipDecorators).not.toHaveBeenCalled();
-    expect(config.styleguide.skipPreprocessors).not.toHaveBeenCalled();
-  });
-
   it('should handle join with prefix-components-with-info-prop and null values', async () => {
     (detectSpec as jest.Mock).mockReturnValue('oas3_0');
 

package/src/__tests__/utils.test.ts

@@ -415,7 +415,7 @@ describe('handleErrors', () => {
   });
 
   it('should handle ResolveError', () => {
-    const resolveError = new ResolveError(new Error('File not found'));
+    const resolveError = new ResolveError(new Error('File not found.'));
     expect(() => handleError(resolveError, ref)).toThrowError(HandledError);
     expect(redColoretteMocks).toHaveBeenCalledTimes(1);
     expect(process.stderr.write).toHaveBeenCalledWith(
@@ -424,7 +424,7 @@ describe('handleErrors', () => {
   });
 
   it('should handle YamlParseError', () => {
-    const yamlParseError = new YamlParseError(new Error('Invalid yaml'), {} as any);
+    const yamlParseError = new YamlParseError(new Error('Invalid yaml.'), {} as any);
     expect(() => handleError(yamlParseError, ref)).toThrowError(HandledError);
     expect(redColoretteMocks).toHaveBeenCalledTimes(1);
     expect(process.stderr.write).toHaveBeenCalledWith(
@@ -451,7 +451,7 @@ describe('handleErrors', () => {
   });
 
   it('should throw unknown error', () => {
-    const testError = new Error('Test error');
+    const testError = new Error('Test error.');
     expect(() => handleError(testError, ref)).toThrowError(HandledError);
     expect(process.stderr.write).toHaveBeenCalledWith(
       `Something went wrong when processing openapi/test.yaml:\n\n  - Test error.\n\n`

package/src/cms/api/types.ts

@@ -48,33 +48,42 @@ export type Remote = {
 export type PushResponse = {
   id: string;
   remoteId: string;
+  isMainBranch: boolean;
+  isOutdated: boolean;
+  hasChanges: boolean;
+  replace: boolean;
+  scoutJobId: string | null;
+  uploadedFiles: Array<{ path: string; mimeType: string }>;
   commit: {
-    message: string;
     branchName: string;
-    sha: string | null;
-    url: string | null;
+    message: string;
     createdAt: string | null;
-    namespace: string | null;
-    repository: string | null;
+    namespaceId: string | null;
+    repositoryId: string | null;
+    url: string | null;
+    sha: string | null;
     author: {
       name: string;
       email: string;
       image: string | null;
     };
+    statuses: Array<{
+      name: string;
+      description: string;
+      status: 'pending' | 'running' | 'success' | 'failed';
+      url: string | null;
+    }>;
   };
   remote: {
     commits: {
-      branchName: string;
       sha: string;
+      branchName: string;
     }[];
   };
-  hasChanges: boolean;
-  isOutdated: boolean;
-  isMainBranch: boolean;
   status: PushStatusResponse;
 };
 
-type DeploymentStatusResponse = {
+export type DeploymentStatusResponse = {
   deploy: {
     url: string | null;
     status: DeploymentStatus;
@@ -96,6 +105,4 @@ export type ScorecardItem = {
 
 export type PushStatusBase = 'pending' | 'success' | 'running' | 'failed';
 
-// export type BuildStatus = PushStatusBase | 'NOT_STARTED' | 'QUEUED';
-
 export type DeploymentStatus = 'skipped' | PushStatusBase;