print snippets

Author: davidjgoss

javascript/src/SummaryPrinter.ts

@@ -1,7 +1,7 @@
 import { Envelope, TestRunFinished, TestRunStarted, TestStepResultStatus } from '@cucumber/messages'
 import { Query } from '@cucumber/query'
 
-import { formatCounts, formatDuration } from './helpers.js'
+import { formatCounts, formatDuration, formatSnippets } from './helpers.js'
 import type { Options } from './types.js'
 
 export class SummaryPrinter {
@@ -25,6 +25,11 @@ export class SummaryPrinter {
   }
 
   private printSummary() {
+    this.printStats()
+    this.printSnippets()
+  }
+
+  private printStats() {
     this.println()
     this.printGlobalHookCounts()
     this.printScenarioCounts()
@@ -92,4 +97,22 @@ export class SummaryPrinter {
 
     this.println(formatDuration(testRunStarted.timestamp, testRunFinished.timestamp))
   }
+
+  private printSnippets() {
+    const snippets = this.query
+      .findAllTestCaseFinished()
+      .map((testCaseFinished) => this.query.findPickleBy(testCaseFinished))
+      .filter((pickle) => !!pickle)
+      .sort((a, b) => {
+        // TODO compare by location too
+        return a?.uri.localeCompare(b?.uri || '') || 0
+      })
+      .flatMap((pickle) => this.query.findSuggestionsBy(pickle))
+      .flatMap((suggestion) => suggestion.snippets)
+      .map((snippet) => snippet.code)
+    const uniqueSnippets = new Set(snippets)
+    if (snippets.length > 0) {
+      this.println(formatSnippets(uniqueSnippets))
+    }
+  }
 }

javascript/src/helpers.ts

@@ -11,6 +11,7 @@ import {
   PickleTable,
   Rule,
   Scenario,
+  Snippet,
   Step,
   StepDefinition,
   TestRunFinished,
@@ -376,3 +377,10 @@ export function formatCounts(
   }
   return builder.build()
 }
+
+export function formatSnippets(snippets: Set<string>) {
+  return `
+You can implement missing steps with the snippets below:
+
+${[...snippets].join('\n\n')}`
+}