@redocly/cli 1.0.0-beta.99 → 1.0.0-rc.2

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

@@ -1,120 +0,0 @@
-import { lint, bundle, getTotals, getMergedConfig } from '@redocly/openapi-core';
-
-import { handleBundle } from '../../commands/bundle';
-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).mockClear();
-  });
-
-  it('bundles definitions w/o linting', async () => {
-    const entrypoints = ['foo.yaml', 'bar.yaml'];
-
-    await handleBundle(
-      {
-        entrypoints,
-        ext: 'yaml',
-        format: 'codeframe',
-      },
-      '1.0.0',
-    );
-
-    expect(lint).toBeCalledTimes(0);
-    expect(bundle).toBeCalledTimes(entrypoints.length);
-  });
-
-  it('exits with code 0 when bundles definitions', async () => {
-    const entrypoints = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-
-    await handleBundle(
-      {
-        entrypoints,
-        ext: 'yaml',
-        format: 'codeframe',
-      },
-      '1.0.0',
-    );
-
-    exitCb?.();
-    expect(processExitMock).toHaveBeenCalledWith(0);
-  });
-
-  it('bundles definitions w/ linting', async () => {
-    const entrypoints = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-
-    await handleBundle(
-      {
-        entrypoints,
-        ext: 'yaml',
-        format: 'codeframe',
-        lint: true,
-      },
-      '1.0.0',
-    );
-
-    expect(lint).toBeCalledTimes(entrypoints.length);
-    expect(bundle).toBeCalledTimes(entrypoints.length);
-  });
-
-  it('exits with code 0 when bundles definitions w/linting w/o errors', async () => {
-    const entrypoints = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
-
-    await handleBundle(
-      {
-        entrypoints,
-        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 entrypoints = ['foo.yaml'];
-
-    (getTotals as jest.Mock).mockReturnValue({
-      errors: 1,
-      warnings: 0,
-      ignored: 0
-    });
-
-    await handleBundle(
-      {
-        entrypoints,
-        ext: 'yaml',
-        format: 'codeframe',
-        lint: true,
-      },
-      '1.0.0',
-    );
-
-    expect(lint).toBeCalledTimes(entrypoints.length);
-    exitCb?.();
-    expect(processExitMock).toHaveBeenCalledWith(1);
-  });
-
-});

package/src/__tests__/commands/push-region.test.ts

@@ -1,51 +0,0 @@
-import { getMergedConfig } from '@redocly/openapi-core';
-import { handlePush } from '../../commands/push';
-import { promptClientToken } from '../../commands/login';
-
-jest.mock('fs');
-jest.mock('node-fetch', () => ({
-  default: jest.fn(() => ({
-    ok: true,
-    json: jest.fn().mockResolvedValue({}),
-  })),
-}));
-jest.mock('@redocly/openapi-core');
-jest.mock('../../commands/login');
-jest.mock('../../utils');
-
-(getMergedConfig as jest.Mock).mockImplementation((config) => config);
-
-const mockPromptClientToken = promptClientToken as jest.MockedFunction<typeof promptClientToken>;
-
-describe('push-with-region', () => {
-  const redoclyClient = require('@redocly/openapi-core').__redoclyClient;
-  redoclyClient.isAuthorizedWithRedoclyByRegion = jest.fn().mockResolvedValue(false);
-
-  beforeAll(() => {
-    jest.spyOn(process.stdout, 'write').mockImplementation(() => true);
-  });
-
-  it('should call login with default domain when region is US', async () => {
-    redoclyClient.domain = 'redoc.ly';
-    await handlePush({
-      upsert: true,
-      entrypoint: 'spec.json',
-      destination: '@org/my-api@1.0.0',
-      branchName: 'test',
-    });
-    expect(mockPromptClientToken).toBeCalledTimes(1);
-    expect(mockPromptClientToken).toHaveBeenCalledWith(redoclyClient.domain);
-  });
-
-  it('should call login with EU domain when region is EU', async () => {
-    redoclyClient.domain = 'eu.redocly.com';
-    await handlePush({
-      upsert: true,
-      entrypoint: 'spec.json',
-      destination: '@org/my-api@1.0.0',
-      branchName: 'test',
-    });
-    expect(mockPromptClientToken).toBeCalledTimes(1);
-    expect(mockPromptClientToken).toHaveBeenCalledWith(redoclyClient.domain);
-  });
-});

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

