@redocly/cli 1.34.4 → 2.0.0-next.0

package/src/commands/lint.ts

@@ -1,169 +0,0 @@
-import { blue, gray } from 'colorette';
-import { performance } from 'perf_hooks';
-import {
-  formatProblems,
-  getMergedConfig,
-  getTotals,
-  lint,
-  lintConfig,
-} from '@redocly/openapi-core';
-import { ConfigValidationError } from '@redocly/openapi-core/lib/config';
-import { pluralize } from '@redocly/openapi-core/lib/utils';
-import {
-  checkIfRulesetExist,
-  exitWithError,
-  formatPath,
-  getExecutionTime,
-  getFallbackApisOrExit,
-  handleError,
-  notifyAboutIncompatibleConfigOptions,
-  printConfigLintTotals,
-  printLintTotals,
-  printUnusedWarnings,
-} from '../utils/miscellaneous';
-import { getCommandNameFromArgs } from '../utils/getCommandNameFromArgs';
-
-import type { Arguments } from 'yargs';
-import type { OutputFormat, ProblemSeverity } from '@redocly/openapi-core';
-import type { RawConfigProcessor } from '@redocly/openapi-core/lib/config';
-import type { CommandOptions, Skips, Totals, VerifyConfigOptions } from '../types';
-import type { CommandArgs } from '../wrapper';
-
-export type LintOptions = {
-  apis?: string[];
-  'max-problems': number;
-  extends?: string[];
-  format: OutputFormat;
-  'generate-ignore-file'?: boolean;
-} & Omit<Skips, 'skip-decorator'> &
-  VerifyConfigOptions;
-
-export async function handleLint({
-  argv,
-  config,
-  version,
-  collectSpecData,
-}: CommandArgs<LintOptions>) {
-  const apis = await getFallbackApisOrExit(argv.apis, config);
-
-  if (!apis.length) {
-    exitWithError('No APIs were provided.');
-  }
-
-  if (argv['generate-ignore-file']) {
-    config.styleguide.ignore = {}; // clear ignore
-  }
-  const totals: Totals = { errors: 0, warnings: 0, ignored: 0 };
-  let totalIgnored = 0;
-
-  // TODO: use shared externalRef resolver, blocked by preprocessors now as they can mutate documents
-  for (const { path, alias } of apis) {
-    try {
-      const startedAt = performance.now();
-      const resolvedConfig = getMergedConfig(config, alias);
-      const { styleguide } = resolvedConfig;
-
-      checkIfRulesetExist(styleguide.rules);
-
-      styleguide.skipRules(argv['skip-rule']);
-      styleguide.skipPreprocessors(argv['skip-preprocessor']);
-
-      if (styleguide.recommendedFallback) {
-        process.stderr.write(
-          `No configurations were provided -- using built in ${blue(
-            'recommended'
-          )} configuration by default.\n\n`
-        );
-      }
-      process.stderr.write(gray(`validating ${formatPath(path)}...\n`));
-      const results = await lint({
-        ref: path,
-        config: resolvedConfig,
-        collectSpecData,
-      });
-
-      const fileTotals = getTotals(results);
-      totals.errors += fileTotals.errors;
-      totals.warnings += fileTotals.warnings;
-      totals.ignored += fileTotals.ignored;
-
-      if (argv['generate-ignore-file']) {
-        for (const m of results) {
-          config.styleguide.addIgnore(m);
-          totalIgnored++;
-        }
-      } else {
-        formatProblems(results, {
-          format: argv.format,
-          maxProblems: argv['max-problems'],
-          totals: fileTotals,
-          version,
-        });
-      }
-
-      const elapsed = getExecutionTime(startedAt);
-      process.stderr.write(gray(`${formatPath(path)}: validated in ${elapsed}\n\n`));
-    } catch (e) {
-      handleError(e, path);
-    }
-  }
-
-  if (argv['generate-ignore-file']) {
-    config.styleguide.saveIgnore();
-    process.stderr.write(
-      `Generated ignore file with ${totalIgnored} ${pluralize('problem', totalIgnored)}.\n\n`
-    );
-  } else {
-    printLintTotals(totals, apis.length);
-  }
-
-  printUnusedWarnings(config.styleguide);
-
-  if (!(totals.errors === 0 || argv['generate-ignore-file'])) {
-    throw new Error('Lint failed.');
-  }
-}
-
-export function lintConfigCallback(
-  argv: CommandOptions & Record<string, undefined>,
-  version: string
-): RawConfigProcessor | undefined {
-  if (argv['lint-config'] === 'off') {
-    return;
-  }
-
-  if (argv.format === 'json') {
-    // we can't print config lint results as it will break json output
-    return;
-  }
-
-  return async ({ document, resolvedRefMap, config, parsed: { theme = {} } }) => {
-    const command = argv ? getCommandNameFromArgs(argv as Arguments) : undefined;
-
-    if (command === 'check-config') {
-      notifyAboutIncompatibleConfigOptions(theme.openapi);
-    }
-
-    const problems = await lintConfig({
-      document,
-      resolvedRefMap,
-      config,
-      severity: (argv['lint-config'] || 'warn') as ProblemSeverity,
-    });
-
-    const fileTotals = getTotals(problems);
-
-    formatProblems(problems, {
-      format: argv.format,
-      maxProblems: argv['max-problems'],
-      totals: fileTotals,
-      version,
-    });
-
-    printConfigLintTotals(fileTotals, command);
-
-    if (fileTotals.errors > 0) {
-      throw new ConfigValidationError();
-    }
-  };
-}

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

