externalSerenityBDDReporterConfig

Configuration options for the SerenityBDDReporter.

Index

Properties

• specDirectory
• reporter

Properties

externaloptionalspecDirectory

specDirectory?: string

The root directory that SerenityBDDReporter should recursively scan for test scenario files to determine the requirements hierarchy, relative to the current working directory.

If not specified, specDirectory defaults to the first one of the following subdirectories that's present in the current working directory:

• features - typically used by Serenity/JS + Cucumber.js projects to store .feature files
• specs - typically used by Serenity/JS + Jasmine and Mocha projects to store .spec.js or .spec.ts files
• spec - another popular naming convention seen in Serenity/JS + Jasmine and Mocha projects
• tests - typically used by Serenity/JS + Playwright Test projects to store .spec.ts files
• test - typically used by Serenity/JS + WebdriverIO projects to store .spec.ts files
• src - typically used by Serenity/JS + Playwright Component Test projects to store .spec.ts files alongside the source code

If not specified and none of the above subdirectories are present, specDirectory defaults to the current working directory.

If specDirectory is specified, but the directory doesn't exist, SerenityBDDReporter throws a ConfigurationError.

IMPORTANT: For the Serenity BDD CLI Reporter to correctly parse the requirements hierarchy and recognise your test scenarios, your test scenario files must be named using either:

• <feature name>.feature naming convention for Cucumber.js projects
• <feature name>.<suffix>.<extension> naming convention for non-Cucumber.js projects

In the naming conventions above:

• <feature name> is the name of the feature or component the scenario exercises; e.g. checkout.feature, checkout.spec.ts, LoginForm.spec.ts
• <suffix> is one of the following: spec, test, integration, it, e2e, spec.e2e, spec-e2e; e.g. checkout.spec.ts, payments.spec-e2e.ts, user_registration.integration.ts
• <extension> is one of the following: js, jsx, mjs, mjsx, cjs, cjsx, ts, tsx, mts, mtsx, cts, ctxs; e.g. authentication.spec.ts, FormValidator.spec.mtsx

To find out more about how Serenity BDD CLI parses the requirements hierarchy, see the SpecFileFilters class.

externaloptionalreporter

reporter?: { includeAbilityDetails?: boolean }

Type declaration

• externaloptionalincludeAbilityDetails?: boolean

  Whether to include the details of final state and configuration details of actors' abilities in Serenity BDD reports. Defaults to true.