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

package/lib/__tests__/utils.test.js

@@ -357,3 +357,10 @@ describe('checkIfRulesetExist', () => {
         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/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: {
@@ -378,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;

package/lib/update-version-notifier.js

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

package/lib/utils.d.ts

@@ -38,3 +38,4 @@ export declare function loadConfigAndHandleErrors(options?: {
 }): Promise<Config>;
 export declare function sortTopLevelKeysForOas(document: Oas3Definition | Oas2Definition): Oas3Definition | Oas2Definition;
 export declare function checkIfRulesetExist(rules: typeof StyleguideConfig.prototype.rules): void;
+export declare function cleanColors(input: string): string;

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.checkIfRulesetExist = exports.sortTopLevelKeysForOas = exports.loadConfigAndHandleErrors = 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.langToExt = exports.escapeLanguageName = exports.pathToFilename = exports.printExecutionTime = exports.getExecutionTime = exports.getFallbackApisOrExit = void 0;
+exports.cleanColors = exports.checkIfRulesetExist = exports.sortTopLevelKeysForOas = exports.loadConfigAndHandleErrors = 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.langToExt = 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");
@@ -238,7 +238,7 @@ function printLintTotals(totals, definitionsCount) {
         process.stderr.write(colorette_1.green(`Woohoo! Your OpenAPI ${pluralize('definition is', definitionsCount)} valid. 🎉\n${ignored}`));
     }
     if (totals.errors > 0) {
-        process.stderr.write(colorette_1.gray(`run \`openapi lint --generate-ignore-file\` to add all problems to the ignore file.\n`));
+        process.stderr.write(colorette_1.gray(`run \`redocly lint --generate-ignore-file\` to add all problems to the ignore file.\n`));
     }
     process.stderr.write('\n');
 }
@@ -384,3 +384,8 @@ function checkIfRulesetExist(rules) {
     }
 }
 exports.checkIfRulesetExist = checkIfRulesetExist;
+function cleanColors(input) {
+    // eslint-disable-next-line no-control-regex
+    return input.replace(/\x1b\[\d+m/g, '');
+}
+exports.cleanColors = cleanColors;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.0.0-beta.126",
+  "version": "1.0.0-beta.127",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -33,7 +33,7 @@
     "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.0.0-beta.126",
+    "@redocly/openapi-core": "1.0.0-beta.127",
     "assert-node-version": "^1.0.3",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",
@@ -45,6 +45,7 @@
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
     "redoc": "~2.0.0",
+    "semver": "^7.5.1",
     "simple-websocket": "^9.0.0",
     "styled-components": "5.3.3",
     "yargs": "17.0.1"
@@ -54,7 +55,8 @@
     "@types/react": "^17.0.8",
     "@types/react-dom": "^17.0.5",
     "@types/styled-components": "^5.1.1",
-    "@types/yargs": "16.0.2",
+    "@types/yargs": "17.0.5",
+    "@types/semver": "^7.5.0",
     "typescript": "^4.0.3"
   }
 }

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

@@ -1,80 +0,0 @@
-import { ConfigFixture } from './../../__tests__/fixtures/config';
-import { Document } from '@redocly/openapi-core';
-import { firstDocument, secondDocument } from '../documents';
-
-export const __redoclyClient = {
-  isAuthorizedWithRedocly: jest.fn().mockResolvedValue(true),
-  isAuthorizedWithRedoclyByRegion: jest.fn().mockResolvedValue(true),
-  login: jest.fn(),
-  registryApi: {
-    setAccessTokens: jest.fn(),
-    authStatus: jest.fn(),
-    prepareFileUpload: jest.fn().mockResolvedValue({
-      signedUploadUrl: 'signedUploadUrl',
-      filePath: 'filePath',
-    }),
-    pushApi: jest.fn(),
-  },
-};
-
-export const RedoclyClient = jest.fn(() => __redoclyClient);
-export const loadConfig = jest.fn(() => ConfigFixture);
-export const getMergedConfig = jest.fn();
-export const lint = jest.fn();
-export const bundle = jest.fn(() => ({ bundle: { parsed: null }, problems: null }));
-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();
-export const bundleDocument = jest.fn(() => Promise.resolve({ problems: {} }));
-export const detectOpenAPI = jest.fn();
-export const isAbsoluteUrl = jest.fn();
-
-export class BaseResolver {
-  cache = new Map<string, Promise<Document | ResolveError>>();
-
-  getFiles = jest.fn();
-  resolveExternalRef = jest.fn();
-  loadExternalRef = jest.fn;
-  parseDocument = jest.fn();
-  resolveDocument = jest
-    .fn()
-    .mockImplementationOnce(() =>
-      Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: firstDocument })
-    )
-    .mockImplementationOnce(() =>
-      Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: secondDocument })
-    );
-}
-
-export class ResolveError extends Error {
-  constructor(public originalError: Error) {
-    super(originalError.message);
-    Object.setPrototypeOf(this, ResolveError.prototype);
-  }
-}
-
-export class YamlParseError extends Error {
-  constructor(public originalError: Error) {
-    super(originalError.message);
-    Object.setPrototypeOf(this, YamlParseError.prototype);
-  }
-}
-
-export enum OasVersion {
-  Version2 = 'oas2',
-  Version3_0 = 'oas3_0',
-  Version3_1 = 'oas3_1',
-}
-
-export enum Oas3Operations {
-  get = 'get',
-  put = 'put',
-  post = 'post',
-  delete = 'delete',
-  options = 'options',
-  head = 'head',
-  patch = 'patch',
-  trace = 'trace',
-}

