feat: Add markdown output format, suitable for use in GitHub Job Summ…

…aries
Redocly · Jan 16, 2024 · 011b34e · 011b34e
1 parent 4efdc96
commit 011b34e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/packages/cli/src/commands/stats.ts b/packages/cli/src/commands/stats.ts
@@ -46,6 +46,14 @@ function printStatsJson(statsAccumulator: StatsAccumulator) {
   process.stdout.write(JSON.stringify(json, null, 2));
 }
 
+function printStatsMarkdown(statsAccumulator: StatsAccumulator) {
+  let output = "";
+  for (const key of Object.keys(statsAccumulator)) {
+      output += "- " + statsAccumulator[key as StatsName].metric + ": " + statsAccumulator[key as StatsName].total + "\n";
+  }
+  process.stdout.write(output);
+}
+
 function printStats(statsAccumulator: StatsAccumulator, api: string, format: string) {
   switch (format) {
     case 'stylish':
@@ -55,6 +63,9 @@ function printStats(statsAccumulator: StatsAccumulator, api: string, format: str
     case 'json':
       printStatsJson(statsAccumulator);
       break;
+    case 'markdown':
+      printStatsMarkdown(statsAccumulator);
+      break;
   }
 }
 

diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -45,7 +45,7 @@ yargs
         },
         format: {
           description: 'Use a specific output format.',
-          choices: ['stylish', 'json'] as ReadonlyArray<OutputFormat>,
+          choices: ['stylish', 'json', 'markdown'] as ReadonlyArray<OutputFormat>,
           default: 'stylish' as OutputFormat,
         },
       }),