chore: update benchmarks, coverage threshold; improve types and names

benchmark/chart.mjs

@@ -15,7 +15,7 @@ const constructBarForChart = (x) => {
 };
 
 const output = [
-  '| CLI Version | Performance benchmark (test duration) |',
+  '| CLI Version | Performance benchmark (test duration diff) |',
   '|---|---|',
   ...arr.map(
     ([cliVersion, mean]) =>

benchmark/make-test-command.sh

@@ -6,7 +6,7 @@ set -eo pipefail # Fail on script errors
 git clone https://github.com/Rebilly/api-definitions.git
 
 # Store the command into a text file:
-echo hyperfine -i --warmup 3 $(cat package.json | jq '.dependencies' | jq 'keys' | jq 'map("'\''node node_modules/" + . + "/bin/cli.js lint api-definitions/openapi/openapi.yaml'\''")' | jq 'join(" ")' | xargs) --export-markdown benchmark_check.md --export-json benchmark_check.json > test-command.txt
+echo hyperfine -i --warmup 3 $(cat package.json | jq '.dependencies' | jq 'keys' | jq 'map("'\''node node_modules/" + . + "/bin/cli.js lint public@core --config=api-definitions/redocly.yaml'\''")' | jq 'join(" ")' | xargs) --export-markdown benchmark_check.md --export-json benchmark_check.json > test-command.txt
 
 # Put the command in the test section of the package.json:
 cat package.json | jq ".scripts.test = \"$(cat test-command.txt)\"" > package.json

benchmark/package.json

@@ -29,6 +29,10 @@
     "cli-1.19": "npm:@redocly/[email protected]",
     "cli-1.20": "npm:@redocly/[email protected]",
     "cli-1.21": "npm:@redocly/[email protected]",
+    "cli-1.22": "npm:@redocly/[email protected]",
+    "cli-1.23": "npm:@redocly/[email protected]",
+    "cli-1.24": "npm:@redocly/[email protected]",
+    "cli-1.25": "npm:@redocly/[email protected]",
     "cli-next": "file:../redocly-cli.tgz"
   }
 }

jest.config.js

@@ -13,15 +13,15 @@ module.exports = {
   coverageThreshold: {
     'packages/core/': {
       statements: 80,
-      branches: 71,
-      functions: 74,
+      branches: 72,
+      functions: 75,
       lines: 80,
     },
     'packages/cli/': {
-      statements: 60,
-      branches: 49,
-      functions: 60,
-      lines: 60,
+      statements: 63,
+      branches: 52,
+      functions: 63,
+      lines: 63,
     },
   },
   testMatch: ['**/__tests__/**/*.test.ts', '**/*.test.ts'],

packages/core/src/bundle.ts

@@ -398,7 +398,7 @@ function makeBundleVisitor(
       },
     },
     Root: {
-      enter(root: any, ctx: any) {
+      enter(root: any, ctx: UserContext) {
         rootLocation = ctx.location;
         if (version === SpecMajorVersion.OAS3) {
           components = root.components = root.components || {};
@@ -417,7 +417,7 @@ function makeBundleVisitor(
 
   if (version === SpecMajorVersion.OAS3) {
     visitor.DiscriminatorMapping = {
-      leave(mapping: Record<string, string>, ctx: any) {
+      leave(mapping: Record<string, string>, ctx: UserContext) {
         for (const name of Object.keys(mapping)) {
           const $ref = mapping[name];
           const resolved = ctx.resolve({ $ref });

packages/core/src/resolve.ts

@@ -126,7 +126,7 @@ export class BaseResolver {
         return new Source(absoluteRef, body, mimeType);
       } else {
         if (fs.lstatSync(absoluteRef).isDirectory()) {
-          throw new Error(`Expected a file but received a folder at ${absoluteRef}`);
+          throw new Error(`Expected a file but received a folder at ${absoluteRef}.`);
         }
         const content = await fs.promises.readFile(absoluteRef, 'utf-8');
         // In some cases file have \r\n line delimeters like on windows, we should skip it.
@@ -233,7 +233,7 @@ export async function resolveDocument(opts: {
 }): Promise<ResolvedRefMap> {
   const { rootDocument, externalRefResolver, rootType } = opts;
   const resolvedRefMap: ResolvedRefMap = new Map();
-  const seedNodes = new Set<string>(); // format "${type}::${absoluteRef}${pointer}"
+  const seenNodes = new Set<string>(); // format "${type}::${absoluteRef}${pointer}"
 
   const resolvePromises: Array<Promise<void>> = [];
   resolveRefsInParallel(rootDocument.parsed, rootDocument, '#/', rootType);
@@ -262,11 +262,11 @@ export async function resolveDocument(opts: {
       }
 
       const nodeId = `${type.name}::${nodeAbsoluteRef}`;
-      if (seedNodes.has(nodeId)) {
+      if (seenNodes.has(nodeId)) {
         return;
       }
 
-      seedNodes.add(nodeId);
+      seenNodes.add(nodeId);
 
       const [_, anchor] = Object.entries(node).find(([key]) => key === '$anchor') || [];
       if (anchor) {