@redocly/cli 1.34.3 → 2.0.0-next.0

package/src/utils/miscellaneous.ts

@@ -1,729 +0,0 @@
-import { basename, dirname, extname, join, resolve, relative, isAbsolute } from 'path';
-import { blue, gray, green, red, yellow } from 'colorette';
-import { performance } from 'perf_hooks';
-import * as glob from 'glob';
-import * as fs from 'fs';
-import * as os from 'os';
-import * as readline from 'readline';
-import { Writable } from 'stream';
-import { execSync } from 'child_process';
-import { promisify } from 'util';
-import {
-  ResolveError,
-  YamlParseError,
-  parseYaml,
-  stringifyYaml,
-  isAbsoluteUrl,
-  loadConfig,
-  RedoclyClient,
-} from '@redocly/openapi-core';
-import {
-  isEmptyObject,
-  isNotEmptyArray,
-  isNotEmptyObject,
-  isPlainObject,
-  pluralize,
-} from '@redocly/openapi-core/lib/utils';
-import { ConfigValidationError } from '@redocly/openapi-core/lib/config';
-import { deprecatedRefDocsSchema } from '@redocly/config/lib/reference-docs-config-schema';
-import { outputExtensions } from '../types';
-import { version } from './update-version-notifier';
-import { DESTINATION_REGEX } from '../commands/push';
-import { getReuniteUrl } from '../reunite/api';
-
-import type { Arguments } from 'yargs';
-import type {
-  BundleOutputFormat,
-  StyleguideConfig,
-  ResolvedApi,
-  Region,
-  Config,
-  Oas3Definition,
-  Oas2Definition,
-} from '@redocly/openapi-core';
-import type { RawConfigProcessor } from '@redocly/openapi-core/lib/config';
-import type { Totals, Entrypoint, ConfigApis, CommandOptions, OutputExtensions } from '../types';
-
-export async function getFallbackApisOrExit(
-  argsApis: string[] | undefined,
-  config: ConfigApis
-): Promise<Entrypoint[]> {
-  const { apis } = config;
-  const shouldFallbackToAllDefinitions = !isNotEmptyArray(argsApis) && isNotEmptyObject(apis);
-  const res = shouldFallbackToAllDefinitions
-    ? fallbackToAllDefinitions(apis, config)
-    : await expandGlobsInEntrypoints(argsApis!, config);
-
-  const filteredInvalidEntrypoints = res.filter(({ path }) => !isApiPathValid(path));
-  if (isNotEmptyArray(filteredInvalidEntrypoints)) {
-    for (const { path } of filteredInvalidEntrypoints) {
-      process.stderr.write(
-        yellow(`\n${formatPath(path)} ${red(`does not exist or is invalid.\n\n`)}`)
-      );
-    }
-    exitWithError('Please provide a valid path.');
-  }
-  return res;
-}
-
-function getConfigDirectory(config: ConfigApis) {
-  return config.configFile ? dirname(config.configFile) : process.cwd();
-}
-
-function isApiPathValid(apiPath: string): string | void {
-  if (!apiPath.trim()) {
-    exitWithError('Path cannot be empty.');
-    return;
-  }
-  return fs.existsSync(apiPath) || isAbsoluteUrl(apiPath) ? apiPath : undefined;
-}
-
-function fallbackToAllDefinitions(
-  apis: Record<string, ResolvedApi>,
-  config: ConfigApis
-): Entrypoint[] {
-  return Object.entries(apis).map(([alias, { root, output }]) => ({
-    path: isAbsoluteUrl(root) ? root : resolve(getConfigDirectory(config), root),
-    alias,
-    output: output && resolve(getConfigDirectory(config), output),
-  }));
-}
-
-function getAliasOrPath(config: ConfigApis, aliasOrPath: string): Entrypoint {
-  const aliasApi = config.apis[aliasOrPath];
-  return aliasApi
-    ? {
-        path: isAbsoluteUrl(aliasApi.root)
-          ? aliasApi.root
-          : resolve(getConfigDirectory(config), aliasApi.root),
-        alias: aliasOrPath,
-        output: aliasApi.output && resolve(getConfigDirectory(config), aliasApi.output),
-      }
-    : {
-        path: aliasOrPath,
-        // find alias by path, take the first match
-        alias:
-          Object.entries(config.apis).find(([_alias, api]) => {
-            return resolve(api.root) === resolve(aliasOrPath);
-          })?.[0] ?? undefined,
-      };
-}
-
-async function expandGlobsInEntrypoints(argApis: string[], config: ConfigApis) {
-  return (
-    await Promise.all(
-      argApis.map(async (aliasOrPath) => {
-        return glob.hasMagic(aliasOrPath) && !isAbsoluteUrl(aliasOrPath)
-          ? (await promisify(glob)(aliasOrPath)).map((g: string) => getAliasOrPath(config, g))
-          : getAliasOrPath(config, aliasOrPath);
-      })
-    )
-  ).flat();
-}
-
-export function getExecutionTime(startedAt: number) {
-  return process.env.NODE_ENV === 'test'
-    ? '<test>ms'
-    : `${Math.ceil(performance.now() - startedAt)}ms`;
-}
-
-export function printExecutionTime(commandName: string, startedAt: number, api: string) {
-  const elapsed = getExecutionTime(startedAt);
-  process.stderr.write(gray(`\n${api}: ${commandName} processed in ${elapsed}\n\n`));
-}
-
-export function pathToFilename(path: string, pathSeparator: string) {
-  return path
-    .replace(/~1/g, '/')
-    .replace(/~0/g, '~')
-    .replace(/^\//, '')
-    .replace(/\//g, pathSeparator);
-}
-
-export function escapeLanguageName(lang: string) {
-  return lang.replace(/#/g, '_sharp').replace(/\//, '_').replace(/\s/g, '');
-}
-
-export function langToExt(lang: string) {
-  const langObj: any = {
-    php: '.php',
-    'c#': '.cs',
-    shell: '.sh',
-    curl: '.sh',
-    bash: '.sh',
-    javascript: '.js',
-    js: '.js',
-    python: '.py',
-    c: '.c',
-    'c++': '.cpp',
-    coffeescript: '.litcoffee',
-    dart: '.dart',
-    elixir: '.ex',
-    go: '.go',
-    groovy: '.groovy',
-    java: '.java',
-    kotlin: '.kt',
-    'objective-c': '.m',
-    perl: '.pl',
-    powershell: '.ps1',
-    ruby: '.rb',
-    rust: '.rs',
-    scala: '.sc',
-    swift: '.swift',
-    typescript: '.ts',
-    tsx: '.tsx',
-  };
-  return langObj[lang.toLowerCase()];
-}
-
-export class CircularJSONNotSupportedError extends Error {
-  constructor(public originalError: Error) {
-    super(originalError.message);
-    // Set the prototype explicitly.
-    Object.setPrototypeOf(this, CircularJSONNotSupportedError.prototype);
-  }
-}
-
-export function dumpBundle(obj: any, format: BundleOutputFormat, dereference?: boolean): string {
-  if (format === 'json') {
-    try {
-      return JSON.stringify(obj, null, 2);
-    } catch (e) {
-      if (e.message.indexOf('circular') > -1) {
-        throw new CircularJSONNotSupportedError(e);
-      }
-      throw e;
-    }
-  } else {
-    return stringifyYaml(obj, {
-      noRefs: !dereference,
-      lineWidth: -1,
-    });
-  }
-}
-
-export function saveBundle(filename: string, output: string) {
-  fs.mkdirSync(dirname(filename), { recursive: true });
-  fs.writeFileSync(filename, output);
-}
-
-export async function promptUser(query: string, hideUserInput = false): Promise<string> {
-  return new Promise((resolve) => {
-    let output: Writable = process.stdout;
-    let isOutputMuted = false;
-
-    if (hideUserInput) {
-      output = new Writable({
-        write: (chunk, encoding, callback) => {
-          if (!isOutputMuted) {
-            process.stdout.write(chunk, encoding);
-          }
-          callback();
-        },
-      });
-    }
-
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output,
-      terminal: true,
-      historySize: hideUserInput ? 0 : 30,
-    });
-
-    rl.question(`${query}:\n\n  `, (answer) => {
-      rl.close();
-      resolve(answer);
-    });
-
-    isOutputMuted = hideUserInput;
-  });
-}
-
-export function readYaml(filename: string) {
-  return parseYaml(fs.readFileSync(filename, 'utf-8'), { filename });
-}
-
-export function writeToFileByExtension(data: unknown, filePath: string, noRefs?: boolean) {
-  const ext = getAndValidateFileExtension(filePath);
-
-  if (ext === 'json') {
-    writeJson(data, filePath);
-    return;
-  }
-
-  writeYaml(data, filePath, noRefs);
-}
-
-export function writeYaml(data: any, filename: string, noRefs = false) {
-  const content = stringifyYaml(data, { noRefs });
-
-  if (process.env.NODE_ENV === 'test') {
-    process.stderr.write(content);
-    return;
-  }
-  fs.mkdirSync(dirname(filename), { recursive: true });
-  fs.writeFileSync(filename, content);
-}
-
-export function writeJson(data: unknown, filename: string) {
-  const content = JSON.stringify(data, null, 2);
-
-  if (process.env.NODE_ENV === 'test') {
-    process.stderr.write(content);
-    return;
-  }
-  fs.mkdirSync(dirname(filename), { recursive: true });
-  fs.writeFileSync(filename, content);
-}
-
-export function getAndValidateFileExtension(fileName: string): NonNullable<OutputExtensions> {
-  const ext = fileName.split('.').pop();
-
-  if (['yaml', 'yml', 'json'].includes(ext!)) {
-    return ext as NonNullable<OutputExtensions>;
-  }
-  process.stderr.write(yellow(`Unsupported file extension: ${ext}. Using yaml.\n`));
-  return 'yaml';
-}
-
-export function handleError(e: Error, ref: string) {
-  switch (e.constructor) {
-    case HandledError: {
-      throw e;
-    }
-    case ResolveError:
-      return exitWithError(`Failed to resolve API description at ${ref}:\n\n  - ${e.message}`);
-    case YamlParseError:
-      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 ${blue('yaml')} output or remove ${blue('--dereferenced')}.`
-      );
-    }
-    case SyntaxError:
-      return exitWithError(`Syntax error: ${e.message} ${e.stack?.split('\n\n')?.[0]}`);
-    case ConfigValidationError:
-      return exitWithError(e.message);
-    default: {
-      exitWithError(`Something went wrong when processing ${ref}:\n\n  - ${e.message}`);
-    }
-  }
-}
-
-export class HandledError extends Error {}
-
-export function printLintTotals(totals: Totals, definitionsCount: number) {
-  const ignored = totals.ignored
-    ? yellow(`${totals.ignored} ${pluralize('problem is', totals.ignored)} explicitly ignored.\n\n`)
-    : '';
-
-  if (totals.errors > 0) {
-    process.stderr.write(
-      red(
-        `❌ Validation failed with ${totals.errors} ${pluralize('error', totals.errors)}${
-          totals.warnings > 0
-            ? ` and ${totals.warnings} ${pluralize('warning', totals.warnings)}`
-            : ''
-        }.\n${ignored}`
-      )
-    );
-  } else if (totals.warnings > 0) {
-    process.stderr.write(
-      green(`Woohoo! Your API ${pluralize('description is', definitionsCount)} valid. 🎉\n`)
-    );
-    process.stderr.write(
-      yellow(`You have ${totals.warnings} ${pluralize('warning', totals.warnings)}.\n${ignored}`)
-    );
-  } else {
-    process.stderr.write(
-      green(
-        `Woohoo! Your API ${pluralize('description is', definitionsCount)} valid. 🎉\n${ignored}`
-      )
-    );
-  }
-
-  if (totals.errors > 0) {
-    process.stderr.write(
-      gray(`run \`redocly lint --generate-ignore-file\` to add all problems to the ignore file.\n`)
-    );
-  }
-
-  process.stderr.write('\n');
-}
-
-export function printConfigLintTotals(totals: Totals, command?: string | number): void {
-  if (totals.errors > 0) {
-    process.stderr.write(
-      red(`❌ Your config has ${totals.errors} ${pluralize('error', totals.errors)}.`)
-    );
-  } else if (totals.warnings > 0) {
-    process.stderr.write(
-      yellow(`⚠️ Your config has ${totals.warnings} ${pluralize('warning', totals.warnings)}.\n`)
-    );
-  } else if (command === 'check-config') {
-    process.stderr.write(green('✅  Your config is valid.\n'));
-  }
-}
-
-export function getOutputFileName({
-  entrypoint,
-  output,
-  argvOutput,
-  ext,
-  entries,
-}: {
-  entrypoint: string;
-  output?: string;
-  argvOutput?: string;
-  ext?: BundleOutputFormat;
-  entries: number;
-}) {
-  let outputFile = output || argvOutput;
-  if (!outputFile) {
-    return { ext: ext || 'yaml' };
-  }
-
-  if (entries > 1 && argvOutput) {
-    ext = ext || (extname(entrypoint).substring(1) as BundleOutputFormat);
-    if (!outputExtensions.includes(ext)) {
-      throw new Error(`Invalid file extension: ${ext}.`);
-    }
-    outputFile = join(argvOutput, basename(entrypoint, extname(entrypoint))) + '.' + ext;
-  } else {
-    ext =
-      ext ||
-      (extname(outputFile).substring(1) as BundleOutputFormat) ||
-      (extname(entrypoint).substring(1) as BundleOutputFormat);
-    if (!outputExtensions.includes(ext)) {
-      throw new Error(`Invalid file extension: ${ext}.`);
-    }
-    outputFile = join(dirname(outputFile), basename(outputFile, extname(outputFile))) + '.' + ext;
-  }
-  return { outputFile, ext };
-}
-
-export function printUnusedWarnings(config: StyleguideConfig) {
-  const { preprocessors, rules, decorators } = config.getUnusedRules();
-  if (rules.length) {
-    process.stderr.write(
-      yellow(
-        `[WARNING] Unused rules found in ${blue(config.configFile || '')}: ${rules.join(', ')}.\n`
-      )
-    );
-  }
-  if (preprocessors.length) {
-    process.stderr.write(
-      yellow(
-        `[WARNING] Unused preprocessors found in ${blue(
-          config.configFile || ''
-        )}: ${preprocessors.join(', ')}.\n`
-      )
-    );
-  }
-  if (decorators.length) {
-    process.stderr.write(
-      yellow(
-        `[WARNING] Unused decorators found in ${blue(config.configFile || '')}: ${decorators.join(
-          ', '
-        )}.\n`
-      )
-    );
-  }
-
-  if (rules.length || preprocessors.length) {
-    process.stderr.write(`Check the spelling and verify the added plugin prefix.\n`);
-  }
-}
-
-export function exitWithError(message: string) {
-  process.stderr.write(red(message) + '\n\n');
-  throw new HandledError(message);
-}
-
-/**
- * Checks if dir is subdir of parent
- */
-export function isSubdir(parent: string, dir: string): boolean {
-  const relativePath = relative(parent, dir);
-  return !!relativePath && !/^..($|\/)/.test(relativePath) && !isAbsolute(relativePath);
-}
-
-export async function loadConfigAndHandleErrors(
-  options: {
-    configPath?: string;
-    customExtends?: string[];
-    processRawConfig?: RawConfigProcessor;
-    files?: string[];
-    region?: Region;
-  } = {}
-): Promise<Config | void> {
-  try {
-    return await loadConfig(options);
-  } catch (e) {
-    handleError(e, '');
-  }
-}
-
-export function sortTopLevelKeysForOas(
-  document: Oas3Definition | Oas2Definition
-): Oas3Definition | Oas2Definition {
-  if ('swagger' in document) {
-    return sortOas2Keys(document);
-  }
-  return sortOas3Keys(document as Oas3Definition);
-}
-
-function sortOas2Keys(document: Oas2Definition): Oas2Definition {
-  const orderedKeys = [
-    'swagger',
-    'info',
-    'host',
-    'basePath',
-    'schemes',
-    'consumes',
-    'produces',
-    'security',
-    'tags',
-    'externalDocs',
-    'paths',
-    'definitions',
-    'parameters',
-    'responses',
-    'securityDefinitions',
-  ];
-  const result: any = {};
-  for (const key of orderedKeys as (keyof Oas2Definition)[]) {
-    if (document.hasOwnProperty(key)) {
-      result[key] = document[key];
-    }
-  }
-  // merge any other top-level keys (e.g. vendor extensions)
-  return Object.assign(result, document);
-}
-function sortOas3Keys(document: Oas3Definition): Oas3Definition {
-  const orderedKeys = [
-    'openapi',
-    'info',
-    'jsonSchemaDialect',
-    'servers',
-    'security',
-    'tags',
-    'externalDocs',
-    'paths',
-    'webhooks',
-    'x-webhooks',
-    'components',
-  ];
-  const result: any = {};
-  for (const key of orderedKeys as (keyof Oas3Definition)[]) {
-    if (document.hasOwnProperty(key)) {
-      result[key] = document[key];
-    }
-  }
-  // merge any other top-level keys (e.g. vendor extensions)
-  return Object.assign(result, document);
-}
-
-export function checkIfRulesetExist(rules: typeof StyleguideConfig.prototype.rules) {
-  const ruleset = {
-    ...rules.oas2,
-    ...rules.oas3_0,
-    ...rules.oas3_1,
-    ...rules.async2,
-    ...rules.async3,
-    ...rules.arazzo1,
-  };
-
-  if (isEmptyObject(ruleset)) {
-    exitWithError(
-      '⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/'
-    );
-  }
-}
-
-export function cleanColors(input: string): string {
-  // eslint-disable-next-line no-control-regex
-  return input.replace(/\x1b\[\d+m/g, '');
-}
-
-export async function sendTelemetry(
-  argv: Arguments | undefined,
-  exit_code: ExitCode,
-  has_config: boolean | undefined,
-  spec_version: string | undefined,
-  spec_keyword: string | undefined,
-  spec_full_version: string | undefined
-): Promise<void> {
-  try {
-    if (!argv) {
-      return;
-    }
-    const {
-      _: [command],
-      $0: _,
-      ...args
-    } = argv;
-    const event_time = new Date().toISOString();
-    const redoclyClient = new RedoclyClient();
-    const { RedoclyOAuthClient } = await import('../auth/oauth-client');
-    const oauthClient = new RedoclyOAuthClient('redocly-cli', version);
-    const reuniteUrl = getReuniteUrl(argv.residency as string | undefined);
-    const logged_in = redoclyClient.hasTokens() || (await oauthClient.isAuthorized(reuniteUrl));
-    const data: Analytics = {
-      event: 'cli_command',
-      event_time,
-      logged_in: logged_in ? 'yes' : 'no',
-      command: `${command}`,
-      ...cleanArgs(args, process.argv.slice(2)),
-      node_version: process.version,
-      npm_version: execSync('npm -v').toString().replace('\n', ''),
-      os_platform: os.platform(),
-      version,
-      exit_code,
-      environment: process.env.REDOCLY_ENVIRONMENT,
-      environment_ci: process.env.CI,
-      has_config: has_config ? 'yes' : 'no',
-      spec_version,
-      spec_keyword,
-      spec_full_version,
-    };
-    const { otelTelemetry } = await import('../otel');
-    otelTelemetry.init();
-    otelTelemetry.send(data.command, data);
-  } catch (err) {
-    // Do nothing.
-  }
-}
-
-export type ExitCode = 0 | 1 | 2;
-
-export type Analytics = {
-  event: string;
-  event_time: string;
-  logged_in: 'yes' | 'no';
-  command: string;
-  arguments: string;
-  node_version: string;
-  npm_version: string;
-  os_platform: string;
-  version: string;
-  exit_code: ExitCode;
-  environment?: string;
-  environment_ci?: string;
-  raw_input: string;
-  has_config?: 'yes' | 'no';
-  spec_version?: string;
-  spec_keyword?: string;
-  spec_full_version?: string;
-};
-
-function isFile(value: string) {
-  return fs.existsSync(value) && fs.statSync(value).isFile();
-}
-
-function isDirectory(value: string) {
-  return fs.existsSync(value) && fs.statSync(value).isDirectory();
-}
-
-function cleanString(value: string): string {
-  if (!value) {
-    return value;
-  }
-  if (isAbsoluteUrl(value)) {
-    return value.split('://')[0] + '://url';
-  }
-  if (isFile(value)) {
-    return value.replace(/.+\.([^.]+)$/, (_, ext) => 'file-' + ext);
-  }
-  if (isDirectory(value)) {
-    return 'folder';
-  }
-  if (DESTINATION_REGEX.test(value)) {
-    return value.startsWith('@') ? '@organization/api-name@api-version' : 'api-name@api-version';
-  }
-  return value;
-}
-
-function replaceArgs(
-  commandInput: string,
-  targets: string | string[],
-  replacement: string
-): string {
-  const targetValues = Array.isArray(targets) ? targets : [targets];
-  for (const target of targetValues) {
-    commandInput = commandInput.replaceAll(target, replacement);
-  }
-  return commandInput;
-}
-
-export function cleanArgs(parsedArgs: CommandOptions, rawArgv: string[]) {
-  const KEYS_TO_CLEAN = ['organization', 'o', 'input', 'i', 'client-cert', 'client-key', 'ca-cert'];
-  let commandInput = rawArgv.join(' ');
-  const commandArguments: Record<string, string | string[]> = {};
-  for (const [key, value] of Object.entries(parsedArgs)) {
-    if (KEYS_TO_CLEAN.includes(key)) {
-      commandArguments[key] = '***';
-      commandInput = replaceArgs(commandInput, value, '***');
-    } else if (typeof value === 'string') {
-      const cleanedValue = cleanString(value);
-      commandArguments[key] = cleanedValue;
-      commandInput = replaceArgs(commandInput, value, cleanedValue);
-    } else if (Array.isArray(value)) {
-      commandArguments[key] = value.map(cleanString);
-      for (const replacedValue of value) {
-        const newValue = cleanString(replacedValue);
-        if (commandInput.includes(replacedValue)) {
-          commandInput = commandInput.replaceAll(replacedValue, newValue);
-        }
-      }
-    } else {
-      commandArguments[key] = value;
-    }
-  }
-
-  return { arguments: JSON.stringify(commandArguments), raw_input: commandInput };
-}
-
-export function checkForDeprecatedOptions<T>(argv: T, deprecatedOptions: Array<keyof T>) {
-  for (const option of deprecatedOptions) {
-    if (argv[option]) {
-      process.stderr.write(
-        yellow(
-          `[WARNING] "${String(
-            option
-          )}" option is deprecated and will be removed in a future release. \n\n`
-        )
-      );
-    }
-  }
-}
-
-export function notifyAboutIncompatibleConfigOptions(
-  themeOpenapiOptions: Record<string, unknown> | undefined
-) {
-  if (isPlainObject(themeOpenapiOptions)) {
-    const propertiesSet = Object.keys(themeOpenapiOptions);
-    const deprecatedSet = Object.keys(deprecatedRefDocsSchema.properties);
-    const intersection = propertiesSet.filter((prop) => deprecatedSet.includes(prop));
-    if (intersection.length > 0) {
-      process.stderr.write(
-        yellow(
-          `\n${pluralize('Property', intersection.length)} ${gray(
-            intersection.map((prop) => `'${prop}'`).join(', ')
-          )} ${pluralize(
-            'is',
-            intersection.length
-          )} only used in API Reference Docs and Redoc version 2.x or earlier.\n\n`
-        )
-      );
-    }
-  }
-}
-
-export function formatPath(path: string) {
-  if (isAbsoluteUrl(path)) {
-    return path;
-  }
-  return relative(process.cwd(), path);
-}