@redocly/cli 1.0.0-beta.104 → 1.0.0-beta.107

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

@@ -1,12 +1,13 @@
 import { lint, bundle, getTotals, getMergedConfig } from '@redocly/openapi-core';
 
 import { handleBundle } from '../../commands/bundle';
+import { handleError } from '../../utils';
 import SpyInstance = jest.SpyInstance;
 
 jest.mock('@redocly/openapi-core');
 jest.mock('../../utils');
 
-(getMergedConfig as jest.Mock).mockImplementation(config => config)
+(getMergedConfig as jest.Mock).mockImplementation((config) => config);
 
 describe('bundle', () => {
   let processExitMock: SpyInstance;
@@ -24,35 +25,35 @@ describe('bundle', () => {
   afterEach(() => {
     (lint as jest.Mock).mockClear();
     (bundle as jest.Mock).mockClear();
-    (getTotals as jest.Mock).mockClear();
+    (getTotals as jest.Mock).mockReset();
   });
 
   it('bundles definitions w/o linting', async () => {
-    const entrypoints = ['foo.yaml', 'bar.yaml'];
+    const apis = ['foo.yaml', 'bar.yaml'];
 
     await handleBundle(
       {
-        entrypoints,
+        apis,
         ext: 'yaml',
         format: 'codeframe',
       },
-      '1.0.0',
+      '1.0.0'
     );
 
     expect(lint).toBeCalledTimes(0);
-    expect(bundle).toBeCalledTimes(entrypoints.length);
+    expect(bundle).toBeCalledTimes(apis.length);
   });
 
   it('exits with code 0 when bundles definitions', async () => {
-    const entrypoints = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
+    const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
 
     await handleBundle(
       {
-        entrypoints,
+        apis,
         ext: 'yaml',
         format: 'codeframe',
       },
-      '1.0.0',
+      '1.0.0'
     );
 
     exitCb?.();
@@ -60,33 +61,39 @@ describe('bundle', () => {
   });
 
   it('bundles definitions w/ linting', async () => {
-    const entrypoints = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
+    const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
+
+    (getTotals as jest.Mock).mockReturnValue({
+      errors: 0,
+      warnings: 0,
+      ignored: 0,
+    });
 
     await handleBundle(
       {
-        entrypoints,
+        apis,
         ext: 'yaml',
         format: 'codeframe',
         lint: true,
       },
-      '1.0.0',
+      '1.0.0'
     );
 
-    expect(lint).toBeCalledTimes(entrypoints.length);
-    expect(bundle).toBeCalledTimes(entrypoints.length);
+    expect(lint).toBeCalledTimes(apis.length);
+    expect(bundle).toBeCalledTimes(apis.length);
   });
 
   it('exits with code 0 when bundles definitions w/linting w/o errors', async () => {
-    const entrypoints = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
+    const apis = ['foo.yaml', 'bar.yaml', 'foobar.yaml'];
 
     await handleBundle(
       {
-        entrypoints,
+        apis,
         ext: 'yaml',
         format: 'codeframe',
         lint: true,
       },
-      '1.0.0',
+      '1.0.0'
     );
 
     exitCb?.();
@@ -94,27 +101,69 @@ describe('bundle', () => {
   });
 
   it('exits with code 1 when bundles definitions w/linting w/errors', async () => {
-    const entrypoints = ['foo.yaml'];
+    const apis = ['foo.yaml'];
 
     (getTotals as jest.Mock).mockReturnValue({
       errors: 1,
       warnings: 0,
-      ignored: 0
+      ignored: 0,
     });
 
     await handleBundle(
       {
-        entrypoints,
+        apis,
         ext: 'yaml',
         format: 'codeframe',
         lint: true,
       },
-      '1.0.0',
+      '1.0.0'
     );
 
-    expect(lint).toBeCalledTimes(entrypoints.length);
+    expect(lint).toBeCalledTimes(apis.length);
     exitCb?.();
     expect(processExitMock).toHaveBeenCalledWith(1);
   });
 
+  it('handleError is called when bundles an invalid definition', async () => {
+    const apis = ['invalid.json'];
+
+    (bundle as jest.Mock).mockImplementationOnce(() => {
+      throw new Error('Invalid definition');
+    });
+
+    await handleBundle(
+      {
+        apis,
+        ext: 'json',
+        format: 'codeframe',
+        lint: false,
+      },
+      '1.0.0'
+    );
+
+    expect(handleError).toHaveBeenCalledTimes(1);
+    expect(handleError).toHaveBeenCalledWith(new Error('Invalid definition'), 'invalid.json');
+  });
+
+  it("handleError isn't called when bundles a valid definition", async () => {
+    const apis = ['foo.yaml'];
+
+    (getTotals as jest.Mock).mockReturnValue({
+      errors: 0,
+      warnings: 0,
+      ignored: 0,
+    });
+
+    await handleBundle(
+      {
+        apis,
+        ext: 'yaml',
+        format: 'codeframe',
+        lint: false,
+      },
+      '1.0.0'
+    );
+
+    expect(handleError).toHaveBeenCalledTimes(0);
+  });
 });

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

@@ -10,38 +10,38 @@ describe('handleJoin fails', () => {
   colloreteYellowMock.mockImplementation((string: string) => string);
 
   it('should call exitWithError because only one entrypoint', async () => {
-    await handleJoin({ entrypoints: ['first.yaml'] }, 'cli-version');
-    expect(exitWithError).toHaveBeenCalledWith(`At least 2 entrypoints should be provided. \n\n`);
+    await handleJoin({ apis: ['first.yaml'] }, 'cli-version');
+    expect(exitWithError).toHaveBeenCalledWith(`At least 2 apis should be provided. \n\n`);
   });
 
   it('should call exitWithError because passed all 3 options for tags', async () => {
     await handleJoin(
       {
-        entrypoints: ['first.yaml', 'second.yaml'],
+        apis: ['first.yaml', 'second.yaml'],
         'prefix-tags-with-info-prop': 'something',
         'without-x-tag-groups': true,
         'prefix-tags-with-filename': true,
       },
-      'cli-version',
+      'cli-version'
     );
 
     expect(exitWithError).toHaveBeenCalledWith(
-      `You use prefix-tags-with-filename, prefix-tags-with-info-prop, without-x-tag-groups together.\nPlease choose only one! \n\n`,
+      `You use prefix-tags-with-filename, prefix-tags-with-info-prop, without-x-tag-groups together.\nPlease choose only one! \n\n`
     );
   });
 
   it('should call exitWithError because passed all 2 options for tags', async () => {
     await handleJoin(
       {
-        entrypoints: ['first.yaml', 'second.yaml'],
+        apis: ['first.yaml', 'second.yaml'],
         'without-x-tag-groups': true,
         'prefix-tags-with-filename': true,
       },
-      'cli-version',
+      'cli-version'
     );
 
     expect(exitWithError).toHaveBeenCalledWith(
-      `You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one! \n\n`,
+      `You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one! \n\n`
     );
   });
 });

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

@@ -5,12 +5,14 @@ import {
   lint,
   getTotals,
   formatProblems,
+  doesYamlFileExist,
 } from '@redocly/openapi-core';
 import {
-  getFallbackEntryPointsOrExit,
+  getFallbackApisOrExit,
   getExecutionTime,
   printUnusedWarnings,
   handleError,
+  exitWithError,
 } from '../../utils';
 import { ConfigFixture } from '../fixtures/config';
 import { performance } from 'perf_hooks';
@@ -20,7 +22,7 @@ jest.mock('../../utils');
 jest.mock('perf_hooks');
 
 const argvMock: LintOptions = {
-  entrypoints: ['openapi.yaml'],
+  apis: ['openapi.yaml'],
   'lint-config': 'off',
   format: 'codeframe',
 };
@@ -41,6 +43,9 @@ describe('handleLint', () => {
       return process.on(_e, cb);
     });
     getMergedConfigMock.mockReturnValue(ConfigFixture);
+    (doesYamlFileExist as jest.Mock<any, any>).mockImplementation(
+      (path) => path === 'redocly.yaml'
+    );
   });
 
   afterEach(() => {
@@ -48,18 +53,26 @@ describe('handleLint', () => {
   });
 
   describe('loadConfig and getEnrtypoints stage', () => {
-    it('shoul call loadConfig and getFallbackEntryPointsOrExit', async () => {
+    it('should fail if config file does not exist', async () => {
+      await handleLint({ ...argvMock, config: 'config.yaml' }, versionMock);
+      expect(exitWithError).toHaveBeenCalledWith(
+        'Please, provide valid path to the configuration file'
+      );
+      expect(loadConfig).toHaveBeenCalledTimes(0);
+    });
+
+    it('should call loadConfig and getFallbackApisOrExit', async () => {
       await handleLint(argvMock, versionMock);
       expect(loadConfig).toHaveBeenCalledWith(undefined, undefined, undefined);
-      expect(getFallbackEntryPointsOrExit).toHaveBeenCalled();
+      expect(getFallbackApisOrExit).toHaveBeenCalled();
     });
 
     it('should call loadConfig with args if such exist', async () => {
       await handleLint(
-        { ...argvMock, config: '/path/redocly.yaml', extends: ['some/path'] },
-        versionMock,
+        { ...argvMock, config: 'redocly.yaml', extends: ['some/path'] },
+        versionMock
       );
-      expect(loadConfig).toHaveBeenCalledWith('/path/redocly.yaml', ['some/path'], undefined);
+      expect(loadConfig).toHaveBeenCalledWith('redocly.yaml', ['some/path'], undefined);
     });
 
     it('should call mergedConfig with clear ignore if `generate-ignore-file` argv', async () => {
@@ -85,10 +98,10 @@ describe('handleLint', () => {
           'skip-rule': ['rule'],
           'generate-ignore-file': true,
         },
-        versionMock,
+        versionMock
       );
-      expect(ConfigFixture.lint.skipRules).toHaveBeenCalledWith(['rule']);
-      expect(ConfigFixture.lint.skipPreprocessors).toHaveBeenCalledWith(['preprocessor']);
+      expect(ConfigFixture.styleguide.skipRules).toHaveBeenCalledWith(['rule']);
+      expect(ConfigFixture.styleguide.skipPreprocessors).toHaveBeenCalledWith(['preprocessor']);
     });
 
     it('should call formatProblems and getExecutionTime with argv', async () => {
@@ -107,7 +120,7 @@ describe('handleLint', () => {
     it('should catch error in handleError if something fails', async () => {
       (lint as jest.Mock<any, any>).mockRejectedValueOnce('error');
       await handleLint(argvMock, versionMock);
-      expect(handleError).toHaveBeenCalledWith('error', '');
+      expect(handleError).toHaveBeenCalledWith('error', 'openapi.yaml');
     });
   });
 

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

@@ -29,7 +29,7 @@ describe('push-with-region', () => {
     redoclyClient.domain = 'redoc.ly';
     await handlePush({
       upsert: true,
-      entrypoint: 'spec.json',
+      api: 'spec.json',
       destination: '@org/my-api@1.0.0',
       branchName: 'test',
     });
@@ -41,7 +41,7 @@ describe('push-with-region', () => {
     redoclyClient.domain = 'eu.redocly.com';
     await handlePush({
       upsert: true,
-      entrypoint: 'spec.json',
+      api: 'spec.json',
       destination: '@org/my-api@1.0.0',
       branchName: 'test',
     });

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

@@ -1,11 +1,6 @@
 import { Config, getMergedConfig } from '@redocly/openapi-core';
 import { exitWithError } from '../../utils';
-import {
-  getApiEntrypoint,
-  getDestinationProps,
-  handlePush,
-  transformPush,
-} from '../../commands/push';
+import { getApiRoot, getDestinationProps, handlePush, transformPush } from '../../commands/push';
 
 jest.mock('fs');
 jest.mock('node-fetch', () => ({
@@ -29,10 +24,10 @@ describe('push', () => {
   it('pushes definition', async () => {
     await handlePush({
       upsert: true,
-      entrypoint: 'spec.json',
+      api: 'spec.json',
       destination: '@org/my-api@1.0.0',
       branchName: 'test',
-      'public': true,
+      public: true,
       'batch-id': '123',
       'batch-size': 2,
     });
@@ -56,10 +51,10 @@ describe('push', () => {
   it('fails if batchId value is an empty string', async () => {
     await handlePush({
       upsert: true,
-      entrypoint: 'spec.json',
+      api: 'spec.json',
       destination: '@org/my-api@1.0.0',
       branchName: 'test',
-      'public': true,
+      public: true,
       'batch-id': ' ',
       'batch-size': 2,
     });
@@ -70,10 +65,10 @@ describe('push', () => {
   it('fails if batchSize value is less than 2', async () => {
     await handlePush({
       upsert: true,
-      entrypoint: 'spec.json',
+      api: 'spec.json',
       destination: '@org/my-api@1.0.0',
       branchName: 'test',
-      'public': true,
+      public: true,
       'batch-id': '123',
       'batch-size': 1,
     });
@@ -86,23 +81,23 @@ describe('transformPush', () => {
   it('should adapt the existing syntax', () => {
     const cb = jest.fn();
     transformPush(cb)({
-      maybeEntrypointOrAliasOrDestination: 'openapi.yaml',
+      maybeApiOrDestination: 'openapi.yaml',
       maybeDestination: '@testing_org/main@v1',
     });
     expect(cb).toBeCalledWith({
-      entrypoint: 'openapi.yaml',
+      api: 'openapi.yaml',
       destination: '@testing_org/main@v1',
     });
   });
   it('should adapt the existing syntax (including branchName)', () => {
     const cb = jest.fn();
     transformPush(cb)({
-      maybeEntrypointOrAliasOrDestination: 'openapi.yaml',
+      maybeApiOrDestination: 'openapi.yaml',
       maybeDestination: '@testing_org/main@v1',
       maybeBranchName: 'other',
     });
     expect(cb).toBeCalledWith({
-      entrypoint: 'openapi.yaml',
+      api: 'openapi.yaml',
       destination: '@testing_org/main@v1',
       branchName: 'other',
     });
@@ -110,13 +105,13 @@ describe('transformPush', () => {
   it('should use --branch option firstly', () => {
     const cb = jest.fn();
     transformPush(cb)({
-      maybeEntrypointOrAliasOrDestination: 'openapi.yaml',
+      maybeApiOrDestination: 'openapi.yaml',
       maybeDestination: '@testing_org/main@v1',
       maybeBranchName: 'other',
       branch: 'priority-branch',
     });
     expect(cb).toBeCalledWith({
-      entrypoint: 'openapi.yaml',
+      api: 'openapi.yaml',
       destination: '@testing_org/main@v1',
       branchName: 'priority-branch',
     });
@@ -124,7 +119,7 @@ describe('transformPush', () => {
   it('should work for a destination only', () => {
     const cb = jest.fn();
     transformPush(cb)({
-      maybeEntrypointOrAliasOrDestination: '@testing_org/main@v1',
+      maybeApiOrDestination: '@testing_org/main@v1',
     });
     expect(cb).toBeCalledWith({
       destination: '@testing_org/main@v1',
@@ -133,12 +128,12 @@ describe('transformPush', () => {
   it('should accept aliases for the old syntax', () => {
     const cb = jest.fn();
     transformPush(cb)({
-      maybeEntrypointOrAliasOrDestination: 'alias',
+      maybeApiOrDestination: 'alias',
       maybeDestination: '@testing_org/main@v1',
     });
     expect(cb).toBeCalledWith({
       destination: '@testing_org/main@v1',
-      entrypoint: 'alias',
+      api: 'alias',
     });
   });
   it('should accept no arguments at all', () => {
@@ -171,7 +166,7 @@ describe('getDestinationProps', () => {
   });
 });
 
-describe('getApiEntrypoint', () => {
+describe('getApiRoot', () => {
   let config: Config = {
     apis: {
       'main@v1': {
@@ -183,9 +178,9 @@ describe('getApiEntrypoint', () => {
     },
   } 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');
+    expect(getApiRoot({ 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');
+    expect(getApiRoot({ name: 'main', version: 'latest', config })).toEqual('latest.yaml');
   });
 });

package/src/__tests__/fixtures/config.ts

@@ -1,6 +1,6 @@
 export const ConfigFixture = {
   configFile: null,
-  lint: {
+  styleguide: {
     addIgnore: jest.fn(),
     skipRules: jest.fn(),
     skipPreprocessors: jest.fn(),

package/src/__tests__/utils.test.ts

@@ -1,10 +1,9 @@
 import { Totals } from '@redocly/openapi-core';
-import { isSubdir, pathToFilename, printConfigLintTotals} from '../utils';
+import { isSubdir, pathToFilename, printConfigLintTotals } from '../utils';
 import { red, yellow } from 'colorette';
 
-
 jest.mock('os');
-jest.mock('colorette')
+jest.mock('colorette');
 
 describe('isSubdir', () => {
   it('can correctly determine if subdir', () => {
@@ -41,11 +40,10 @@ describe('isSubdir', () => {
   });
 
   afterEach(() => {
-    jest.resetModules()
-  })
+    jest.resetModules();
+  });
 });
 
-
 describe('pathToFilename', () => {
   it('should use correct path separator', () => {
     const processedPath = pathToFilename('/user/createWithList', '_');
@@ -53,7 +51,6 @@ describe('pathToFilename', () => {
   });
 });
 
-
 describe('printConfigLintTotals', () => {
   const totalProblemsMock: Totals = {
     errors: 1,
@@ -79,7 +76,7 @@ describe('printConfigLintTotals', () => {
   it('should print warnign and error', () => {
     printConfigLintTotals({ ...totalProblemsMock, warnings: 2 });
     expect(process.stderr.write).toHaveBeenCalledWith(
-      '❌ Your config has 1 error and 2 warnings.\n',
+      '❌ Your config has 1 error and 2 warnings.\n'
     );
     expect(redColoretteMocks).toHaveBeenCalledWith('❌ Your config has 1 error and 2 warnings.\n');
   });

package/src/commands/bundle.ts

@@ -3,70 +3,63 @@ import {
   getTotals,
   loadConfig,
   getMergedConfig,
-  OutputFormat,
   lint,
   bundle,
 } from '@redocly/openapi-core';
 import {
   dumpBundle,
   getExecutionTime,
-  getFallbackEntryPointsOrExit,
+  getFallbackApisOrExit,
   getOutputFileName,
   handleError,
   printUnusedWarnings,
   saveBundle,
   printLintTotals,
 } from '../utils';
-import { OutputExtensions, Totals } from '../types';
+import type { CommonOptions, OutputExtensions, Skips, 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[];
+export type BundleOptions = CommonOptions &
+  Skips & {
     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,
-) {
+  };
+
+export async function handleBundle(argv: BundleOptions, 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);
+    !config.rawConfig.styleguide?.decorators?.hasOwnProperty('remove-unused-components');
+  const apis = await getFallbackApisOrExit(argv.apis, config);
   const totals: Totals = { errors: 0, warnings: 0, ignored: 0 };
   const maxProblems = argv['max-problems'];
 
-  for (const { path, alias } of entrypoints) {
+  for (const { path, alias } of apis) {
     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']);
+      const { styleguide } = resolvedConfig;
+
+      styleguide.skipRules(argv['skip-rule']);
+      styleguide.skipPreprocessors(argv['skip-preprocessor']);
+      styleguide.skipDecorators(argv['skip-decorator']);
 
       if (argv.lint) {
-        if (config.lint.recommendedFallback) {
+        if (config.styleguide.recommendedFallback) {
           process.stderr.write(
             `No configurations were defined in extends -- using built in ${blue(
-              'recommended',
+              'recommended'
             )} configuration by default.\n${red(
-              'Warning! This default behavior is going to be deprecated soon.',
-            )}\n\n`,
+              'Warning! This default behavior is going to be deprecated soon.'
+            )}\n\n`
           );
         }
         const results = await lint({
@@ -103,12 +96,7 @@ export async function handleBundle(
       });
 
       const fileTotals = getTotals(problems);
-      const { outputFile, ext } = getOutputFileName(
-        path,
-        entrypoints.length,
-        argv.output,
-        argv.ext,
-      );
+      const { outputFile, ext } = getOutputFileName(path, apis.length, argv.output, argv.ext);
 
       if (fileTotals.errors === 0 || argv.force) {
         if (!argv.output) {
@@ -132,9 +120,9 @@ export async function handleBundle(
       });
 
       if (argv.metafile) {
-        if (entrypoints.length > 1) {
+        if (apis.length > 1) {
           process.stderr.write(
-            yellow(`[WARNING] "--metafile" cannot be used with multiple entrypoints. Skipping...`),
+            yellow(`[WARNING] "--metafile" cannot be used with multiple apis. Skipping...`)
           );
         }
         {
@@ -147,19 +135,19 @@ export async function handleBundle(
         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`,
+              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`,
+              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`,
+          `📦 Created a bundle for ${blue(path)} at ${blue(outputFile)} ${green(elapsed)}.\n`
         );
       }
 
@@ -172,7 +160,7 @@ export async function handleBundle(
     }
   }
 
-  printUnusedWarnings(config.lint);
+  printUnusedWarnings(config.styleguide);
 
   // defer process exit to allow STDOUT pipe to flush
   // see https://github.com/nodejs/node-v0.x-archive/issues/3737#issuecomment-19156072