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

package/src/__tests__/fixtures/config.ts

@@ -1,21 +0,0 @@
-export const ConfigFixture = {
-  configFile: null,
-  styleguide: {
-    addIgnore: jest.fn(),
-    skipRules: jest.fn(),
-    skipPreprocessors: jest.fn(),
-    saveIgnore: jest.fn(),
-    skipDecorators: jest.fn(),
-    ignore: null,
-    decorators: {
-      oas2: {},
-      oas3_0: {},
-      oas3_1: {},
-    },
-    preprocessors: {
-      oas2: {},
-      oas3_0: {},
-      oas3_1: {},
-    },
-  },
-};

package/src/__tests__/utils.test.ts

@@ -1,441 +0,0 @@
-import {
-  getFallbackApisOrExit,
-  isSubdir,
-  pathToFilename,
-  printConfigLintTotals,
-  langToExt,
-  checkIfRulesetExist,
-  handleError,
-  CircularJSONNotSupportedError,
-  sortTopLevelKeysForOas,
-} from '../utils';
-import {
-  ResolvedApi,
-  Totals,
-  isAbsoluteUrl,
-  ResolveError,
-  YamlParseError,
-  Oas3Definition,
-} from '@redocly/openapi-core';
-import { blue, red, yellow } from 'colorette';
-import { existsSync } from 'fs';
-import * as path from 'path';
-import * as process from 'process';
-
-jest.mock('os');
-jest.mock('colorette');
-jest.mock('fs');
-
-describe('isSubdir', () => {
-  it('can correctly determine if subdir', () => {
-    (
-      [
-        ['/foo', '/foo', false],
-        ['/foo', '/bar', false],
-        ['/foo', '/foobar', false],
-        ['/foo', '/foo/bar', true],
-        ['/foo', '/foo/../bar', false],
-        ['/foo', '/foo/./bar', true],
-        ['/bar/../foo', '/foo/bar', true],
-        ['/foo', './bar', false],
-        ['/foo', '/foo/..bar', true],
-      ] as [string, string, boolean][]
-    ).forEach(([parent, child, expectRes]) => {
-      expect(isSubdir(parent, child)).toBe(expectRes);
-    });
-  });
-
-  it('can correctly determine if subdir for windows-based paths', () => {
-    const os = require('os');
-    os.platform.mockImplementation(() => 'win32');
-
-    (
-      [
-        ['C:/Foo', 'C:/Foo/Bar', true],
-        ['C:\\Foo', 'C:\\Bar', false],
-        ['C:\\Foo', 'D:\\Foo\\Bar', false],
-      ] as [string, string, boolean][]
-    ).forEach(([parent, child, expectRes]) => {
-      expect(isSubdir(parent, child)).toBe(expectRes);
-    });
-  });
-
-  afterEach(() => {
-    jest.resetModules();
-  });
-});
-
-describe('pathToFilename', () => {
-  it('should use correct path separator', () => {
-    const processedPath = pathToFilename('/user/createWithList', '_');
-    expect(processedPath).toEqual('user_createWithList');
-  });
-});
-
-describe('getFallbackApisOrExit', () => {
-  it('should find alias by filename', async () => {
-    (existsSync as jest.Mock<any, any>).mockImplementationOnce(() => true);
-    const entry = await getFallbackApisOrExit(['./test.yaml'], {
-      apis: {
-        main: {
-          root: 'test.yaml',
-        },
-      },
-    } as any);
-    expect(entry).toEqual([{ path: './test.yaml', alias: 'main' }]);
-  });
-});
-
-describe('printConfigLintTotals', () => {
-  const totalProblemsMock: Totals = {
-    errors: 1,
-    warnings: 0,
-    ignored: 0,
-  };
-
-  const redColoretteMocks = red as jest.Mock<any, any>;
-  const yellowColoretteMocks = yellow as jest.Mock<any, any>;
-
-  beforeEach(() => {
-    yellowColoretteMocks.mockImplementation((text: string) => text);
-    redColoretteMocks.mockImplementation((text: string) => text);
-    jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
-  });
-
-  it('should print errors if such exist', () => {
-    printConfigLintTotals(totalProblemsMock);
-    expect(process.stderr.write).toHaveBeenCalledWith('❌ Your config has 1 error.\n');
-    expect(redColoretteMocks).toHaveBeenCalledWith('❌ Your config has 1 error.\n');
-  });
-
-  it('should print warnign and error', () => {
-    printConfigLintTotals({ ...totalProblemsMock, warnings: 2 });
-    expect(process.stderr.write).toHaveBeenCalledWith(
-      '❌ Your config has 1 error and 2 warnings.\n'
-    );
-    expect(redColoretteMocks).toHaveBeenCalledWith('❌ Your config has 1 error and 2 warnings.\n');
-  });
-
-  it('should print warnign if no error', () => {
-    printConfigLintTotals({ ...totalProblemsMock, errors: 0, warnings: 2 });
-    expect(process.stderr.write).toHaveBeenCalledWith('You have 2 warnings.\n');
-    expect(yellowColoretteMocks).toHaveBeenCalledWith('You have 2 warnings.\n');
-  });
-
-  it('should print nothing if no error and no warnings', () => {
-    const result = printConfigLintTotals({ ...totalProblemsMock, errors: 0 });
-    expect(result).toBeUndefined();
-    expect(process.stderr.write).toHaveBeenCalledTimes(0);
-    expect(yellowColoretteMocks).toHaveBeenCalledTimes(0);
-    expect(redColoretteMocks).toHaveBeenCalledTimes(0);
-  });
-});
-
-describe('getFallbackApisOrExit', () => {
-  const redColoretteMocks = red as jest.Mock<any, any>;
-  const yellowColoretteMocks = yellow as jest.Mock<any, any>;
-
-  const apis: Record<string, ResolvedApi> = {
-    main: {
-      root: 'someFile.yaml',
-      styleguide: {},
-    },
-  };
-
-  const config = { apis };
-
-  beforeEach(() => {
-    yellowColoretteMocks.mockImplementation((text: string) => text);
-    redColoretteMocks.mockImplementation((text: string) => text);
-    jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
-    jest.spyOn(process, 'exit').mockImplementation();
-  });
-
-  it('should exit with error because no path provided', async () => {
-    const apisConfig = {
-      apis: {},
-    };
-    await getFallbackApisOrExit([''], apisConfig);
-    expect(process.exit).toHaveBeenCalledWith(1);
-  });
-
-  it('should error if file from config do not exist', async () => {
-    (existsSync as jest.Mock<any, any>).mockImplementationOnce(() => false);
-    await getFallbackApisOrExit(undefined, config);
-
-    expect(process.stderr.write).toHaveBeenCalledWith(
-      '\n someFile.yaml does not exist or is invalid. Please provide a valid path. \n\n'
-    );
-    expect(process.exit).toHaveBeenCalledWith(1);
-  });
-
-  it('should return valid array with results if such file exist', async () => {
-    (existsSync as jest.Mock<any, any>).mockImplementationOnce(() => true);
-    jest.spyOn(path, 'resolve').mockImplementationOnce((_, path) => path);
-
-    const result = await getFallbackApisOrExit(undefined, config);
-    expect(process.stderr.write).toHaveBeenCalledTimes(0);
-    expect(process.exit).toHaveBeenCalledTimes(0);
-    expect(result).toStrictEqual([
-      {
-        alias: 'main',
-        path: 'someFile.yaml',
-      },
-    ]);
-  });
-
-  it('should exit with error in case if invalid path provided as args', async () => {
-    const apisConfig = {
-      apis: {},
-    };
-    (existsSync as jest.Mock<any, any>).mockImplementationOnce(() => false);
-    await getFallbackApisOrExit(['someFile.yaml'], apisConfig);
-
-    expect(process.stderr.write).toHaveBeenCalledWith(
-      '\n someFile.yaml does not exist or is invalid. Please provide a valid path. \n\n'
-    );
-    expect(process.exit).toHaveBeenCalledWith(1);
-  });
-
-  it('should exit with error in case if invalid 2 path provided as args', async () => {
-    const apisConfig = {
-      apis: {},
-    };
-    (existsSync as jest.Mock<any, any>).mockImplementationOnce(() => false);
-    await getFallbackApisOrExit(['someFile.yaml', 'someFile2.yaml'], apisConfig);
-
-    expect(process.stderr.write).lastCalledWith(
-      '\n someFile2.yaml does not exist or is invalid. Please provide a valid path. \n\n'
-    );
-    expect(process.exit).toHaveBeenCalledWith(1);
-  });
-
-  it('should exit with error if only one file exist ', async () => {
-    const apisStub = {
-      ...apis,
-      notExist: {
-        root: 'notExist.yaml',
-        styleguide: {},
-      },
-    };
-    const configStub = { apis: apisStub };
-
-    (existsSync as jest.Mock<any, any>).mockImplementationOnce((path) => path === 'someFile.yaml');
-
-    await getFallbackApisOrExit(undefined, configStub);
-
-    expect(process.stderr.write).toBeCalledWith(
-      '\n notExist.yaml does not exist or is invalid. Please provide a valid path. \n\n'
-    );
-    expect(process.exit).toHaveBeenCalledWith(1);
-  });
-
-  it('should work ok if it is url passed', async () => {
-    (existsSync as jest.Mock<any, any>).mockImplementationOnce(() => false);
-    (isAbsoluteUrl as jest.Mock<any, any>).mockImplementation(() => true);
-    const apisConfig = {
-      apis: {
-        main: {
-          root: 'https://someLinkt/petstore.yaml?main',
-          styleguide: {},
-        },
-      },
-    };
-
-    const result = await getFallbackApisOrExit(undefined, apisConfig);
-
-    expect(process.stderr.write).toHaveBeenCalledTimes(0);
-    expect(process.exit).toHaveBeenCalledTimes(0);
-    expect(result).toStrictEqual([
-      {
-        alias: 'main',
-        path: 'https://someLinkt/petstore.yaml?main',
-      },
-    ]);
-  });
-});
-
-describe('langToExt', () => {
-  it.each([
-    ['php', '.php'],
-    ['c#', '.cs'],
-    ['shell', '.sh'],
-    ['curl', '.sh'],
-    ['bash', '.sh'],
-    ['javascript', '.js'],
-    ['js', '.js'],
-    ['python', '.py'],
-  ])('should infer file extension from lang - %s', (lang, expected) => {
-    expect(langToExt(lang)).toBe(expected);
-  });
-
-  it('should ignore case when inferring file extension', () => {
-    expect(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: '',
-    } as any;
-    const orderedKeys = [
-      'openapi',
-      'info',
-      'jsonSchemaDialect',
-      'servers',
-      'security',
-      'tags',
-      'externalDocs',
-      'paths',
-      'webhooks',
-      'x-webhooks',
-      'components',
-    ];
-    const result = 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: [],
-    } as any;
-    const orderedKeys = [
-      'swagger',
-      'info',
-      'host',
-      'basePath',
-      'schemes',
-      'consumes',
-      'produces',
-      'security',
-      'tags',
-      'externalDocs',
-      'paths',
-      'definitions',
-      'parameters',
-      'responses',
-      'securityDefinitions',
-    ];
-    const result = sortTopLevelKeysForOas(openApi);
-
-    Object.keys(result).forEach((key, index) => {
-      expect(key).toEqual(orderedKeys[index]);
-    });
-  });
-});
-
-describe('handleErrors', () => {
-  const ref = 'openapi/test.yaml';
-
-  const redColoretteMocks = red as jest.Mock<any, any>;
-
-  beforeEach(() => {
-    jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
-    jest.spyOn(process, 'exit').mockImplementation((code) => code as never);
-    redColoretteMocks.mockImplementation((text) => text);
-  });
-
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
-  it('should handle ResolveError', () => {
-    const resolveError = new ResolveError(new Error('File not found'));
-    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 YamlParseError(new Error('Invalid yaml'), {} as any);
-    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 CircularJSONNotSupportedError(new Error('Circular json'));
-    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 ${blue('yaml')} output or remove ${blue('--dereferenced')}.\n\n`
-    );
-  });
-
-  it('should throw unknown error', () => {
-    const testError = new Error('Test error');
-    try {
-      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?: number) => code as never);
-  });
-
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
-  it('should exit if rules not provided', () => {
-    const rules = {
-      oas2: {},
-      oas3_0: {},
-      oas3_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: {},
-    } as any;
-    checkIfRulesetExist(rules);
-    expect(process.exit).not.toHaveBeenCalled();
-  });
-});

package/src/assert-node-version.ts

@@ -1,8 +0,0 @@
-import * as path from 'path';
-import { exitWithError } from './utils';
-
-try {
-  require('assert-node-version')(path.join(__dirname, '../'));
-} catch (err) {
-  exitWithError(err.message);
-}

package/src/commands/build-docs/index.ts

@@ -1,56 +0,0 @@
-import { loadAndBundleSpec } from 'redoc';
-import { dirname, resolve } from 'path';
-import { writeFileSync, mkdirSync } from 'fs';
-import { performance } from 'perf_hooks';
-
-import { getObjectOrJSON, getPageHTML } from './utils';
-import type { BuildDocsArgv } from './types';
-import { getMergedConfig, isAbsoluteUrl } from '@redocly/openapi-core';
-import {
-  exitWithError,
-  getExecutionTime,
-  getFallbackApisOrExit,
-  loadConfigAndHandleErrors,
-} from '../../utils';
-
-export const handlerBuildCommand = async (argv: BuildDocsArgv) => {
-  const startedAt = performance.now();
-
-  const configFromFile = await loadConfigAndHandleErrors({ configPath: argv.config });
-  const config = getMergedConfig(configFromFile, argv.api);
-
-  const apis = await getFallbackApisOrExit(argv.api ? [argv.api] : [], config);
-  const { path: pathToApi } = apis[0];
-
-  const options = {
-    output: argv.o,
-    cdn: argv.cdn,
-    title: argv.title,
-    disableGoogleFont: argv.disableGoogleFont,
-    templateFileName: argv.template,
-    templateOptions: argv.templateOptions || {},
-    redocOptions: getObjectOrJSON(argv.theme?.openapi, config),
-  };
-
-  const redocCurrentVersion = require('../../../package.json').dependencies.redoc.substring(1); // remove ~
-
-  try {
-    const elapsed = getExecutionTime(startedAt);
-
-    const api = await loadAndBundleSpec(
-      isAbsoluteUrl(pathToApi)
-        ? pathToApi
-        : resolve(argv.config ? dirname(argv.config) : '', pathToApi)
-    );
-    const pageHTML = await getPageHTML(api, pathToApi, { ...options, redocCurrentVersion });
-
-    mkdirSync(dirname(options.output), { recursive: true });
-    writeFileSync(options.output, pageHTML);
-    const sizeInKiB = Math.ceil(Buffer.byteLength(pageHTML) / 1024);
-    process.stdout.write(
-      `\n🎉 bundled successfully in: ${options.output} (${sizeInKiB} KiB) [⏱ ${elapsed}].\n`
-    );
-  } catch (e) {
-    exitWithError(e);
-  }
-};

package/src/commands/build-docs/template.hbs

@@ -1,23 +0,0 @@
-<!DOCTYPE html>
-<html>
-
-<head>
-  <meta charset="utf8" />
-  <title>{{title}}</title>
-  <!-- needed for adaptive design -->
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-  <style>
-    body {
-      padding: 0;
-      margin: 0;
-    }
-  </style>
-  {{{redocHead}}}
-  {{#unless disableGoogleFont}}<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">{{/unless}}
-</head>
-
-<body>
-  {{{redocHTML}}}
-</body>
-
-</html>

package/src/commands/build-docs/types.ts

@@ -1,26 +0,0 @@
-export type BuildDocsOptions = {
-  watch?: boolean;
-  cdn?: boolean;
-  output?: string;
-  title?: string;
-  disableGoogleFont?: boolean;
-  port?: number;
-  templateFileName?: string;
-  templateOptions?: any;
-  redocOptions?: any;
-  redocCurrentVersion: string;
-};
-
-export type BuildDocsArgv = {
-  api: string;
-  o: string;
-  cdn: boolean;
-  title?: string;
-  disableGoogleFont?: boolean;
-  template?: string;
-  templateOptions: Record<string, any>;
-  theme: {
-    openapi: string | Record<string, unknown>;
-  };
-  config?: string;
-};

package/src/commands/build-docs/utils.ts

@@ -1,112 +0,0 @@
-import { createElement } from 'react';
-import { createStore, Redoc } from 'redoc';
-import { Config, isAbsoluteUrl } from '@redocly/openapi-core';
-
-import { renderToString } from 'react-dom/server';
-import { ServerStyleSheet } from 'styled-components';
-import { compile } from 'handlebars';
-import { join } from 'path';
-import { existsSync, lstatSync, readFileSync } from 'fs';
-
-import type { BuildDocsOptions } from './types';
-import { red } from 'colorette';
-import { exitWithError } from '../../utils';
-
-export function getObjectOrJSON(
-  openapiOptions: string | Record<string, unknown>,
-  config: Config
-): JSON | Record<string, unknown> | Config {
-  switch (typeof openapiOptions) {
-    case 'object':
-      return openapiOptions;
-    case 'string':
-      try {
-        if (existsSync(openapiOptions) && lstatSync(openapiOptions).isFile()) {
-          return JSON.parse(readFileSync(openapiOptions, 'utf-8'));
-        } else {
-          return JSON.parse(openapiOptions);
-        }
-      } catch (e) {
-        process.stderr.write(
-          red(
-            `Encountered error:\n\n${openapiOptions}\n\nis neither a file with a valid JSON object neither a stringified JSON object.`
-          )
-        );
-        exitWithError(e);
-      }
-      break;
-    default: {
-      if (config) {
-        process.stderr.write(`Found ${config.configFile} and using theme.openapi options\n`);
-
-        return config.theme.openapi ? config.theme.openapi : {};
-      }
-      return {};
-    }
-  }
-  return {};
-}
-
-export async function getPageHTML(
-  api: any,
-  pathToApi: string,
-  {
-    cdn,
-    title,
-    disableGoogleFont,
-    templateFileName,
-    templateOptions,
-    redocOptions = {},
-    redocCurrentVersion,
-  }: BuildDocsOptions
-) {
-  process.stderr.write('Prerendering docs');
-
-  const apiUrl = redocOptions.specUrl || (isAbsoluteUrl(pathToApi) ? pathToApi : undefined);
-  const store = await createStore(api, apiUrl, redocOptions);
-  const sheet = new ServerStyleSheet();
-
-  const html = renderToString(sheet.collectStyles(createElement(Redoc, { store })));
-  const state = await store.toJS();
-  const css = sheet.getStyleTags();
-
-  templateFileName = templateFileName
-    ? templateFileName
-    : redocOptions?.htmlTemplate
-    ? (redocOptions.htmlTemplate as string)
-    : join(__dirname, './template.hbs');
-  const template = compile(readFileSync(templateFileName).toString());
-  return template({
-    redocHTML: `
-      <div id="redoc">${html || ''}</div>
-      <script>
-      ${`const __redoc_state = ${sanitizeJSONString(JSON.stringify(state))};` || ''}
-
-      var container = document.getElementById('redoc');
-      Redoc.${'hydrate(__redoc_state, container)'};
-
-      </script>`,
-    redocHead:
-      (cdn
-        ? '<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>'
-        : `<script src="https://cdn.redoc.ly/redoc/v${redocCurrentVersion}/bundles/redoc.standalone.js"></script>`) +
-      css,
-    title: title || api.info.title || 'ReDoc documentation',
-    disableGoogleFont,
-    templateOptions,
-  });
-}
-
-export function sanitizeJSONString(str: string): string {
-  return escapeClosingScriptTag(escapeUnicode(str));
-}
-
-// see http://www.thespanner.co.uk/2011/07/25/the-json-specification-is-now-wrong/
-export function escapeClosingScriptTag(str: string): string {
-  return str.replace(/<\/script>/g, '<\\/script>');
-}
-
-// see http://www.thespanner.co.uk/2011/07/25/the-json-specification-is-now-wrong/
-export function escapeUnicode(str: string): string {
-  return str.replace(/\u2028|\u2029/g, (m) => '\\u202' + (m === '\u2028' ? '8' : '9'));
-}