feat: add vendor extensions metric with per-extension counts

.changeset/olive-donkeys-shave.md

@@ -0,0 +1,6 @@
+---
+'@redocly/openapi-core': patch
+'@redocly/cli': patch
+---
+
+Fixed the `stats` command reporting wrong parameter count for AsyncAPI descriptions.

.changeset/seven-waves-create.md

@@ -0,0 +1,6 @@
+---
+'@redocly/openapi-core': minor
+'@redocly/cli': minor
+---
+
+Added a Vendor Extensions metric to the `stats` command that reports how many distinct `x-` extensions a description file uses and how often each one occurs.

docs/@v2/commands/stats.md

@@ -21,6 +21,7 @@ The metrics reported depend on the type of API description:
 - Webhooks
 - Operations
 - Tags
+- Vendor Extensions
 
 **AsyncAPI 2.x and AsyncAPI 3.x**
 
@@ -31,6 +32,9 @@ The metrics reported depend on the type of API description:
 - Channels
 - Operations
 - Tags
+- Vendor Extensions
+
+For **Vendor Extensions**, the count is the number of distinct `x-` extensions used, and each extension is listed with how many times it occurs.
 
 If you're interested in the technical details, the statistics are calculated using the counting logic from the `StatsVisitor` module.
 
@@ -123,6 +127,11 @@ Document: museum.yaml stats:
 🎣 Webhooks: 0
 👷 Operations: 8
 🔖 Tags: 3
+🧩 Vendor Extensions: 4
+   - x-badges: 1
+   - x-codeSamples: 2
+   - x-internal: 2
+   - x-metadata: 1
 
 museum.yaml: stats processed in 4ms
 </pre>
@@ -139,6 +148,9 @@ Document: asyncapi.yaml stats:
 📡 Channels: 1
 👷 Operations: 1
 🔖 Tags: 2
+🧩 Vendor Extensions: 2
+   - x-internal: 1
+   - x-metadata: 1
 
 asyncapi.yaml: stats processed in 4ms
 </pre>
@@ -187,6 +199,16 @@ The following is an example JSON output for an OpenAPI description:
   "tags": {
     "metric": "🔖 Tags",
     "total": 3
+  },
+  "xExtensions": {
+    "metric": "🧩 Vendor Extensions",
+    "total": 4,
+    "counts": {
+      "x-badges": 1,
+      "x-codeSamples": 2,
+      "x-internal": 2,
+      "x-metadata": 1
+    }
   }
 }
 </pre>
@@ -214,6 +236,15 @@ The following is an example source output for an OpenAPI description:
 | 🎣 Webhooks | 0 |
 | 👷 Operations | 8 |
 | 🔖 Tags | 3 |
+| 🧩 Vendor Extensions | 4 |
+
+#### 🧩 Vendor Extensions
+| Extension | Count |
+| --- | --- |
+| x-badges | 1 |
+| x-codeSamples | 2 |
+| x-internal | 2 |
+| x-metadata | 1 |
 
 </pre>
 
@@ -230,6 +261,16 @@ Here's the rendered example source output:
 | 🎣 Webhooks           | 0     |
 | 👷 Operations         | 8     |
 | 🔖 Tags               | 3     |
+| 🧩 Vendor Extensions  | 4     |
+
+**🧩 Vendor Extensions**
+
+| Extension     | Count |
+| ------------- | ----- |
+| x-badges      | 1     |
+| x-codeSamples | 2     |
+| x-internal    | 2     |
+| x-metadata    | 1     |
 
 For AsyncAPI descriptions, the table includes a `📡 Channels` row instead of the `🔗 Links`, `🔀 Path Items`, and `🎣 Webhooks` rows.
 

packages/cli/src/commands/stats/print-stats/json.ts