@@ -1,183 +0,0 @@
-import * as colorette from 'colorette';
-import * as chockidar from 'chokidar';
-import { bundle, RedoclyClient, getTotals, getMergedConfig, Config } from '@redocly/openapi-core';
-import {
-  getFallbackApisOrExit,
-  handleError,
-  loadConfigAndHandleErrors,
-} from '../../utils/miscellaneous';
-import startPreviewServer from './preview-server/preview-server';
-
-import type { Skips, VerifyConfigOptions } from '../../types';
-import type { CommandArgs } from '../../wrapper';
-
-export type PreviewDocsOptions = {
-  port: number;
-  host: string;
-  'use-community-edition'?: boolean;
-  config?: string;
-  api?: string;
-  force?: boolean;
-} & Omit<Skips, 'skip-rule'> &
-  VerifyConfigOptions;
-
-export async function previewDocs({
-  argv,
-  config: configFromFile,
-}: CommandArgs<PreviewDocsOptions>) {
-  let isAuthorizedWithRedocly = false;
-  let redocOptions: any = {};
-  let config = await reloadConfig(configFromFile);
-
-  const apis = await getFallbackApisOrExit(argv.api ? [argv.api] : [], config);
-  const api = apis[0];
-
-  let cachedBundle: any;
-  const deps = new Set<string>();
-
-  async function getBundle() {
-    return cachedBundle;
-  }
-
-  async function updateBundle() {
-    process.stdout.write('\nBundling...\n\n');
-    try {
-      const {
-        bundle: openapiBundle,
-        problems,
-        fileDependencies,
-      } = await bundle({
-        ref: api.path,
-        config,
-      });
-      const removed = [...deps].filter((x) => !fileDependencies.has(x));
-      watcher.unwatch(removed);
-      watcher.add([...fileDependencies]);
-      deps.clear();
-      fileDependencies.forEach(deps.add, deps);
-
-      const fileTotals = getTotals(problems);
-
-      if (fileTotals.errors === 0) {
-        process.stdout.write(
-          fileTotals.errors === 0
-            ? `Created a bundle for ${api.alias || api.path} ${
-                fileTotals.warnings > 0 ? 'with warnings' : 'successfully'
-              }\n`
-            : colorette.yellow(
-                `Created a bundle for ${
-                  api.alias || api.path
-                } with errors. Docs may be broken or not accurate\n`
-              )
-        );
-      }
-
-      return openapiBundle.parsed;
-    } catch (e) {
-      handleError(e, api.path);
-    }
-  }
-
-  setImmediate(() => {
-    cachedBundle = updateBundle();
-  }); // initial cache
-
-  const isAuthorized = isAuthorizedWithRedocly || redocOptions.licenseKey;
-  if (!isAuthorized) {
-    process.stderr.write(
-      `Using Redoc community edition.\nLogin with redocly ${colorette.blue(
-        'login'
-      )} or use an enterprise license key to preview with the premium docs.\n\n`
-    );
-  }
-
-  const hotClients = await startPreviewServer(argv.port, argv.host, {
-    getBundle,
-    getOptions: () => redocOptions,
-    useRedocPro: isAuthorized && !redocOptions.useCommunityEdition,
-  });
-
-  const watchPaths = [api.path, config.configFile!].filter((e) => !!e);
-  const watcher = chockidar.watch(watchPaths, {
-    disableGlobbing: true,
-    ignoreInitial: true,
-  });
-
-  const debouncedUpdatedBundle = debounce(async () => {
-    cachedBundle = updateBundle();
-    await cachedBundle;
-    hotClients.broadcast('{"type": "reload", "bundle": true}');
-  }, 2000);
-
-  const changeHandler = async (type: string, file: string) => {
-    process.stdout.write(`${colorette.green('watch')} ${type} ${colorette.blue(file)}\n`);
-    if (file === config.configFile) {
-      config = await reloadConfig();
-      hotClients.broadcast(JSON.stringify({ type: 'reload' }));
-      return;
-    }
-
-    debouncedUpdatedBundle();
-  };
-
-  watcher.on('change', changeHandler.bind(undefined, 'changed'));
-  watcher.on('add', changeHandler.bind(undefined, 'added'));
-  watcher.on('unlink', changeHandler.bind(undefined, 'removed'));
-
-  watcher.on('ready', () => {
-    process.stdout.write(
-      `\n  👀  Watching ${colorette.blue(api.path)} and all related resources for changes\n\n`
-    );
-  });
-
-  async function reloadConfig(config?: Config) {
-    if (!config) {
-      try {
-        config = (await loadConfigAndHandleErrors({ configPath: argv.config })) as Config;
-      } catch (err) {
-        config = new Config({ apis: {}, styleguide: {} });
-      }
-    }
-    const redoclyClient = new RedoclyClient();
-    isAuthorizedWithRedocly = await redoclyClient.isAuthorizedWithRedocly();
-    const resolvedConfig = getMergedConfig(config, argv.api);
-    const { styleguide } = resolvedConfig;
-
-    styleguide.skipPreprocessors(argv['skip-preprocessor']);
-    styleguide.skipDecorators(argv['skip-decorator']);
-
-    const referenceDocs = resolvedConfig.theme?.openapi;
-    redocOptions = {
-      ...referenceDocs,
-      useCommunityEdition: argv['use-community-edition'] || referenceDocs?.useCommunityEdition,
-      licenseKey: process.env.REDOCLY_LICENSE_KEY || referenceDocs?.licenseKey,
-      whiteLabel: true,
-    };
-    return resolvedConfig;
-  }
-}
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-export function debounce(func: Function, wait: number, immediate?: boolean) {
-  let timeout: NodeJS.Timeout | null;
-
-  return function executedFunction(...args: any[]) {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    // eslint-disable-next-line @typescript-eslint/no-this-alias
-    const context = this;
-
-    const later = () => {
-      timeout = null;
-      if (!immediate) func.apply(context, args);
-    };
-
-    const callNow = immediate && !timeout;
-
-    if (timeout) clearTimeout(timeout);
-
-    timeout = setTimeout(later, wait);
-
-    if (callNow) func.apply(context, args);
-  };
-}

