Adopt new terminal formatters

package.json

@@ -226,7 +226,8 @@
     "@cucumber/junit-xml-formatter": "0.9.0",
     "@cucumber/message-streams": "4.0.1",
     "@cucumber/messages": "31.1.0",
-    "@cucumber/pretty-formatter": "1.0.1",
+    "@cucumber/pretty-formatter": "2.4.1",
+    "@cucumber/query": "14.7.0",
     "@cucumber/tag-expressions": "8.1.0",
     "assertion-error-formatter": "^3.0.0",
     "capital-case": "^1.0.4",
@@ -260,7 +261,6 @@
   },
   "devDependencies": {
     "@cucumber/compatibility-kit": "^26.0.0",
-    "@cucumber/query": "14.7.0",
     "@eslint/compat": "^2.0.0",
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.29.0",

src/formatter/builtin/index.ts

@@ -1,28 +1,29 @@
 import { FormatterImplementation } from '../index'
 import JsonFormatter from '../json_formatter'
-import ProgressFormatter from '../progress_formatter'
 import ProgressBarFormatter from '../progress_bar_formatter'
 import RerunFormatter from '../rerun_formatter'
 import SnippetsFormatter from '../snippets_formatter'
-import SummaryFormatter from '../summary_formatter'
 import UsageFormatter from '../usage_formatter'
 import UsageJsonFormatter from '../usage_json_formatter'
+import summaryFormatter from './summary'
+import prettyFormatter from './pretty'
+import progressFormatter from './progress'
 import messageFormatter from './message'
 import htmlFormatter from './html'
 
 const builtin = {
   // new plugin-based formatters
   html: htmlFormatter,
   junit: '@cucumber/junit-xml-formatter',
-  pretty: '@cucumber/pretty-formatter',
   message: messageFormatter,
+  pretty: prettyFormatter,
+  progress: progressFormatter,
+  summary: summaryFormatter,
   // legacy class-based formatters
   json: JsonFormatter,
-  progress: ProgressFormatter,
   'progress-bar': ProgressBarFormatter,
   rerun: RerunFormatter,
   snippets: SnippetsFormatter,
-  summary: SummaryFormatter,
   usage: UsageFormatter,
   'usage-json': UsageJsonFormatter,
 } as const satisfies Record<string, FormatterImplementation | string>
@@ -33,16 +34,16 @@ export const documentation = {
   // new plugin-based formatters
   html: 'Outputs a HTML report',
   junit: 'Produces a JUnit XML report',
+  message: 'Emits Cucumber messages in newline-delimited JSON',
   pretty:
     'Writes a rich report of the scenario and example execution as it happens',
-  message: 'Emits Cucumber messages in newline-delimited JSON',
+  progress: 'Prints one character per scenario.',
+  summary: 'Summary output of feature and scenarios',
   // legacy class-based formatters
   json: JsonFormatter.documentation,
-  progress: ProgressFormatter.documentation,
   'progress-bar': ProgressBarFormatter.documentation,
   rerun: RerunFormatter.documentation,
   snippets: SnippetsFormatter.documentation,
-  summary: SummaryFormatter.documentation,
   usage: UsageFormatter.documentation,
   'usage-json': UsageJsonFormatter.documentation,
 } satisfies Record<keyof typeof builtin, string>

src/formatter/builtin/pretty.ts

@@ -0,0 +1,15 @@
+import { PrettyPrinter } from '@cucumber/pretty-formatter'
+import { FormatterPlugin } from '../../plugin'
+
+export default {
+  type: 'formatter',
+  formatter({ on, stream, write }) {
+    const printer = new PrettyPrinter(stream, write)
+    on('message', (envelope) => {
+      printer.update(envelope)
+      if (envelope.testRunFinished) {
+        printer.summarise()
+      }
+    })
+  },
+} satisfies FormatterPlugin

src/formatter/builtin/progress.ts

@@ -0,0 +1,15 @@
+import { ProgressPrinter } from '@cucumber/pretty-formatter'
+import { FormatterPlugin } from '../../plugin'
+
+export default {
+  type: 'formatter',
+  formatter({ on, stream, write }) {
+    const printer = new ProgressPrinter(stream, write)
+    on('message', (envelope) => {
+      printer.update(envelope)
+      if (envelope.testRunFinished) {
+        printer.summarise()
+      }
+    })
+  },
+} satisfies FormatterPlugin

src/formatter/builtin/summary.ts

@@ -0,0 +1,16 @@
+import { SummaryPrinter } from '@cucumber/pretty-formatter'
+import { Query } from '@cucumber/query'
+import { FormatterPlugin } from '../../plugin'
+
+export default {
+  type: 'formatter',
+  formatter({ on, stream, write }) {
+    const query = new Query()
+    on('message', (envelope) => {
+      query.update(envelope)
+      if (envelope.testRunFinished) {
+        new SummaryPrinter(query, stream, write).printSummary()
+      }
+    })
+  },
+} satisfies FormatterPlugin

src/runtime/format_error.ts

@@ -7,7 +7,7 @@ export function formatError(
   error: Error,
   filterStackTraces: boolean
 ): Pick<TestStepResult, 'message' | 'exception'> {
-  let processedStackTrace: string
+  let processedStackTrace: string = error.stack
   try {
     const parsedStack = errorStackParser.parse(error)
     const filteredStack = filterStackTraces
@@ -17,19 +17,25 @@ export function formatError(
   } catch {
     // if we weren't able to parse and process, we'll settle for the original
   }
-  const message = format(error, {
+  const legacyMessage = format(error, {
     colorFns: {
       errorStack: (stack: string) => {
         return processedStackTrace ? `\n${processedStackTrace}` : stack
       },
     },
   })
+  const type = error.name || 'Error'
+  const message = typeof error === 'string' ? error : error.message
+  let stackTrace = `${type}: ${message}`
+  if (processedStackTrace) {
+    stackTrace += '\n' + processedStackTrace
+  }
   return {
-    message,
+    message: legacyMessage,
     exception: {
-      type: error.name || 'Error',
-      message: typeof error === 'string' ? error : error.message,
-      stackTrace: processedStackTrace ?? error.stack,
+      type,
+      message,
+      stackTrace,
     },
   }
 }

src/runtime/format_error_spec.ts

@@ -77,35 +77,38 @@ describe('formatError', () => {
         }
 
         it('should handle a custom error', () => {
-          expect(
-            testFormatError(() => {
-              assert.ok(false, 'Thing that should have been truthy was falsy!')
-            })
-          ).to.have.string(' at ')
+          const result = testFormatError(() => {
+            assert.ok(false, 'Thing that should have been truthy was falsy!')
+          })
+          expect(result).to.have.string(' at ')
+          expect(result).to.have.string(
+            'AssertionError: Thing that should have been truthy was falsy!'
+          )
         })
 
         it('should handle a generic error', () => {
-          expect(
-            testFormatError(() => {
-              throw new Error('A generally bad thing happened!')
-            })
-          ).to.have.string(' at ')
+          const result = testFormatError(() => {
+            throw new Error('A generally bad thing happened!')
+          })
+          expect(result).to.have.string(' at ')
+          expect(result).to.have.string(
+            'Error: A generally bad thing happened!'
+          )
         })
 
         it('should handle an omitted message', () => {
-          expect(
-            testFormatError(() => {
-              throw new Error()
-            })
-          ).to.have.string(' at ')
+          const result = testFormatError(() => {
+            throw new Error()
+          })
+          expect(result).to.have.string(' at ')
+          expect(result).to.have.string('Error: ')
         })
 
         it('should handle a thrown string', () => {
-          expect(
-            testFormatError(() => {
-              throw 'Yikes!'
-            })
-          ).to.be.undefined
+          const result = testFormatError(() => {
+            throw 'Yikes!'
+          })
+          expect(result).to.eq('Error: Yikes!')
         })
       })
     })