@@ -5,14 +5,12 @@ import {
 } from '@redocly/openapi-core';
 
 export function printStatsJson(statsAccumulator: OASStatsAccumulator | AsyncAPIStatsAccumulator) {
-  const json: any = {};
-  for (const key of Object.keys(statsAccumulator)) {
-    const stat = statsAccumulator[key as keyof typeof statsAccumulator];
-    json[key] = {
-      metric: stat.metric,
-      total: stat.total,
-    };
-  }
+  const json = Object.fromEntries(
+    Object.entries(statsAccumulator).map(([key, { metric, total, counts }]) => [
+      key,
+      { metric, total, counts },
+    ])
+  );
 
   logger.output(JSON.stringify(json, null, 2));
 }

packages/cli/src/commands/stats/print-stats/markdown.ts

@@ -8,10 +8,18 @@ export function printStatsMarkdown(
   statsAccumulator: OASStatsAccumulator | AsyncAPIStatsAccumulator
 ) {
   let output = '| Feature  | Count  |\n| --- | --- |\n';
-  for (const key of Object.keys(statsAccumulator)) {
-    const stat = statsAccumulator[key as keyof typeof statsAccumulator];
-    output += '| ' + stat.metric + ' | ' + stat.total + ' |\n';
+  const breakdowns: string[] = [];
+  for (const { metric, total, counts } of Object.values(statsAccumulator)) {
+    output += `| ${metric} | ${total} |\n`;
+    const countEntries = Object.entries(counts ?? {});
+    if (countEntries.length) {
+      breakdowns.push(
+        `\n#### ${metric}\n| Extension | Count |\n| --- | --- |\n` +
+          countEntries.map(([name, count]) => `| ${name} | ${count} |`).join('\n') +
+          '\n'
+      );
+    }
   }
 
-  logger.output(output);
+  logger.output(output + breakdowns.join(''));
 }

packages/cli/src/commands/stats/print-stats/stylish.ts

@@ -8,10 +8,11 @@ import * as colors from 'colorette';
 export function printStatsStylish(
   statsAccumulator: OASStatsAccumulator | AsyncAPIStatsAccumulator
 ) {
-  for (const node in statsAccumulator) {
-    const stat = statsAccumulator[node as keyof typeof statsAccumulator];
-    const { metric, total, color } = stat;
-    const colorFn = colors[color as keyof typeof colors] as (text: string) => string;
+  for (const { metric, total, color, counts } of Object.values(statsAccumulator)) {
+    const colorFn = colors[color];
     logger.output(colorFn(`${metric}: ${total} \n`));
+    for (const [name, count] of Object.entries(counts ?? {})) {
+      logger.output(colorFn(`   - ${name}: ${count} \n`));
+    }
   }
 }

packages/cli/src/commands/stats/visitor-and-accumulator-resolver.ts

@@ -20,6 +20,7 @@ export function resolveStatsVisitorAndAccumulator(specVersion: SpecVersion) {
     webhooks: { metric: '🎣 Webhooks', total: 0, color: 'green' },
     operations: { metric: '👷 Operations', total: 0, color: 'yellow' },
     tags: { metric: '🔖 Tags', total: 0, color: 'white', items: new Set() },
+    xExtensions: { metric: '🧩 Vendor Extensions', total: 0, color: 'cyan', counts: {} },
   };
   const statsAccumulatorAsync: AsyncAPIStatsAccumulator = {
     refs: { metric: '🚗 References', total: 0, color: 'red', items: new Set() },
@@ -29,6 +30,7 @@ export function resolveStatsVisitorAndAccumulator(specVersion: SpecVersion) {
     channels: { metric: '📡 Channels', total: 0, color: 'green' },
     operations: { metric: '👷 Operations', total: 0, color: 'yellow' },
     tags: { metric: '🔖 Tags', total: 0, color: 'white', items: new Set() },
+    xExtensions: { metric: '🧩 Vendor Extensions', total: 0, color: 'cyan', counts: {} },
   };
 
   let statsVisitor, statsAccumulator;

packages/core/src/__tests__/__snapshots__/redocly-yaml.test.ts.snap

@@ -1366,6 +1366,7 @@ exports[`createConfigTypes > matches snapshot for the default config schema 1`]
           "NamedParameters",
           "NamedSecuritySchemes",
           "SecurityScheme",
+          "Scopes",
           "XCodeSample",
           "XCodeSampleList",
           "XServerList",