package/src/commands/preview-docs/preview-server/default.hbs

@@ -1,24 +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}}}
-  <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
-</head>
-
-<body>
-  {{{redocHTML}}}
-</body>
-
-</html>

package/src/commands/preview-docs/preview-server/hot.js

@@ -1,59 +0,0 @@
-(function run() {
-  const Socket = window.SimpleWebsocket;
-  const port = window.__OPENAPI_CLI_WS_PORT;
-  const host = window.__OPENAPI_CLI_WS_HOST;
-
-  let socket;
-
-  reconnect();
-
-  function getFormattedHost() {
-    // Use localhost when bound to all interfaces
-    if (host === '::' || host === '0.0.0.0') {
-      return 'localhost';
-    }
-
-    // Other IPv6 addresses must be wrapped in brackets
-    if (host.includes('::')) {
-      return `[${host}]`;
-    }
-
-    // Otherwise return as-is
-    return host;
-  }
-
-  function reconnect() {
-    socket = new Socket(`ws://${getFormattedHost()}:${port}`);
-    socket.on('connect', () => {
-      socket.send('{"type": "ping"}');
-    });
-
-    socket.on('data', (data) => {
-      const message = JSON.parse(data);
-      switch (message.type) {
-        case 'pong':
-          console.log('[hot] hot reloading connected');
-          break;
-        case 'reload':
-          console.log('[hot] full page reload');
-          window.location.reload();
-          break;
-        default:
-          console.log(`[hot] ${message.type} received`);
-      }
-    });
-
-    socket.on('close', () => {
-      socket.destroy();
-      console.log('[hot] Connection lost, trying to reconnect in 4s');
-      setTimeout(() => {
-        reconnect();
-      }, 4000);
-    });
-
-    socket.on('error', () => {
-      console.log('[hot] Error connecting to hot reloading server');
-      socket.destroy();
-    });
-  }
-})();