@@ -1,158 +0,0 @@
-import { Config, getMergedConfig } from '@redocly/openapi-core';
-import {
-  getApiEntrypoint,
-  getDestinationProps,
-  handlePush,
-  transformPush,
-} from '../../commands/push';
-
-jest.mock('fs');
-jest.mock('node-fetch', () => ({
-  default: jest.fn(() => ({
-    ok: true,
-    json: jest.fn().mockResolvedValue({}),
-  })),
-}));
-jest.mock('@redocly/openapi-core');
-jest.mock('../../utils');
-
-(getMergedConfig as jest.Mock).mockImplementation((config) => config);
-
-describe('push', () => {
-  const redoclyClient = require('@redocly/openapi-core').__redoclyClient;
-
-  beforeEach(() => {
-    jest.spyOn(process.stdout, 'write').mockImplementation(() => true);
-  });
-
-  it('pushes definition', async () => {
-    await handlePush({
-      upsert: true,
-      entrypoint: 'spec.json',
-      destination: '@org/my-api@1.0.0',
-      branchName: 'test',
-      'public': true
-    });
-
-    expect(redoclyClient.registryApi.prepareFileUpload).toBeCalledTimes(1);
-    expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
-    expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
-      branch: 'test',
-      filePaths: ['filePath'],
-      isUpsert: true,
-      isPublic: true,
-      name: 'my-api',
-      organizationId: 'org',
-      rootFilePath: 'filePath',
-      version: '1.0.0',
-    });
-  });
-});
-
-describe('transformPush', () => {
-  it('should adapt the existing syntax', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      maybeEntrypointOrAliasOrDestination: 'openapi.yaml',
-      maybeDestination: '@testing_org/main@v1',
-    });
-    expect(cb).toBeCalledWith({
-      entrypoint: 'openapi.yaml',
-      destination: '@testing_org/main@v1',
-    });
-  });
-  it('should adapt the existing syntax (including branchName)', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      maybeEntrypointOrAliasOrDestination: 'openapi.yaml',
-      maybeDestination: '@testing_org/main@v1',
-      maybeBranchName: 'other',
-    });
-    expect(cb).toBeCalledWith({
-      entrypoint: 'openapi.yaml',
-      destination: '@testing_org/main@v1',
-      branchName: 'other',
-    });
-  });
-  it('should use --branch option firstly', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      maybeEntrypointOrAliasOrDestination: 'openapi.yaml',
-      maybeDestination: '@testing_org/main@v1',
-      maybeBranchName: 'other',
-      branch: 'priority-branch',
-    });
-    expect(cb).toBeCalledWith({
-      entrypoint: 'openapi.yaml',
-      destination: '@testing_org/main@v1',
-      branchName: 'priority-branch',
-    });
-  });
-  it('should work for a destination only', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      maybeEntrypointOrAliasOrDestination: '@testing_org/main@v1',
-    });
-    expect(cb).toBeCalledWith({
-      destination: '@testing_org/main@v1',
-    });
-  });
-  it('should accept aliases for the old syntax', () => {
-    const cb = jest.fn();
-    transformPush(cb)({
-      maybeEntrypointOrAliasOrDestination: 'alias',
-      maybeDestination: '@testing_org/main@v1',
-    });
-    expect(cb).toBeCalledWith({
-      destination: '@testing_org/main@v1',
-      entrypoint: 'alias',
-    });
-  });
-  it('should accept no arguments at all', () => {
-    const cb = jest.fn();
-    transformPush(cb)({});
-    expect(cb).toBeCalledWith({});
-  });
-});
-
-describe('getDestinationProps', () => {
-  it('should get valid destination props for the full destination syntax', () => {
-    expect(getDestinationProps('@testing_org/main@v1', 'org-from-config')).toEqual([
-      'testing_org',
-      'main',
-      'v1',
-    ]);
-  });
-  it('should fallback the organizationId from a config for the short destination syntax', () => {
-    expect(getDestinationProps('main@v1', 'org-from-config')).toEqual([
-      'org-from-config',
-      'main',
-      'v1',
-    ]);
-  });
-  it('should fallback the organizationId from a config if no destination provided', () => {
-    expect(getDestinationProps(undefined, 'org-from-config')).toEqual(['org-from-config']);
-  });
-  it('should return empty organizationId if there is no one found', () => {
-    expect(getDestinationProps('main@v1', undefined)).toEqual([, 'main', 'v1']);
-  });
-});
-
-describe('getApiEntrypoint', () => {
-  let config: Config = {
-    apis: {
-      'main@v1': {
-        root: 'openapi.yaml',
-      },
-      main: {
-        root: 'latest.yaml',
-      },
-    },
-  } as unknown as Config;
-  it('should resolve the correct api for a valid name & version', () => {
-    expect(getApiEntrypoint({ name: 'main', version: 'v1', config })).toEqual('openapi.yaml');
-  });
-  it('should resolve the latest version of api if there is no matching version', () => {
-    expect(getApiEntrypoint({ name: 'main', version: 'latest', config })).toEqual('latest.yaml');
-  });
-});

