@redocly/cli 1.34.4 → 2.0.0-next.0

package/src/utils/platform.ts

@@ -1,31 +0,0 @@
-/**
- * Sanitizes the input path by removing invalid characters.
- */
-export const sanitizePath = (input: string): string => {
-  return input.replace(/[^a-zA-Z0-9 ._\-:\\/@]/g, '');
-};
-
-/**
- * Sanitizes the input locale (ex. en-US) by removing invalid characters.
- */
-export const sanitizeLocale = (input: string): string => {
-  return input.replace(/[^a-zA-Z0-9@._-]/g, '');
-};
-
-/**
- * Retrieves platform-specific arguments and utilities.
- */
-export function getPlatformSpawnArgs() {
-  const isWindowsPlatform = process.platform === 'win32';
-  const npxExecutableName = isWindowsPlatform ? 'npx.cmd' : 'npx';
-
-  const sanitizeIfWindows = (input: string | undefined, sanitizer: (input: string) => string) => {
-    if (isWindowsPlatform && input) {
-      return sanitizer(input);
-    } else {
-      return input || '';
-    }
-  };
-
-  return { npxExecutableName, sanitize: sanitizeIfWindows, shell: isWindowsPlatform };
-}

package/src/utils/spinner.ts

@@ -1,50 +0,0 @@
-import * as process from 'process';
-
-const SPINNER_FRAMES = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'];
-
-export class Spinner {
-  private readonly frames: string[];
-  private currentFrame: number;
-  private intervalId: NodeJS.Timeout | null;
-  private message: string;
-
-  constructor() {
-    this.frames = SPINNER_FRAMES;
-    this.currentFrame = 0;
-    this.intervalId = null;
-    this.message = '';
-  }
-
-  private showFrame() {
-    process.stdout.write('\r' + this.frames[this.currentFrame] + ' ' + this.message);
-    this.currentFrame = (this.currentFrame + 1) % this.frames.length;
-  }
-
-  start(message: string) {
-    if (this.message === message) {
-      return;
-    }
-
-    this.message = message;
-    // If we're not in a TTY, don't display the spinner.
-    if (!process.stdout.isTTY) {
-      process.stdout.write(`${message}...\n`);
-      return;
-    }
-
-    if (this.intervalId === null) {
-      this.intervalId = setInterval(() => {
-        this.showFrame();
-      }, 100);
-    }
-  }
-
-  stop() {
-    if (this.intervalId !== null) {
-      clearInterval(this.intervalId);
-      this.intervalId = null;
-      process.stdout.write('\r');
-    }
-    this.message = '';
-  }
-}

package/src/utils/update-version-notifier.ts

@@ -1,115 +0,0 @@
-import { tmpdir } from 'os';
-import { join } from 'path';
-import { existsSync, writeFileSync, readFileSync, statSync } from 'fs';
-import { compare } from 'semver';
-import fetch, { DEFAULT_FETCH_TIMEOUT } from './fetch-with-timeout';
-import { cyan, green, yellow } from 'colorette';
-import { cleanColors } from './miscellaneous';
-
-export 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 ||
-  process.env.REDOCLY_SUPPRESS_UPDATE_NOTICE === 'true';
-
-export const notifyUpdateCliVersion = () => {
-  if (SHOULD_NOT_NOTIFY) {
-    return;
-  }
-  try {
-    const latestVersion = readFileSync(join(tmpdir(), VERSION_CACHE_FILE)).toString();
-
-    if (isNewVersionAvailable(version, latestVersion)) {
-      renderUpdateBanner(version, latestVersion);
-    }
-  } catch (e) {
-    return;
-  }
-};
-
-const isNewVersionAvailable = (current: string, latest: string) => compare(current, latest) < 0;
-
-const getLatestVersion = async (packageName: string): Promise<string | undefined> => {
-  const latestUrl = `http://registry.npmjs.org/${packageName}/latest`;
-
-  try {
-    const response = await fetch(latestUrl, { timeout: DEFAULT_FETCH_TIMEOUT });
-    const info = await response.json();
-
-    return info.version;
-  } catch {
-    // Do nothing
-    return;
-  }
-};
-
-export const cacheLatestVersion = () => {
-  if (!isNeedToBeCached() || SHOULD_NOT_NOTIFY) {
-    return;
-  }
-
-  getLatestVersion(name)
-    .then((version) => {
-      if (version) {
-        const lastCheckFile = join(tmpdir(), VERSION_CACHE_FILE);
-        writeFileSync(lastCheckFile, version);
-      }
-    })
-    .catch(() => {});
-};
-
-const renderUpdateBanner = (current: string, latest: string) => {
-  const messageLines = [
-    `A new version of ${cyan('Redocly CLI')} (${green(latest)}) is available.`,
-    `Update now: \`${cyan('npm i -g @redocly/cli@latest')}\`.`,
-    `Changelog: https://redocly.com/docs/cli/changelog/`,
-  ];
-  const maxLength = Math.max(...messageLines.map((line) => cleanColors(line).length));
-
-  const border = yellow('═'.repeat(maxLength + SPACE_TO_BORDER));
-  const extraSpaces = ' '.repeat(SPACE_TO_BORDER);
-
-  const banner = [
-    '',
-    extraSpaces + yellow('╔' + border + '╗'),
-    extraSpaces + yellow('║' + ' '.repeat(maxLength + SPACE_TO_BORDER) + '║'),
-    messageLines.map(getLineWithPadding(maxLength, extraSpaces)).join('\n'),
-    extraSpaces + yellow('║' + ' '.repeat(maxLength + SPACE_TO_BORDER) + '║'),
-    extraSpaces + yellow('╚' + border + '╝'),
-    '',
-    '',
-  ].join('\n');
-  process.stderr.write(banner);
-};
-
-const getLineWithPadding =
-  (maxLength: number, extraSpaces: string) =>
-  (line: string): string => {
-    const padding = ' '.repeat(maxLength - cleanColors(line).length);
-    return `${extraSpaces}${yellow('║')}  ${line}${padding}  ${yellow('║')}`;
-  };
-
-const isNeedToBeCached = (): boolean => {
-  try {
-    // Last version from npm is stored in a file in the OS temp folder
-    const versionFile = join(tmpdir(), VERSION_CACHE_FILE);
-
-    if (!existsSync(versionFile)) {
-      return true;
-    }
-
-    const now = new Date().getTime();
-    const stats = statSync(versionFile);
-    const lastCheck = stats.mtime.getTime();
-
-    return now - lastCheck >= INTERVAL_TO_CHECK;
-  } catch (e) {
-    return false;
-  }
-};

