!CI

cucumber-tsflow

Provides 'specflow' like bindings for Cucumber-JS 12.2.0 in TypeScript 5.9+.

Supports Vue3 files in cucumber tests.

Fork description

This is a detached fork of . It has had the branch merged into it, which adds support for beforeAll and afterAll hooks.

This fork has been drastically modified from the original and will eventually be moved to a new project. In addition, the SpecFlow project has reached end of life, and this project will be rebranded. Further details will be provided in future updates. However, the new project will support the same functionality as cucumber-tsflow while providing additional tools and extensions.

Release Updates (7.3.0)

With this release, we've finally added support for ESM Modules. For details on the new transpilers/loaders please see: cucumber-tsflow ESM implementation.

Along with ESM support, additional updates include:

- Cucumber-JS updated to version 12.2.0
- Typescript updated to version 5.9.2
- ts-node replaced with ts-node-maintained. For more information, please see the section titled Node 22+ and ts-node in the cucumber-tsflow ESM implementation.
- Other package updates.

Release Updates (7.2.0)

With this release, support for Experimental Decorators was added for backwards compatibility with any code under test that is using experimental decorators.

- Cucumber-JS updated to version 11.3.0
- New configuration parameter named experimentalDecorators that can be used to enable support for older experimental decorators.
- Issue with using the companion VS Code Extension has been resolved.

Release Updates (7.1.0)

With this latest release, cucumber-tsflow has been refactored to support cucumber-js version 11.2.0 along with other updates that include:

- Switch to package exports with both cucumber-tsflow and most of cucumber-js Public types and functions exported. This allows developers to use cucumber-tsflow as a replacement for cucumber-js without requiring a peer installation. Most of the functionality is still executed in cucumber-js, cucumber-tsflow just extends cucumber-js to switch from support functions to support decorators with scoped context. This change is what allows you to use a SpecFlow type of structure for defining code that will execute BDD tests.
- API support that implements and extends the cucumber-js API.
- Support for Node 22 and Typescript 5.8.
- Switched to official Typescript Decorators with metadata support implemented in Typescript 5.2.
- Transpiler configuration updates to support node and Typescript changes.
- Added a new section to this readme that describes Transpilers and TypeScript in more detail.

Features

This fork of cucumber-tsflow provides the following features that extend the original version:

- Test runner using the cucumber-tsflow command.

- Uses underlying cucumber api to run tests.
- Returns four exit codes:
- 0 - All scenarios passing.
- 1 - Invalid configuration or Unhandled exception when executing tests.
- 2 - Implemented scenarios are passing but there are pending, undefined or unknown scenario steps.
- 3 - One or more scenario steps have failed.

- CommonJS transpilers using either esbuild or ts-node-maintained.

- ESM loaders using either esbuild or ts-node-maintained.

- Support for both Official and Experimental Decorators in TypeScript.

- Vue3 transformer used to handle .vue files in tests.

NOTE: Supports browserless unit testing of Vue SFC components by loading only the