chore: export an util function from openapi-core and move update-registry rule to decorators (#268)

__mocks__/@redocly/openapi-core.ts

@@ -14,3 +14,4 @@ export const __redoclyClient = {
 export const RedoclyClient = jest.fn(() => __redoclyClient);
 export const loadConfig = jest.fn(() => ({ configFile: null }));
 export const bundle = jest.fn(() => ({ bundle: { parsed: null }, problems: null }));
+export const getTotals = jest.fn(() => ({ errors: 0 }));

packages/cli/src/commands/bundle.ts

@@ -1,30 +1,32 @@
-import { bundle, formatProblems, loadConfig, OutputFormat } from '@redocly/openapi-core';
+import { bundle, formatProblems, getTotals, loadConfig, OutputFormat } from '@redocly/openapi-core';
 import {
   dumpBundle,
   getExecutionTime,
   getFallbackEntryPointsOrExit,
   getOutputFileName,
-  getTotals, handleError, printUnusedWarnings,
+  handleError,
+  printUnusedWarnings,
   saveBundle,
 } from '../utils';
 import { OutputExtensions, Totals } from '../types';
-import { performance } from "perf_hooks";
+import { performance } from 'perf_hooks';
 import { blue, gray, green, yellow } from 'colorette';
 
-export async function handleBundle (argv: {
+export async function handleBundle(
-  entrypoints: string[];
+  argv: {
-  output?: string;
+    entrypoints: string[];
-  ext: OutputExtensions;
+    output?: string;
-  'max-problems'?: number;
+    ext: OutputExtensions;
-  'skip-rule'?: string[];
+    'max-problems'?: number;
-  'skip-preprocessor'?: string[];
+    'skip-rule'?: string[];
-  'skip-decorator'?: string[];
+    'skip-preprocessor'?: string[];
-  dereferenced?: boolean;
+    'skip-decorator'?: string[];
-  force?: boolean;
+    dereferenced?: boolean;
-  config?: string;
+    force?: boolean;
-  format: OutputFormat;
+    config?: string;
-},
+    format: OutputFormat;
-version: string
+  },
+  version: string,
 ) {
   const config = await loadConfig(argv.config);
   config.lint.skipRules(argv['skip-rule']);
@@ -76,11 +78,9 @@ version: string
       if (fileTotals.errors > 0) {
         if (argv.force) {
           process.stderr.write(
-            `❓ Created a bundle for ${blue(entrypoint)} at ${blue(
+            `❓ Created a bundle for ${blue(entrypoint)} at ${blue(outputFile)} with errors ${green(
-              outputFile,
+              elapsed,
-            )} with errors ${green(elapsed)}.\n${yellow(
+            )}.\n${yellow('Errors ignored because of --force')}.\n`,
-              'Errors ignored because of --force',
-            )}.\n`,
           );
         } else {
           process.stderr.write(
@@ -91,9 +91,7 @@ version: string
         }
       } else {
         process.stderr.write(
-          `📦 Created a bundle for ${blue(entrypoint)} at ${blue(outputFile)} ${green(
+          `📦 Created a bundle for ${blue(entrypoint)} at ${blue(outputFile)} ${green(elapsed)}.\n`,
-            elapsed,
-          )}.\n`,
         );
       }
     } catch (e) {

packages/cli/src/commands/join.ts

@@ -12,13 +12,13 @@ import {
   Oas3Tag,
   loadConfig,
   formatProblems,
+  getTotals,
   lintDocument,
   detectOpenAPI,
 } from '@redocly/openapi-core';
 
 import {
   getFallbackEntryPointsOrExit,
-  getTotals,
   printExecutionTime,
   handleError,
   printLintTotals,

packages/cli/src/commands/lint.ts

@@ -1,28 +1,35 @@
-import { Config, formatProblems, lint, loadConfig, OutputFormat } from '@redocly/openapi-core';
+import {
+  Config,
+  formatProblems,
+  getTotals,
+  lint,
+  loadConfig,
+  OutputFormat,
+} from '@redocly/openapi-core';
 import {
   getExecutionTime,
   getFallbackEntryPointsOrExit,
-  getTotals,
   handleError,
   pluralize,
   printLintTotals,
-  printUnusedWarnings
+  printUnusedWarnings,
 } from '../utils';
 import { Totals } from '../types';
 import { blue, gray } from 'colorette';
-import { performance } from "perf_hooks";
+import { performance } from 'perf_hooks';
 
-export async function handleLint (argv: {
+export async function handleLint(
-  entrypoints: string[];
+  argv: {
-  'max-problems'?: number;
+    entrypoints: string[];
-  'generate-ignore-file'?: boolean;
+    'max-problems'?: number;
-  'skip-rule'?: string[];
+    'generate-ignore-file'?: boolean;
-  'skip-preprocessor'?: string[];
+    'skip-rule'?: string[];
-  extends?: string[];
+    'skip-preprocessor'?: string[];
-  config?: string;
+    extends?: string[];
-  format: OutputFormat;
+    config?: string;
-},
+    format: OutputFormat;
-  version: string
+  },
+  version: string,
 ) {
   const config: Config = await loadConfig(argv.config, argv.extends);
   config.lint.skipRules(argv['skip-rule']);
@@ -35,7 +42,9 @@ export async function handleLint (argv: {
   let totalIgnored = 0;
   if (config.lint.recommendedFallback) {
     process.stderr.write(
-      `No configurations were defined in extends -- using built in ${blue('recommended')} configuration by default.\n\n`,
+      `No configurations were defined in extends -- using built in ${blue(
+        'recommended',
+      )} configuration by default.\n\n`,
     );
   }
 
@@ -64,7 +73,7 @@ export async function handleLint (argv: {
           format: argv.format,
           maxProblems: argv['max-problems'],
           totals: fileTotals,
-          version
+          version,
         });
       }
 

packages/cli/src/commands/preview-docs/index.ts

@@ -1,7 +1,7 @@
 import * as colorette from 'colorette';
 import * as chockidar from 'chokidar';
-import { bundle, loadConfig, ResolveError, YamlParseError, RedoclyClient } from "@redocly/openapi-core";
+import { bundle, loadConfig, ResolveError, YamlParseError, RedoclyClient, getTotals } from "@redocly/openapi-core";
-import { getFallbackEntryPointsOrExit, getTotals } from '../../utils';
+import { getFallbackEntryPointsOrExit } from '../../utils';
 import startPreviewServer from './preview-server/preview-server';
 
 export async function previewDocs(argv: {

packages/cli/src/commands/push.ts

@@ -5,13 +5,12 @@ import { performance } from 'perf_hooks';
 import { yellow, green, blue } from 'colorette';
 import { createHash } from 'crypto';
 
-import { bundle, Config, loadConfig, RedoclyClient, IGNORE_FILE, BundleOutputFormat } from '@redocly/openapi-core';
+import { bundle, Config, loadConfig, RedoclyClient, IGNORE_FILE, BundleOutputFormat, getTotals } from '@redocly/openapi-core';
 import {
   promptUser,
   exitWithError,
   printExecutionTime,
   getFallbackEntryPointsOrExit,
-  getTotals,
   pluralize,
   dumpBundle,
   slash

packages/cli/src/utils.ts

@@ -11,7 +11,6 @@ import {
   BundleOutputFormat,
   Config,
   LintConfig,
-  NormalizedProblem,
   ResolveError,
   YamlParseError,
 } from '@redocly/openapi-core';
@@ -50,27 +49,6 @@ async function expandGlobsInEntrypoints(args: string[], config: Config) {
   }))).flat();
 }
 
-export function getTotals(problems: (NormalizedProblem & { ignored?: boolean })[]): Totals {
-  let errors = 0;
-  let warnings = 0;
-  let ignored = 0;
-
-  for (const m of problems) {
-    if (m.ignored) {
-      ignored++;
-      continue;
-    }
-    if (m.severity === 'error') errors++;
-    if (m.severity === 'warn') warnings++;
-  }
-
-  return {
-    errors,
-    warnings,
-    ignored,
-  };
-}
-
 export function getExecutionTime(startedAt: number) {
   return process.env.NODE_ENV === 'test'
     ? '<test>ms'

packages/core/src/config/builtIn.ts

@@ -7,4 +7,7 @@ export const builtInConfigs: Record<string, LintRawConfig> = {
   recommended,
   minimal,
   all,
+  'redocly-registry': {
+    decorators: { 'registry-dependencies': 'on' }
+  }
 };

packages/core/src/format/format.ts

@@ -10,16 +10,17 @@ import {
   red,
 } from 'colorette';
 
+const coreVersion = require('../../package.json').version;
+
 import { NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject } from '../walk';
 import { getCodeframe, getLineColLocation } from './codeframes';
 
-type Totals = {
+export type Totals = {
 	errors: number;
 	warnings: number;
 	ignored: number;
 }
 
-
 const ERROR_MESSAGE = {
   INVALID_SEVERITY_LEVEL: 'Invalid severity level; accepted values: error or warn',
 };
@@ -47,6 +48,27 @@ function severityToNumber(severity: ProblemSeverity) {
 
 export type OutputFormat = 'codeframe' | 'stylish' | 'json';
 
+export function getTotals(problems: (NormalizedProblem & { ignored?: boolean })[]): Totals {
+  let errors = 0;
+  let warnings = 0;
+  let ignored = 0;
+
+  for (const m of problems) {
+    if (m.ignored) {
+      ignored++;
+      continue;
+    }
+    if (m.severity === 'error') errors++;
+    if (m.severity === 'warn') warnings++;
+  }
+
+  return {
+    errors,
+    warnings,
+    ignored,
+  };
+}
+
 export function formatProblems(
   problems: (NormalizedProblem & { ignored?: boolean })[],
   opts: {
@@ -54,7 +76,7 @@ export function formatProblems(
     cwd?: string;
     format?: OutputFormat;
     color?: boolean;
-    totals: Totals;
+    totals: Totals
     version: string;
   },
 ) {
@@ -63,8 +85,8 @@ export function formatProblems(
     cwd = process.cwd(),
     format = 'codeframe',
     color = colorOptions.enabled,
-    totals,
+    totals = getTotals(problems),
-    version
+    version = coreVersion,
   } = opts;
 
   colorOptions.enabled = color; // force colors if specified

packages/core/src/index.ts

@@ -15,6 +15,6 @@ export { detectOpenAPI, OasMajorVersion, openAPIMajor } from './lint';
 export { normalizeVisitors } from './visitors';
 export { WalkContext, walkDocument, NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject, Loc } from './walk';
 
-export { formatProblems, OutputFormat } from './format/format';
+export { formatProblems, OutputFormat, getTotals, Totals } from './format/format';
 export { OasVersion, lint, lint as validate, lintDocument } from './lint';
 export { bundle } from './bundle';

packages/core/src/rules/common/registry-dependencies.ts

@@ -1,8 +1,8 @@
 import { RedoclyClient } from '../../redocly';
 
-import { Oas3Rule, Oas2Rule } from '../../visitors';
+import { Oas3Decorator, Oas2Decorator } from '../../visitors';
 
-export const RegistryDependencies: Oas3Rule | Oas2Rule = () => {
+export const RegistryDependencies: Oas3Decorator | Oas2Decorator = () => {
   let redoclyClient: RedoclyClient;
   let registryDependencies = new Set<string>();
 

packages/core/src/rules/oas2/index.ts

@@ -24,7 +24,7 @@ import { OperationSingularTag } from '../common/operation-singular-tag';
 import { OperationSecurityDefined } from '../common/operation-security-defined';
 import { NoUnresolvedRefs } from '../no-unresolved-refs';
 import { PathHttpVerbsOrder } from '../common/path-http-verbs-order';
-import { Oas2Rule } from '../../visitors';
+import { Oas2Decorator, Oas2Rule } from '../../visitors';
 import { RegistryDependencies } from '../common/registry-dependencies';
 import { NoIdenticalPaths } from '../common/no-identical-paths';
 import { OperationOperationId } from '../common/operation-operationId';
@@ -69,9 +69,10 @@ export const rules = {
 
   'path-http-verbs-order': PathHttpVerbsOrder as Oas2Rule,
 
-  'registry-dependencies': RegistryDependencies as Oas2Rule,
   spec: OasSpec as Oas2Rule,
 };
 
 export const preprocessors = {};
-export const decorators = {};
+export const decorators = {
+  'registry-dependencies': RegistryDependencies as Oas2Decorator,
+};

packages/core/src/rules/oas3/index.ts

@@ -38,6 +38,8 @@ import { OperationOperationId } from '../common/operation-operationId';
 import { OperationSummary } from '../common/operation-summary';
 import { NoAmbiguousPaths } from '../common/no-ambiguous-paths';
 
+import { Oas3Decorator } from '../../visitors';
+
 export const rules = {
   'info-description': InfoDescription,
   'info-contact': InfoContact,
@@ -72,7 +74,6 @@ export const rules = {
   'boolean-parameter-prefixes': BooleanParameterPrefixes,
   'path-http-verbs-order': PathHttpVerbsOrder,
   'no-invalid-media-type-examples': ValidContentExamples,
-  'registry-dependencies': RegistryDependencies,
   'no-identical-paths': NoIdenticalPaths,
   'no-ambiguous-paths': NoAmbiguousPaths,
   'no-undefined-server-variable': NoUndefinedServerVariable,
@@ -81,4 +82,6 @@ export const rules = {
 
 export const preprocessors = {};
 
-export const decorators = {};
+export const decorators = {
+  'registry-dependencies': RegistryDependencies as Oas3Decorator,
+};