package/src/__tests__/utils.test.ts

@@ -1,50 +0,0 @@
-import { isSubdir, pathToFilename } from '../utils';
-
-jest.mock("os");
-
-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');
-  });
-});

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/bundle.ts

@@ -1,180 +0,0 @@
-import {
-  formatProblems,
-  getTotals,
-  loadConfig,
-  getMergedConfig,
-  OutputFormat,
-  lint,
-  bundle,
-} from '@redocly/openapi-core';
-import {
-  dumpBundle,
-  getExecutionTime,
-  getFallbackEntryPointsOrExit,
-  getOutputFileName,
-  handleError,
-  printUnusedWarnings,
-  saveBundle,
-  printLintTotals,
-} from '../utils';
-import { OutputExtensions, Totals } from '../types';
-import { performance } from 'perf_hooks';
-import { blue, gray, green, red, yellow } from 'colorette';
-import { writeFileSync } from 'fs';
-
-export async function handleBundle(
-  argv: {
-    entrypoints: string[];
-    output?: string;
-    ext: OutputExtensions;
-    'max-problems'?: number;
-    'skip-rule'?: string[];
-    'skip-preprocessor'?: string[];
-    'skip-decorator'?: string[];
-    dereferenced?: boolean;
-    force?: boolean;
-    config?: string;
-    lint?: boolean;
-    format: OutputFormat;
-    metafile?: string;
-    extends?: string[];
-    'remove-unused-components'?: boolean;
-    'keep-url-references'?: boolean;
-  },
-  version: string,
-) {
-  const config = await loadConfig(argv.config, argv.extends);
-  const removeUnusedComponents =
-    argv['remove-unused-components'] &&
-    !config.rawConfig.lint?.decorators?.hasOwnProperty('remove-unused-components');
-  const entrypoints = await getFallbackEntryPointsOrExit(argv.entrypoints, config);
-  const totals: Totals = { errors: 0, warnings: 0, ignored: 0 };
-  const maxProblems = argv['max-problems'];
-
-  for (const { path, alias } of entrypoints) {
-    try {
-      const startedAt = performance.now();
-      const resolvedConfig = getMergedConfig(config, alias);
-      resolvedConfig.lint.skipRules(argv['skip-rule']);
-      resolvedConfig.lint.skipPreprocessors(argv['skip-preprocessor']);
-      resolvedConfig.lint.skipDecorators(argv['skip-decorator']);
-
-      if (argv.lint) {
-        if (config.lint.recommendedFallback) {
-          process.stderr.write(
-            `No configurations were defined in extends -- using built in ${blue(
-              'recommended',
-            )} configuration by default.\n${red(
-              'Warning! This default behavior is going to be deprecated soon.',
-            )}\n\n`,
-          );
-        }
-        const results = await lint({
-          ref: path,
-          config: resolvedConfig,
-        });
-        const fileLintTotals = getTotals(results);
-
-        totals.errors += fileLintTotals.errors;
-        totals.warnings += fileLintTotals.warnings;
-        totals.ignored += fileLintTotals.ignored;
-
-        formatProblems(results, {
-          format: argv.format || 'codeframe',
-          totals: fileLintTotals,
-          version,
-          maxProblems,
-        });
-        printLintTotals(fileLintTotals, 2);
-      }
-
-      process.stderr.write(gray(`bundling ${path}...\n`));
-
-      const {
-        bundle: result,
-        problems,
-        ...meta
-      } = await bundle({
-        config: resolvedConfig,
-        ref: path,
-        dereference: argv.dereferenced,
-        removeUnusedComponents,
-        keepUrlRefs: argv['keep-url-references'],
-      });
-
-      const fileTotals = getTotals(problems);
-      const { outputFile, ext } = getOutputFileName(
-        path,
-        entrypoints.length,
-        argv.output,
-        argv.ext,
-      );
-
-      if (fileTotals.errors === 0 || argv.force) {
-        if (!argv.output) {
-          const output = dumpBundle(result.parsed, argv.ext || 'yaml', argv.dereferenced);
-          process.stdout.write(output);
-        } else {
-          const output = dumpBundle(result.parsed, ext, argv.dereferenced);
-          saveBundle(outputFile, output);
-        }
-      }
-
-      totals.errors += fileTotals.errors;
-      totals.warnings += fileTotals.warnings;
-      totals.ignored += fileTotals.ignored;
-
-      formatProblems(problems, {
-        format: argv.format,
-        maxProblems,
-        totals: fileTotals,
-        version,
-      });
-
-      if (argv.metafile) {
-        if (entrypoints.length > 1) {
-          process.stderr.write(
-            yellow(`[WARNING] "--metafile" cannot be used with multiple entrypoints. Skipping...`),
-          );
-        }
-        {
-          writeFileSync(argv.metafile, JSON.stringify(meta), 'utf-8');
-        }
-      }
-
-      const elapsed = getExecutionTime(startedAt);
-      if (fileTotals.errors > 0) {
-        if (argv.force) {
-          process.stderr.write(
-            `❓ Created a bundle for ${blue(path)} at ${blue(outputFile)} with errors ${green(
-              elapsed,
-            )}.\n${yellow('Errors ignored because of --force')}.\n`,
-          );
-        } else {
-          process.stderr.write(
-            `❌ Errors encountered while bundling ${blue(
-              path,
-            )}: bundle not created (use --force to ignore errors).\n`,
-          );
-        }
-      } else {
-        process.stderr.write(
-          `📦 Created a bundle for ${blue(path)} at ${blue(outputFile)} ${green(elapsed)}.\n`,
-        );
-      }
-
-      const removedCount = meta.visitorsData?.['remove-unused-components']?.removedCount;
-      if (removedCount) {
-        process.stderr.write(gray(`🧹 Removed ${removedCount} unused components.\n`));
-      }
-    } catch (e) {
-      handleError(e, path);
-    }
-  }
-
-  printUnusedWarnings(config.lint);
-
-  // defer process exit to allow STDOUT pipe to flush
-  // see https://github.com/nodejs/node-v0.x-archive/issues/3737#issuecomment-19156072
-  process.once('exit', () => process.exit(totals.errors === 0 || argv.force ? 0 : 1));
-}