package/src/__mocks__/documents.ts

@@ -1,63 +0,0 @@
-export const firstDocument = {
-  openapi: '3.0.0',
-  servers: [{ url: 'http://localhost:8080' }],
-  info: {
-    description: 'example test',
-    version: '1.0.0',
-    title: 'Swagger Petstore',
-    termsOfService: 'http://swagger.io/terms/',
-    license: {
-      name: 'Apache 2.0',
-      url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
-    },
-  },
-  paths: {
-    '/GETUser/{userId}': {
-      summary: 'get user by id',
-      description: 'user info',
-      servers: [{ url: '/user' }, { url: '/pet', description: 'pet server' }],
-
-      get: {
-        tags: ['pet'],
-        summary: 'Find pet by ID',
-        description: 'Returns a single pet',
-        operationId: 'getPetById',
-        servers: [{ url: '/pet' }],
-      },
-      parameters: [{ name: 'param1', in: 'header', schema: { description: 'string' } }],
-    },
-  },
-  components: {},
-};
-
-export const secondDocument = {
-  openapi: '3.0.0',
-  servers: [{ url: 'http://localhost:8080' }],
-  info: {
-    description: 'example test',
-    version: '1.0.0',
-    title: 'Swagger Petstore',
-    termsOfService: 'http://swagger.io/terms/',
-    license: {
-      name: 'Apache 2.0',
-      url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
-    },
-  },
-  post: {
-    '/GETUser/{userId}': {
-      summary: 'get user',
-      description: 'user information',
-      servers: [{ url: '/user' }, { url: '/pet', description: '' }],
-
-      get: {
-        tags: ['pet'],
-        summary: 'Find pet by ID',
-        description: 'Returns a single pet',
-        operationId: 'getPetById',
-        servers: [{ url: '/pet' }],
-      },
-      parameters: [{ name: 'param1', in: 'header', schema: { description: 'string' } }],
-    },
-  },
-  components: {},
-};

package/src/__mocks__/fs.ts

@@ -1,6 +0,0 @@
-export const existsSync = jest.fn();
-export const readFileSync = jest.fn(() => '');
-export const statSync = jest.fn(() => ({ size: 0 }));
-export const createReadStream = jest.fn();
-export const writeFileSync = jest.fn();
-export const mkdirSync = jest.fn();

package/src/__mocks__/perf_hooks.ts

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

package/src/__mocks__/redoc.ts

@@ -1,2 +0,0 @@
-export const loadAndBundleSpec = jest.fn(() => Promise.resolve({ openapi: '3.0.0' }));
-export const createStore = jest.fn(() => Promise.resolve({ toJS: jest.fn(() => '{}') }));

package/src/__mocks__/utils.ts

@@ -1,19 +0,0 @@
-import { ConfigFixture } from '../__tests__/fixtures/config';
-
-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();
-export const getExecutionTime = jest.fn();
-export const printExecutionTime = jest.fn();
-export const printUnusedWarnings = jest.fn();
-export const printLintTotals = jest.fn();
-export const getOutputFileName = jest.fn(() => ({ outputFile: 'test.yaml', ext: 'yaml' }));
-export const handleError = jest.fn();
-export const exitWithError = jest.fn();
-export const writeYaml = jest.fn();
-export const loadConfigAndHandleErrors = jest.fn(() => ConfigFixture);
-export const checkIfRulesetExist = jest.fn();
-export const sortTopLevelKeysForOas = jest.fn((document) => document);

package/src/__tests__/commands/build-docs.test.ts

@@ -1,61 +0,0 @@
-import { createStore, loadAndBundleSpec } from 'redoc';
-import { renderToString } from 'react-dom/server';
-import { handlerBuildCommand } from '../../commands/build-docs';
-import { BuildDocsArgv } from '../../commands/build-docs/types';
-import { getPageHTML } from '../../commands/build-docs/utils';
-import { getFallbackApisOrExit } from '../../utils';
-
-jest.mock('redoc');
-jest.mock('fs');
-jest.mock('../../utils');
-
-const config = {
-  output: '',
-  cdn: false,
-  title: 'Test',
-  disableGoogleFont: false,
-  templateFileName: '',
-  templateOptions: {},
-  redocOptions: {},
-};
-
-jest.mock('react-dom/server', () => ({
-  renderToString: jest.fn(),
-}));
-
-jest.mock('handlebars', () => ({
-  compile: jest.fn(() => jest.fn(() => '<html></html>')),
-}));
-
-jest.mock('mkdirp', () => ({
-  sync: jest.fn(),
-}));
-
-describe('build-docs', () => {
-  it('should return correct html and call function for ssr', async () => {
-    const result = await getPageHTML({}, '../some-path/openapi.yaml', {
-      ...config,
-      redocCurrentVersion: '2.0.0',
-    });
-    expect(renderToString).toBeCalledTimes(1);
-    expect(createStore).toBeCalledTimes(1);
-    expect(result).toBe('<html></html>');
-  });
-
-  it('should work correctly when calling handlerBuildCommand', async () => {
-    const processExitMock = jest.spyOn(process, 'exit').mockImplementation();
-    await handlerBuildCommand({
-      o: '',
-      cdn: false,
-      title: 'test',
-      disableGoogleFont: false,
-      template: '',
-      templateOptions: {},
-      theme: { openapi: {} },
-      api: '../some-path/openapi.yaml',
-    } as BuildDocsArgv);
-    expect(loadAndBundleSpec).toBeCalledTimes(1);
-    expect(getFallbackApisOrExit).toBeCalledTimes(1);
-    expect(processExitMock).toBeCalledTimes(0);
-  });
-});

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