package/src/commands/preview-docs/preview-server/oauth2-redirect.html

@@ -1,21 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no" />
-    <title>Redocly Reference Docs: OAuth2 Redirect</title>
-    <style>
-      .user-info {
-        margin: 150px auto auto;
-        width: 50%;
-        background-color: whitesmoke;
-        padding: 20px;
-        text-align: center;
-      }
-    </style>
-  </head>
-  <body>
-    <script src="https://cdn.redocly.com/reference-docs/latest/oauth2-redirect.js"></script>
-    <noscript>You need to enable JavaScript to run this app.</noscript>
-  </body>
-</html>

package/src/commands/preview-docs/preview-server/preview-server.ts

@@ -1,159 +0,0 @@
-import { compile } from 'handlebars';
-import * as colorette from 'colorette';
-import { getPort } from 'get-port-please';
-import { readFileSync, promises as fsPromises } from 'fs';
-import * as path from 'path';
-import { startHttpServer, startWsServer, respondWithGzip, mimeTypes } from './server';
-import { isSubdir } from '../../../utils/miscellaneous';
-
-import type { IncomingMessage } from 'http';
-
-function getPageHTML(
-  htmlTemplate: string,
-  redocOptions: object = {},
-  useRedocPro: boolean,
-  wsPort: number,
-  host: string
-) {
-  let templateSrc = readFileSync(htmlTemplate, 'utf-8');
-
-  // fix template for backward compatibility
-  templateSrc = templateSrc
-    .replace(/{?{{redocHead}}}?/, '{{{redocHead}}}')
-    .replace('{{redocBody}}', '{{{redocHTML}}}');
-
-  const template = compile(templateSrc);
-
-  return template({
-    redocHead: `
-  <script>
-    window.__REDOC_EXPORT = '${useRedocPro ? 'RedoclyReferenceDocs' : 'Redoc'}';
-    window.__OPENAPI_CLI_WS_PORT = ${wsPort};
-    window.__OPENAPI_CLI_WS_HOST = "${host}";
-  </script>
-  <script src="/simplewebsocket.min.js"></script>
-  <script src="/hot.js"></script>
-  <script src="${
-    useRedocPro
-      ? 'https://cdn.redocly.com/reference-docs/latest/redocly-reference-docs.min.js'
-      : 'https://cdn.redocly.com/redoc/latest/bundles/redoc.standalone.js'
-  }"></script>
-`,
-    redocHTML: `
-  <div id="redoc"></div>
-  <script>
-    var container = document.getElementById('redoc');
-    ${
-      useRedocPro
-        ? "window[window.__REDOC_EXPORT].setPublicPath('https://cdn.redocly.com/reference-docs/latest/');"
-        : ''
-    }
-    window[window.__REDOC_EXPORT].init("/openapi.json", ${JSON.stringify(redocOptions)}, container)
-  </script>`,
-  });
-}
-
-export default async function startPreviewServer(
-  port: number,
-  host: string,
-  {
-    getBundle,
-    getOptions,
-    useRedocPro,
-  }: // eslint-disable-next-line @typescript-eslint/ban-types
-  { getBundle: Function; getOptions: Function; useRedocPro: boolean }
-) {
-  const defaultTemplate = path.join(__dirname, 'default.hbs');
-  const handler = async (request: IncomingMessage, response: any) => {
-    console.time(colorette.dim(`GET ${request.url}`));
-    const { htmlTemplate } = getOptions() || {};
-
-    if (request.url?.endsWith('/') || path.extname(request.url!) === '') {
-      respondWithGzip(
-        getPageHTML(htmlTemplate || defaultTemplate, getOptions(), useRedocPro, wsPort, host),
-        request,
-        response,
-        {
-          'Content-Type': 'text/html',
-        }
-      );
-    } else if (request.url === '/openapi.json') {
-      const bundle = await getBundle();
-      if (bundle === undefined) {
-        respondWithGzip(
-          JSON.stringify({
-            openapi: '3.0.0',
-            info: {
-              description:
-                '<code> Failed to generate bundle: check out console output for more details </code>',
-            },
-            paths: {},
-          }),
-          request,
-          response,
-          {
-            'Content-Type': 'application/json',
-          }
-        );
-      } else {
-        respondWithGzip(JSON.stringify(bundle), request, response, {
-          'Content-Type': 'application/json',
-        });
-      }
-    } else {
-      let filePath =
-        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-        // @ts-ignore
-        {
-          '/hot.js': path.join(__dirname, 'hot.js'),
-          '/oauth2-redirect.html': path.join(__dirname, 'oauth2-redirect.html'),
-          '/simplewebsocket.min.js': require.resolve('simple-websocket/simplewebsocket.min.js'),
-        }[request.url || ''];
-
-      if (!filePath) {
-        const basePath = htmlTemplate ? path.dirname(htmlTemplate) : process.cwd();
-
-        filePath = path.resolve(basePath, `.${request.url}`);
-
-        if (!isSubdir(basePath, filePath)) {
-          respondWithGzip('404 Not Found', request, response, { 'Content-Type': 'text/html' }, 404);
-          console.timeEnd(colorette.dim(`GET ${request.url}`));
-          return;
-        }
-      }
-
-      const extname = String(path.extname(filePath)).toLowerCase() as keyof typeof mimeTypes;
-
-      const contentType = mimeTypes[extname] || 'application/octet-stream';
-      try {
-        respondWithGzip(await fsPromises.readFile(filePath), request, response, {
-          'Content-Type': contentType,
-        });
-      } catch (e) {
-        if (e.code === 'ENOENT') {
-          respondWithGzip('404 Not Found', request, response, { 'Content-Type': 'text/html' }, 404);
-        } else {
-          respondWithGzip(
-            `Something went wrong: ${e.code || e.message}...\n`,
-            request,
-            response,
-            {},
-            500
-          );
-        }
-      }
-    }
-    console.timeEnd(colorette.dim(`GET ${request.url}`));
-  };
-
-  const wsPort = await getPort({ port: 32201, portRange: [32201, 32301], host });
-
-  const server = startHttpServer(port, host, handler);
-  server.on('listening', () => {
-    process.stdout.write(
-      `\n  🔎  Preview server running at ${colorette.blue(`http://${host}:${port}\n`)}`
-    );
-  });
-
-  return startWsServer(wsPort, host);
-}