package/src/wrapper.ts

@@ -1,77 +0,0 @@
-import { detectSpec, doesYamlFileExist } from '@redocly/openapi-core';
-import { isPlainObject } from '@redocly/openapi-core/lib/utils';
-import { version } from './utils/update-version-notifier';
-import { exitWithError, loadConfigAndHandleErrors, sendTelemetry } from './utils/miscellaneous';
-import { lintConfigCallback } from './commands/lint';
-
-import type { Arguments } from 'yargs';
-import type { Config, Region } from '@redocly/openapi-core';
-import type { CollectFn } from '@redocly/openapi-core/lib/utils';
-import type { ExitCode } from './utils/miscellaneous';
-import type { CommandOptions } from './types';
-
-export type CommandArgs<T extends CommandOptions> = {
-  argv: T;
-  config: Config;
-  version: string;
-  collectSpecData?: CollectFn;
-};
-
-export function commandWrapper<T extends CommandOptions>(
-  commandHandler?: (wrapperArgs: CommandArgs<T>) => Promise<unknown>
-) {
-  return async (argv: Arguments<T>) => {
-    let code: ExitCode = 2;
-    let hasConfig;
-    let telemetry;
-    let specVersion: string | undefined;
-    let specKeyword: string | undefined;
-    let specFullVersion: string | undefined;
-    const collectSpecData: CollectFn = (document) => {
-      specVersion = detectSpec(document);
-      if (!isPlainObject(document)) return;
-      specKeyword = document?.openapi
-        ? 'openapi'
-        : document?.swagger
-        ? 'swagger'
-        : document?.asyncapi
-        ? 'asyncapi'
-        : document?.arazzo
-        ? 'arazzo'
-        : document?.overlay
-        ? 'overlay'
-        : undefined;
-      if (specKeyword) {
-        specFullVersion = document[specKeyword] as string;
-      }
-    };
-    try {
-      if (argv.config && !doesYamlFileExist(argv.config)) {
-        exitWithError('Please provide a valid path to the configuration file.');
-      }
-      const config: Config = (await loadConfigAndHandleErrors({
-        configPath: argv.config,
-        customExtends: argv.extends as string[] | undefined,
-        region: argv.region as Region,
-        files: argv.files as string[] | undefined,
-        processRawConfig: lintConfigCallback(argv as T & Record<string, undefined>, version),
-      })) as Config;
-      telemetry = config.telemetry;
-      hasConfig = !config.styleguide.recommendedFallback;
-      code = 1;
-      if (typeof commandHandler === 'function') {
-        await commandHandler({ argv, config, version, collectSpecData });
-      }
-      code = 0;
-    } catch (err) {
-      // Do nothing
-    } finally {
-      if (process.env.REDOCLY_TELEMETRY !== 'off' && telemetry !== 'off') {
-        await sendTelemetry(argv, code, hasConfig, specVersion, specKeyword, specFullVersion);
-      }
-      process.once('beforeExit', () => {
-        process.exit(code);
-      });
-    }
-  };
-}

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "lib"
-  },
-  "references": [{ "path": "../core" }, { "path": "../respect-core" }],
-  "exclude": ["lib"]
-}