Support named BeforeAll/AfterAll hooks (#2661)

Author: davidjgoss

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 Please see [CONTRIBUTING.md](./CONTRIBUTING.md) on how to contribute to Cucumber.
 
 ## [Unreleased]
+### Added
+- Support named BeforeAll/AfterAll hooks ([#2661](https://github.com/cucumber/cucumber-js/pull/2661))
 
 ## [12.2.0] - 2025-08-22
 ### Added

docs/support_files/api_reference.md

@@ -54,6 +54,7 @@ Multiple `After` hooks are executed in the **reverse** order that they are defin
 Defines a hook which is run after all scenarios have completed.
 
 * `options`: An object with the following keys:
+  * `name`: An optional name for this hook
   * `timeout`: A hook-specific timeout, to override the default timeout.
 * `fn`: A function, defined as follows:
   * When using the asynchronous callback interface, have one argument for the callback function.

src/cli/helpers.ts

@@ -195,6 +195,7 @@ function emitTestRunHooks(
         hook: {
           id: hook.id,
           type,
+          name: hook.name,
           sourceReference: makeSourceReference(hook),
         },
       } satisfies Envelope)

src/cli/helpers_spec.ts

@@ -287,7 +287,9 @@ describe('helpers', () => {
             unwrappedCode: noopFunction,
             id: '1',
             line: 7,
-            options: {},
+            options: {
+              name: 'special cleanup thing',
+            },
             uri: 'features/support/run-hooks.js',
           }),
           new TestRunHookDefinition({
@@ -306,6 +308,7 @@ describe('helpers', () => {
           hook: {
             id: '0',
             type: HookType.BEFORE_TEST_RUN,
+            name: undefined,
             sourceReference: {
               uri: 'features/support/run-hooks.js',
               location: {
@@ -318,6 +321,7 @@ describe('helpers', () => {
           hook: {
             id: '1',
             type: HookType.AFTER_TEST_RUN,
+            name: 'special cleanup thing',
             sourceReference: {
               uri: 'features/support/run-hooks.js',
               location: {
@@ -330,6 +334,7 @@ describe('helpers', () => {
           hook: {
             id: '2',
             type: HookType.AFTER_TEST_RUN,
+            name: undefined,
             sourceReference: {
               uri: 'features/support/run-hooks.js',
               location: {

src/models/test_run_hook_definition.ts

@@ -1,3 +1,17 @@
-import Definition from './definition'
+import Definition, {
+  IDefinitionParameters,
+  IDefinitionOptions,
+} from './definition'
 
-export default class TestRunHookDefinition extends Definition {}
+export interface ITestRunHookDefinitionOptions extends IDefinitionOptions {
+  name?: string
+}
+
+export default class TestRunHookDefinition extends Definition {
+  public readonly name: string
+
+  constructor(data: IDefinitionParameters<ITestRunHookDefinitionOptions>) {
+    super(data)
+    this.name = data.options.name
+  }
+}

src/support_code_library_builder/index.ts

@@ -7,7 +7,9 @@ import {
 } from '@cucumber/cucumber-expressions'
 import TestCaseHookDefinition from '../models/test_case_hook_definition'
 import TestStepHookDefinition from '../models/test_step_hook_definition'
-import TestRunHookDefinition from '../models/test_run_hook_definition'
+import TestRunHookDefinition, {
+  ITestRunHookDefinitionOptions,
+} from '../models/test_run_hook_definition'
 import StepDefinition from '../models/step_definition'
 import { formatLocation } from '../formatter/helpers'
 import { doesHaveValue } from '../value_checker'
@@ -355,7 +357,7 @@ export class SupportCodeLibraryBuilder {
         code: wrappedCode,
         id: canonicalIds ? canonicalIds[index] : this.newId(),
         line,
-        options,
+        options: options as ITestRunHookDefinitionOptions,
         unwrappedCode: code,
         uri,
       })

src/support_code_library_builder/types.ts

@@ -67,6 +67,7 @@ export interface IDefineTestStepHookOptions {
 }
 
 export interface IDefineTestRunHookOptions {
+  name?: string
   timeout?: number
 }
 

test-d/hooks.ts

@@ -50,3 +50,9 @@ Before(async function () {
 After(async function () {
   return 'skipped'
 })
+
+// should allow named hooks
+BeforeAll({ name: 'before test run' }, function () {})
+AfterAll({ name: 'after test run' }, function () {})
+Before({ name: 'before test case' }, function () {})
+After({ name: 'after test case' }, function () {})