@epure/vitest weekly downloads statistics

@epure/vitest

Gherkin contracts and structured YAML fixtures run by Vitest, with typed steps for TypeScript and ReScript.

@epure/vitest is the new name of vitest-bdd. See Migration from vitest-bdd.

• Guide • API reference • npm • épure method

Install

Configure Vitest

epureVitest translates feature files, Gherkin code fences in Markdown, and structured YAML fixtures into Vitest suites in memory. It does not write generated test files to disk.

YAML fixtures

Include .yaml files in Vitest when scenarios are structured examples rather than prose. epureVitest compiles every .yaml file Vitest loads; the test.include glob controls which fixtures are tests.

Register each given in calculator.test.yaml.ts, calculator.test.steps.ts, or a shared steps.ts beside the fixture:

Each example becomes a source-mapped Vitest test. A scenario's given overrides background.given; one of them is required. The remaining fields occupy the parameter position in the same Given API used by features: the handle first, scenario data second. The handle carries step, which registers a scenario operation, and test, the running Vitest test.

Write a contract

Place its steps beside it:

Each Given builder creates private scenario state. The operations it registers through step close over that state, so scenarios can run concurrently without a shared World. The feature file keeps its own words — When, Then, Alors — while the code has one: step. The handle's test is the running Vitest test, for test.onTestFinished teardown.

ReScript

Open the canonical EpureVitest module:

The package also provides typed Vitest suites, hooks, modes, and assertions. See the ReScript guide.

Migration from vitest-bdd

| Former name | Canonical name |

| package vitest-bdd | package @epure/vitest | | vitestBdd() | epureVitest() | | VitestBddOptions | EpureVitestOptions | | ReScript module VitestBdd | ReScript module EpureVitest |

The former names were deprecated aliases in 1.1.0 and are removed in 2.0.0.

Development

See CHANGELOG.md for release history.

Description from the npm listing.