API Reference cucumberex v#0.2.1

Copy Markdown View Source

Modules

Full-featured Cucumber BDD framework for Elixir.

Configuration struct for a Cucumber run.

Load configuration from

Step definition DSL.

Wrapper around Cucumber pickle table data with convenience accessors.

Multi-line doc string argument in a step.

Event structs for the test lifecycle.

Event bus: broadcast test lifecycle events to formatters.

Filter scenarios by file:line.

Filter scenarios by name pattern.

Parse and evaluate Cucumber tag expressions.

Formatter behaviour for Cucumberex.

ANSI color helpers. Each function wraps s in an ANSI color then a reset.

HTML report formatter.

JSON formatter — emits cucumber-compatible JSON report.

JUnit XML formatter for CI integration.

Human-friendly colored terminal output.

Dot-per-step progress formatter (like RSpec's progress formatter).

Rerun formatter: writes failed scenario locations to a file. Use with mix cucumber @rerun.txt to re-run only failures.

A registered hook with phase, tag filter, and implementation.

Hook definition DSL. Use in support files

GenServer registry for all hooks.

A named parameter type with a regexp and transformer.

Built-in Cucumber parameter types.

Registry for parameter types used in Cucumber Expressions.

Step and scenario result types.

Top-level test runner: load features, filter, order, execute, report.

Execute a single pickle (scenario/scenario outline row).

Execute a single pickle step.

A registered step definition with pattern and implementation.

Compile Cucumber Expressions and plain Regex patterns to Elixir regexes.

Match a step text against registered step definitions.

GenServer registry for step definitions.

Generate step definition snippets for undefined steps.

World context: a plain map threaded through each scenario. Isolated per scenario — no state shared between scenarios.

Global registry for the world factory function.

Mix Tasks

Run Cucumber feature tests.

Generate a .feature skeleton under features/.

Generate a step definition module skeleton.

Scaffold features/, a starter step module, a starter env file, and an example feature so mix cucumber runs green immediately.