@@ -1,169 +0,0 @@
-import { lint, bundle, getTotals, getMergedConfig } from '@redocly/openapi-core';
-
-import { handleBundle } from '../../commands/bundle';
-import { handleError } from '../../utils';
-import SpyInstance = jest.SpyInstance;
-
-jest.mock('@redocly/openapi-core');
-jest.mock('../../utils');
-
-(getMergedConfig as jest.Mock).mockImplementation((config) => config);
-
-describe('bundle', () => {
-  let processExitMock: SpyInstance;
-  let exitCb: any;
-
-  beforeEach(() => {
-    processExitMock = jest.spyOn(process, 'exit').mockImplementation();
-    jest.spyOn(process, 'once').mockImplementation((_e, cb) => {
-      exitCb = cb;
-      return process.on(_e, cb);
-    });
-    jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
-  });
-
-  afterEach(() => {
-    (lint as jest.Mock).mockClear();
-    (bundle as jest.Mock).mockClear();
-    (getTotals as jest.Mock).mockReset();
-  });
-
-  it('bundles definitions w/o linting', async () => {
-    const apis = ['foo.yaml', 'bar.yaml'];
-
-    await handleBundle(
-      {
-        apis,
-        ext: 'yaml',
-        format: 'codeframe',
-      },
-      '1.0.0'
-    );
-
-    expect(lint).toBeCalledTimes(0);
-    expect(bundle).toBeCalledTimes(apis.length);
-  });
-
-  it('exits with code 0 when bundles definitions', async () => {
-    const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-
-    await handleBundle(
-      {
-        apis,
-        ext: 'yaml',
-        format: 'codeframe',
-      },
-      '1.0.0'
-    );
-
-    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 handleBundle(
-      {
-        apis,
-        ext: 'yaml',
-        format: 'codeframe',
-        lint: true,
-      },
-      '1.0.0'
-    );
-
-    expect(lint).toBeCalledTimes(apis.length);
-    expect(bundle).toBeCalledTimes(apis.length);
-  });
-
-  it('exits with code 0 when bundles definitions w/linting w/o errors', async () => {
-    const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-
-    await handleBundle(
-      {
-        apis,
-        ext: 'yaml',
-        format: 'codeframe',
-        lint: true,
-      },
-      '1.0.0'
-    );
-
-    exitCb?.();
-    expect(processExitMock).toHaveBeenCalledWith(0);
-  });
-
-  it('exits with code 1 when bundles definitions w/linting w/errors', async () => {
-    const apis = ['foo.yaml'];
-
-    (getTotals as jest.Mock).mockReturnValue({
-      errors: 1,
-      warnings: 0,
-      ignored: 0,
-    });
-
-    await handleBundle(
-      {
-        apis,
-        ext: 'yaml',
-        format: 'codeframe',
-        lint: true,
-      },
-      '1.0.0'
-    );
-
-    expect(lint).toBeCalledTimes(apis.length);
-    exitCb?.();
-    expect(processExitMock).toHaveBeenCalledWith(1);
-  });
-
-  it('handleError is called when bundles an invalid definition', async () => {
-    const apis = ['invalid.json'];
-
-    (bundle as jest.Mock).mockImplementationOnce(() => {
-      throw new Error('Invalid definition');
-    });
-
-    await handleBundle(
-      {
-        apis,
-        ext: 'json',
-        format: 'codeframe',
-        lint: false,
-      },
-      '1.0.0'
-    );
-
-    expect(handleError).toHaveBeenCalledTimes(1);
-    expect(handleError).toHaveBeenCalledWith(new Error('Invalid definition'), 'invalid.json');
-  });
-
-  it("handleError isn't called when bundles a valid definition", async () => {
-    const apis = ['foo.yaml'];
-
-    (getTotals as jest.Mock).mockReturnValue({
-      errors: 0,
-      warnings: 0,
-      ignored: 0,
-    });
-
-    await handleBundle(
-      {
-        apis,
-        ext: 'yaml',
-        format: 'codeframe',
-        lint: false,
-      },
-      '1.0.0'
-    );
-
-    expect(handleError).toHaveBeenCalledTimes(0);
-  });
-});