@qavajs/playwright-runner-adapter 2.3.3 → 2.5.0

package/CHANGELOG.md

@@ -14,6 +14,45 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 :microscope: - experimental
 
+## [2.5.0]
+- :beetle: `requireModules` are now required as modules (e.g. `ts-node/register`) resolved from the current working directory instead of being treated as globs
+- :beetle: `worldParameters` config option is passed to the world as `this.parameters`
+- :beetle: `this.attach` accepts media type as a string (`attach(data, 'image/png')`), decodes `;base64` media types and supports readable streams
+- :beetle: `this.log` attaches text to the report (attachment `log` on the current step) instead of printing to stdout
+- :beetle: steps returning `'pending'` fail the scenario (or mark it as fixme with `strict: false`); steps and `Before` hooks returning `'skipped'` skip the scenario
+- :beetle: `After` hooks receive `FAILED` status when a `Before` hook fails; soft assertion failures, undefined, ambiguous and pending steps are reported with their own status
+- :beetle: features with the same name in different files no longer produce duplicate test titles; unnamed features use the file path as title
+- :rocket: undefined step error includes the feature file location and a step definition snippet
+- :rocket: added `tags` config option and `CUCUMBER_TAGS` env variable to select scenarios by tag expression evaluated on Gherkin tags
+- :rocket: added `CUCUMBER_PATHS` env variable to override feature paths
+- :rocket: `executeStep` accepts a doc string (`string`) or data table (`string[][]` / `DataTable`) argument
+- :rocket: `Template` supports data tables and doc strings
+- :rocket: tests and describe blocks are reported at their location in the `.feature` file
+- :rocket: step titles include a preview of their doc string or data table argument
+- :rocket: added `@timeout(ms)` tag to set test timeout and `@retries(n)` feature tag to set retries
+- :rocket: added `withWorld<World>()` helper returning step and hook functions with typed `this`
+- :rocket: added `stepLocation` config option to point steps to the feature file instead of step definitions
+- :rocket: step and hook `{ timeout }` option and `setDefaultTimeout` are applied (no implicit 5s default)
+- :rocket: steps run by `executeStep` and `Template` are shown as nested steps in the report
+- :rocket: invalid tag expressions report their source (`tags()`, `tags` option, `CUCUMBER_TAGS`); tags without `@` are rejected
+- :pencil: replaced `glob` dependency with built-in `fs.globSync`; matched files are loaded in sorted order
+- :pencil: tests no longer depend on external websites
+- :pencil: CI: tests cover all test projects (TS, CommonJS, ESM configs), `CUCUMBER_PATHS` / `CUCUMBER_TAGS`, type checks and a smoke test of the packed package in fresh CommonJS, ESM and TypeScript projects
+- :pencil: CI: publish no longer runs e2e tests
+- :pencil: README: clarified the difference between the main and `./js` entrypoints
+- :pencil: documented and tested supported Cucumber APIs: `defineParameterType`, `setDefinitionFunctionWrapper`, localized Gherkin, Rule tags
+
+## [2.4.0]
+- :rocket: added `@lock(name)` tag mapped to playwright test locks (`@lock(-exclusive-)` for the built-in exclusive lock)
+- :rocket: added `@skip(reason)`, `@fixme(reason)`, `@fail(reason)`, `@slow(reason)` tags mapped to playwright test modifiers (reason is optional: `@skip()`)
+- :rocket: added `@annotation(type,description)` tag mapped to playwright test annotations
+- :pencil: special tags (`@lock(...)`, `@annotation(...)`, `@skip(...)`, `@fixme(...)`, `@fail(...)`, `@slow(...)`) are removed from playwright tags
+- :pencil: updated `@cucumber/cucumber` to 13, `@cucumber/gherkin` to 42, `@cucumber/tag-expressions` to 11 and `glob` to 14
+- :pencil: updated dev dependencies: `@playwright/test` 1.65, `@types/node` 26, `typescript` 7
+- :pencil: switched `module` and `moduleResolution` to `nodenext` in `tsconfig.json` and `tsconfig.js.json`
+- :x: dropped Node.js 20 support (`engines.node` is now `>=22`); CI tests against Node.js 22, 24 and 26
+- :pencil: CI: updated `actions/checkout` and `actions/setup-node` to v7, `mikepenz/action-junit-report` to v6; tests also run on push to `main`, `npm audit` gate for production dependencies, junit report requires tests, e2e tests gate npm publish, publish with provenance
+
 ## [2.3.3]
 - :beetle: fixed named import for `parse` from `@cucumber/tag-expressions` in `filter.ts`
 - :beetle: fixed `attach` method assignment in `PlaywrightWorld` constructor

package/README.md

@@ -13,14 +13,20 @@ Adapter to run [Cucumber](https://cucumber.io/) BDD tests via the [Playwright](h
   - [TestWorld](#testworld)
   - [PlaywrightWorld](#playwrightworld)
   - [Custom World](#custom-world)
+  - [Typed Steps](#typed-steps)
 - [Hooks](#hooks)
 - [Step Arguments](#step-arguments)
 - [Template Steps](#template-steps)
+- [Step Results](#step-results)
 - [Filtering Tests](#filtering-tests)
   - [Tag Expressions](#tag-expressions)
   - [Predicate Filter](#predicate-filter)
+- [Annotations, Modifiers and Locks](#annotations-modifiers-and-locks)
 - [Parallelism](#parallelism)
-- [JavaScript / CommonJS Support](#javascript--commonjs-support)
+- [Reports](#reports)
+- [Entrypoints and JavaScript Support](#entrypoints-and-javascript-support)
+- [Timeouts](#timeouts)
+- [Supported Cucumber APIs](#supported-cucumber-apis)
 - [Limitations](#limitations)
 
 ---
@@ -54,10 +60,13 @@ export default defineConfig({
 import { defineConfig } from '@playwright/test';
 
 export default defineConfig({
-    testMatch: 'cucumber.config.ts'
+    testMatch: 'cucumber.config.ts',
+    fullyParallel: true
 });
 ```
 
+> All scenarios are defined in a single test file (`cucumber.config.ts`), so without `fullyParallel: true` Playwright runs the whole suite in one worker.
+
 **3. Run tests**
 
 ```bash
@@ -75,7 +84,11 @@ npx playwright test
 | `paths` | `string[]` | Glob patterns for `.feature` files |
 | `require` | `string[]` | Glob patterns for step definition files (CommonJS `require`) |
 | `import` | `string[]` | Glob patterns for step definition files (ESM `import`) |
-| `requireModules` | `string[]` | Modules to require before step definitions (e.g. `ts-node/register`) |
+| `requireModules` | `string[]` | Module names or paths (resolved from the current working directory) to require before step definitions (e.g. `ts-node/register`) |
+| `worldParameters` | `unknown` | Value available in steps and hooks as `this.parameters` |
+| `tags` | `string` | Cucumber tag expression selecting scenarios to run |
+| `strict` | `boolean` | Fail scenarios with pending steps (default `true`). When `false` they are marked as `fixme` |
+| `stepLocation` | `'definition' \| 'feature'` | Location reported for steps: step definition code (default) or the step line in the `.feature` file |
 
 ```typescript
 // cucumber.config.ts
@@ -84,10 +97,19 @@ import { defineConfig } from '@qavajs/playwright-runner-adapter';
 export default defineConfig({
     paths: ['test/features/**/*.feature'],
     require: ['test/step_definitions/**/*.ts'],
-    requireModules: [],
+    requireModules: ['./test/support/setup.ts'],
+    worldParameters: { baseUrl: 'https://example.com' },
+    tags: 'not @wip',
 });
 ```
 
+Environment variables:
+
+| Variable | Description |
+|---|---|
+| `CUCUMBER_TAGS` | Tag expression combined with the `tags` option using `and`: `CUCUMBER_TAGS='@smoke' npx playwright test` |
+| `CUCUMBER_PATHS` | Comma-separated feature globs replacing `paths`: `CUCUMBER_PATHS=features/login.feature npx playwright test` |
+
 ---
 
 ## World Classes
@@ -105,17 +127,29 @@ import { TestWorld } from '@qavajs/playwright-runner-adapter';
 | `test` | `TestType` | Playwright `test` instance (default or custom) |
 | `expect` | `ExpectType` | Playwright `expect` instance (default or custom) |
 | `attach` | `function` | Attach files/data to the test report |
-| `log` | `function` | Log data to console |
-| `parameters` | `string` | Cucumber world parameters |
+| `log` | `function` | Log text to the test report (attachment named `log` on the current step) |
+| `parameters` | `unknown` | Value of the `worldParameters` config option |
 | `config` | `any` | Cucumber config object |
 | `supportCodeLibrary` | `any` | Access to the loaded support code library |
 
-**`executeStep(text, extraParam?)`** — programmatically invoke a step by its text:
+**`attach(data, mediaTypeOrOptions?)`** — same signature as in Cucumber:
+
+```typescript
+await this.attach('plain text');                                         // text/plain
+await this.attach(JSON.stringify(data), 'application/json');
+await this.attach(screenshot, { mediaType: 'image/png', fileName: 'screenshot.png' });
+await this.attach(base64Png, 'image/png;base64');                        // base64 string is decoded
+await this.attach(fs.createReadStream('report.pdf'), 'application/pdf');  // streams are supported
+```
+
+**`executeStep(text, argument?)`** — programmatically invoke a step by its text. `argument` is passed as a doc string (`string`) or data table (`string[][]` or `DataTable`); any other value is passed as an extra parameter. Each executed step is shown in the report as a nested step of the calling step, and its `{ timeout }` option applies:
 
 ```typescript
 When('composite step', async function (this: PlaywrightWorld) {
     await this.executeStep('I open the home page');
     await this.executeStep('I click "Login"');
+    await this.executeStep('I fill the form', [['username', 'alice'], ['password', 'secret']]);
+    await this.executeStep('I set the body', '{"key": "value"}');
 });
 ```
 
@@ -197,6 +231,24 @@ The `init` function receives Playwright fixtures as its argument. Its signature
 
 ---
 
+### Typed Steps
+
+`withWorld<World>()` returns step and hook functions with `this` typed as your world, so you don't need a `this: MyWorld` annotation in every step:
+
+```typescript
+import { withWorld } from '@qavajs/playwright-runner-adapter';
+
+const { Given, When, Then, Before, After } = withWorld<MyWorld>();
+
+When('I open {string}', async function (url: string) {
+    await this.page.goto(url); // `this` is MyWorld
+});
+```
+
+Cucumber's generic form works too: `When<MyWorld>('I open {string}', async function (url) { ... })`.
+
+---
+
 ## Hooks
 
 All standard Cucumber hooks are supported. Hooks run as named Playwright steps and appear in the trace viewer and HTML report.
@@ -309,7 +361,45 @@ When('I log in as {string}', Template((username: string) => `
 `));
 ```
 
-Each non-empty line in the returned string is executed as an individual step against the current world. Steps run sequentially; a failure stops the sequence.
+Each non-empty line in the returned string is executed as an individual step against the current world and shown as a nested step in the report. Steps run sequentially; a failure stops the sequence.
+
+Steps in a template can have data tables and doc strings, written the same way as in feature files:
+
+```typescript
+When('I register as {string}', Template((username: string) => `
+    I fill the form
+      | username | ${username} |
+      | password | secret      |
+    I set the body
+      """
+      {"user": "${username}"}
+      """
+`));
+```
+
+---
+
+## Step Results
+
+Steps and hooks follow Cucumber semantics:
+
+- a step returning `'pending'` fails the scenario (or marks it as `fixme` with `strict: false`)
+- a step or `Before` hook returning `'skipped'` skips the rest of the scenario and marks it as skipped
+- an undefined step fails the scenario with its location in the feature file and a ready-to-paste snippet:
+
+```
+Step 'I have 5 "apples"' is not defined
+  at /project/features/cart.feature:12
+
+Implement it with the following snippet:
+
+When('I have {int} {string}', async function (int, string) {
+  // Write code here that turns the phrase above into concrete actions
+  return 'pending';
+});
+```
+
+`After` and `AfterStep` hooks receive the actual status (`PASSED`, `FAILED`, `SKIPPED`, `PENDING`, `UNDEFINED`, `AMBIGUOUS`), including failures in `Before` hooks and soft assertions.
 
 ---
 
@@ -317,7 +407,9 @@ Each non-empty line in the returned string is executed as an individual step aga
 
 ### Tag Expressions
 
-Use `tags` to translate a Cucumber tag expression into a Playwright `grep` pattern:
+The simplest way to select scenarios is the `tags` [config option](#configuration-reference) and the `CUCUMBER_TAGS` environment variable. They are evaluated against the scenario's Gherkin tags, and scenarios that don't match are not created at all.
+
+Use `tags()` to translate a Cucumber tag expression into a Playwright `grep` pattern:
 
 ```typescript
 // playwright.config.ts
@@ -331,6 +423,10 @@ export default defineConfig({
 
 Supports the full [Cucumber tag expression syntax](https://github.com/cucumber/tag-expressions): `and`, `or`, `not`, parentheses.
 
+Invalid expressions fail fast with an error naming their source (`tags()`, the `tags` option or `CUCUMBER_TAGS`). Tags written without `@` (e.g. `smoke and not @wip`) are rejected too, because they would silently match nothing.
+
+`tags()` is evaluated against Playwright's grep string (titles + tags), so, like Playwright itself, it treats `@words` in feature and scenario titles as tags. Use the `tags` config option when that matters.
+
 ### Predicate Filter
 
 Use `filter` when you need arbitrary logic to select scenarios:
@@ -348,6 +444,45 @@ The predicate receives the full test name (feature + scenario title + tags) and
 
 ---
 
+## Annotations, Modifiers and Locks
+
+Gherkin tags are translated into Playwright [test details](https://playwright.dev/docs/test-annotations). The special tags below are consumed: they are removed from the scenario's Playwright tags (and the `tags` annotation), so they don't show up as tags in reports and can't be matched with `grep` / `tags()`. All other tags are kept as Playwright tags.
+
+| Tag | Playwright equivalent |
+|---|---|
+| `@skip()` / `@skip(reason)` | skips the scenario — fixtures are not set up |
+| `@fixme()` / `@fixme(reason)` | same as skip, marks the scenario as to be fixed |
+| `@fail()` / `@fail(reason)` | scenario passes only if it fails |
+| `@slow()` / `@slow(reason)` | triples the timeout |
+| `@lock(name)` | `lock: 'name'` — scenarios sharing a lock never run concurrently |
+| `@lock(-exclusive-)` | built-in exclusive lock — runs only when no other test is running |
+| `@annotation(type,description)` | `annotation: { type, description }` — description is optional: `@annotation(flaky)` |
+| `@timeout(ms)` | sets the test timeout, e.g. `@timeout(60000)`; overrides `@slow()`, the last tag wins (scenario over feature) |
+| `@retries(n)` | number of retries for all scenarios of the feature — **Feature only**, using it on a Rule or Scenario is an error |
+
+Modifiers are passed as annotations of type `skip`, `fixme`, `fail`, `slow`, which Playwright applies like `test.skip()` and the other modifiers, and the optional reason is shown in the report. Plain tags such as `@skip` or `@slow` are ordinary tags and do nothing. Tags set on a `Feature` or `Rule` apply to all its scenarios.
+
+> Gherkin tags may not contain whitespace, so write `@annotation(issue,JIRA-123)` without a space after the comma. Everything after the first comma is the description.
+
+```gherkin
+@lock(user-settings)
+Feature: user settings
+
+  @annotation(issue,JIRA-123)
+  Scenario: update settings
+    When I update settings
+
+  @lock(-exclusive-) @slow(full-reset)
+  Scenario: reset all data
+    When I reset the database
+```
+
+Locks are a lighter alternative to splitting scenarios into a separate serial project (see [Parallelism](#parallelism)): only scenarios sharing the same lock are serialized, everything else stays parallel. Locks require `@playwright/test` 1.65+.
+
+Runtime annotations can be added from steps via `this.test.info().annotations.push({ type, description })`.
+
+---
+
 ## Parallelism
 
 Playwright projects let you run subsets of scenarios in parallel or serially:
@@ -378,13 +513,31 @@ export default defineConfig({
 
 Tag scenarios that must run serially with `@serial` (or any tag of your choice) and keep everything else fully parallel.
 
+To run a single feature or scenario use `CUCUMBER_PATHS=features/login.feature npx playwright test` or `npx playwright test -g "Feature name"`. Passing a `.feature` path as a Playwright CLI argument does not work, because all scenarios are defined in `cucumber.config.ts`.
+
 > To get the current worker index inside a step, use `this.test.info().parallelIndex`.
 
 ---
 
-## JavaScript / CommonJS Support
+## Reports
 
-If your step definitions are plain JavaScript (`.js`), import from the `./js` entrypoint to avoid TypeScript overhead:
+- Scenarios are reported at their location in the `.feature` file (Scenario Outline examples point to their example row), so reporters and `--list` show `features/login.feature:12:3`.
+- Steps point to their step definition; set `stepLocation: 'feature'` to point them to the step line in the `.feature` file instead.
+- Steps are reported with a short preview of their argument: `I submit the form [DataTable: | field | value | | username | alice |]`.
+- Features with the same name in different files get the file path appended to their title to keep test titles unique.
+
+---
+
+## Entrypoints and JavaScript Support
+
+The package is compiled to CommonJS JavaScript with type declarations, so it works from TypeScript and plain JavaScript, with `require` and `import`. It has two entrypoints with the same API:
+
+| Entrypoint | Difference |
+|---|---|
+| `@qavajs/playwright-runner-adapter` | ships source maps |
+| `@qavajs/playwright-runner-adapter/js` | the same build without source maps — stack traces show the compiled `.js` files |
+
+Plain JavaScript projects don't need any TypeScript setup with either entrypoint:
 
 ```javascript
 // cucumber.config.js
@@ -403,6 +556,40 @@ const { Given, When, Then, PlaywrightWorld } = require('@qavajs/playwright-runne
 
 ---
 
+## Timeouts
+
+- The Playwright test timeout (`timeout` in `playwright.config.ts`, `@timeout(ms)` or `@slow()` tags) limits the whole scenario.
+- A step or hook `{ timeout }` option limits that single step or hook, as in Cucumber:
+
+```typescript
+When('I upload a big file', { timeout: 60_000 }, async function () { /* ... */ });
+Before({ tags: '@db', timeout: 10_000 }, async function () { /* ... */ });
+```
+
+- `setDefaultTimeout(ms)` sets the timeout for all steps and hooks without their own `{ timeout }`. Unlike Cucumber, there is no 5 second default: without `setDefaultTimeout` only the Playwright test timeout applies. `-1` disables the timeout for a definition.
+
+---
+
+## Supported Cucumber APIs
+
+| API | Supported |
+|---|---|
+| `Given` / `When` / `Then` / `defineStep` (Cucumber expressions and RegExp) | ✅ |
+| `Before` / `After` / `BeforeStep` / `AfterStep` (named, tagged) | ✅ |
+| `BeforeAll` / `AfterAll` | ✅ once per worker |
+| `setWorldConstructor` | ✅ |
+| `defineParameterType` | ✅ |
+| `setDefinitionFunctionWrapper` (incl. `wrapperOptions`) | ✅ |
+| Data tables, doc strings | ✅ |
+| Scenario Outline, Background, Rule (incl. Rule tags) | ✅ |
+| Localized Gherkin (`# language: de`) | ✅ |
+| `worldParameters`, `tags`, `strict` | ✅ |
+| `setDefaultTimeout`, step and hook `{ timeout }` option | ✅ see [Timeouts](#timeouts) |
+| `setParallelCanAssign` | ❌ see [Limitations](#limitations) |
+| Cucumber formatters (`format`) | ❌ use Playwright [reporters](https://playwright.dev/docs/test-reporters) |
+
+---
+
 ## Limitations
 
 - **ES modules** — not supported for Node.js < 22 (where experimental ESM `require` is available). Use CommonJS or TypeScript with `ts-node`.

package/adapter/PlaywrightWorld.d.ts

@@ -1,18 +1,20 @@
 import { APIRequestContext, Browser, BrowserContext, Page } from '@playwright/test';
-import type { CucumberAdapterConfig, SupportCodeLibrary, WorldOptions } from './types';
+import type { AttachFn, CucumberAdapterConfig, SupportCodeLibrary, WorldOptions } from './types';
 export declare class TestWorld {
     log: (data: unknown) => void;
-    attach: (data: unknown, details?: {
-        fileName?: string;
-        mediaType?: string;
-    }) => Promise<void>;
+    attach: AttachFn;
     parameters: unknown;
     config: CucumberAdapterConfig;
     supportCodeLibrary: SupportCodeLibrary;
     test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
     expect: import("@playwright/test").Expect<{}>;
     constructor(options: WorldOptions);
-    executeStep(this: TestWorld, text: string, extraParam?: unknown): Promise<void>;
+    /**
+     * Execute step by its text
+     * @param text - step text
+     * @param argument - doc string (`string`), data table (`string[][]` or `DataTable`) or any extra parameter
+     */
+    executeStep(this: TestWorld, text: string, argument?: unknown): Promise<void>;
 }
 export declare class PlaywrightWorld extends TestWorld {
     page: Page;

package/adapter/PlaywrightWorld.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlaywrightWorld = exports.TestWorld = void 0;
 const test_1 = require("@playwright/test");
+const gherkin_1 = require("./gherkin");
+const timeout_1 = require("./timeout");
 class TestWorld {
     log;
     attach;
@@ -17,7 +19,12 @@ class TestWorld {
         this.supportCodeLibrary = options.supportCodeLibrary;
         this.config = options.config;
     }
-    async executeStep(text, extraParam) {
+    /**
+     * Execute step by its text
+     * @param text - step text
+     * @param argument - doc string (`string`), data table (`string[][]` or `DataTable`) or any extra parameter
+     */
+    async executeStep(text, argument) {
         const steps = this.supportCodeLibrary.stepDefinitions
             .filter(s => s.matchesStepName(text));
         if (steps.length === 0)
@@ -27,13 +34,19 @@ class TestWorld {
             throw new Error(`Step "${text}" matches multiple step definitions:\n${locations}`);
         }
         const step = steps[0];
-        const { parameters } = await step.getInvocationParameters({ step: { text }, world: this });
-        try {
-            await step.code.apply(this, [...parameters, extraParam]);
-        }
-        catch (err) {
-            throw new Error(`Step failed: ${text}`, { cause: err });
-        }
+        const { argument: pickleArgument, extra } = (0, gherkin_1.toPickleArgument)(argument);
+        const location = step.uri ? { file: step.uri, line: step.line, column: 1 } : undefined;
+        // reported as a nested step, so failures inside composite steps point to the exact inner step
+        await this.test.step((0, gherkin_1.stepTitle)({ text, argument: pickleArgument }), async () => {
+            const { parameters } = await step.getInvocationParameters({ step: { text, argument: pickleArgument }, world: this });
+            const args = extra === undefined ? parameters : [...parameters, extra];
+            try {
+                await (0, timeout_1.runWithTimeout)(() => step.code.apply(this, args), (0, timeout_1.resolveTimeout)(step, this.supportCodeLibrary.defaultTimeout), `Step '${text}' timed out after {timeout} ms\n  at ${step.uri}:${step.line}`);
+            }
+            catch (err) {
+                throw new Error(`Step failed: ${text}`, { cause: err });
+            }
+        }, { location });
     }
 }
 exports.TestWorld = TestWorld;

package/adapter/PlaywrightWorld.js.map

@@ -1 +1 @@
-{"version":3,"file":"PlaywrightWorld.js","sourceRoot":"","sources":["../src/PlaywrightWorld.ts"],"names":[],"mappings":";;;AAAA,2CAAkG;AAGlG,MAAa,SAAS;IAClB,GAAG,CAA2B;IAC9B,MAAM,CAAyF;IAC/F,UAAU,CAAW;IACrB,MAAM,CAAyB;IAC/B,kBAAkB,CAAsB;IACxC,IAAI,GAAG,WAAI,CAAC;IACZ,MAAM,GAAG,aAAM,CAAC;IAEhB,YAAY,OAAqB;QAC7B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAO,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAmB,CAAC;QACtD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAO,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,WAAW,CAAkB,IAAY,EAAE,UAAoB;QACjE,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe;aAChD,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,kBAAkB,CAAC,CAAC;QACzE,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnB,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpE,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,yCAAyC,SAAS,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3F,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;QAC7D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;CACJ;AAjCD,8BAiCC;AAED,MAAa,eAAgB,SAAQ,SAAS;IAC1C,IAAI,CAAQ;IACZ,OAAO,CAAkB;IACzB,OAAO,CAAW;IAClB,WAAW,CAAU;IACrB,OAAO,CAAqB;IAE5B,uGAAuG;IACvG,IAAI,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAyF,EAAE,EAAE;QACnI,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC,CAA4B,CAAC;CACjC;AAdD,0CAcC"}
+{"version":3,"file":"PlaywrightWorld.js","sourceRoot":"","sources":["../src/PlaywrightWorld.ts"],"names":[],"mappings":";;;AAAA,2CAAkG;AAElG,uCAAwD;AACxD,uCAA2D;AAE3D;IACI,GAAG,CAA2B;IAC9B,MAAM,CAAY;IAClB,UAAU,CAAW;IACrB,MAAM,CAAyB;IAC/B,kBAAkB,CAAsB;IACxC,IAAI,GAAG,WAAI,CAAC;IACZ,MAAM,GAAG,aAAM,CAAC;IAEhB,YAAY,OAAqB;QAC7B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAO,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAmB,CAAC;QACtD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAO,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAkB,IAAY,EAAE,QAAkB;QAC/D,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe;aAChD,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,kBAAkB,CAAC,CAAC;QACzE,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnB,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpE,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,yCAAyC,SAAS,EAAE,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,IAAA,0BAAgB,EAAC,QAAQ,CAAC,CAAC;QACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACvF,8FAA8F;QAC9F,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAA,mBAAS,EAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC,EAAE,KAAK,IAAI,EAAE;YAC3E,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACrH,MAAM,IAAI,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,EAAE,KAAK,CAAC,CAAC;YACvE,IAAI,CAAC;gBACD,MAAM,IAAA,wBAAc,EAChB,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,EACjC,IAAA,wBAAc,EAAC,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,cAAc,CAAC,EAC5D,SAAS,IAAI,wCAAwC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAC/E,CAAC;YACN,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;YAC5D,CAAC;QACL,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrB,CAAC;CACJ;;AAED,qBAA6B,SAAQ,SAAS;IAC1C,IAAI,CAAQ;IACZ,OAAO,CAAkB;IACzB,OAAO,CAAW;IAClB,WAAW,CAAU;IACrB,OAAO,CAAqB;IAE5B,uGAAuG;IACvG,IAAI,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAyF,EAAE,EAAE;QACnI,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC,CAA4B,CAAC;CACjC"}

package/adapter/Template.d.ts

@@ -1,10 +1,21 @@
+export interface TemplateStep {
+    text: string;
+    argument?: string | string[][];
+}
+/**
+ * Parse template text into steps. Supports data tables (`| a | b |` lines)
+ * and doc strings (`"""` or ``` blocks) placed after a step.
+ */
+export declare function parseTemplate(scenario: string): TemplateStep[];
 /**
  * Define template step
- * @param {string} scenario - multiline string with steps
+ * @param {string} scenario - multiline string with steps; steps can have data tables and doc strings
  * @example
  * When('I click {string} and verify {string}', Template((locator, expected) => `
  *     I click '${locator}'
  *     I expect '${locator} > Value' to equal '${expected}'
+ *     I fill form
+ *       | name | John |
  * `));
  */
-export declare function Template(scenario: (...args: unknown[]) => string): (...args: unknown[]) => string;
+export declare function Template(scenario: (...args: any[]) => string): (...args: unknown[]) => string;

package/adapter/Template.js

@@ -1,25 +1,74 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseTemplate = parseTemplate;
 exports.Template = Template;
+const DOC_STRING_DELIMITERS = ['"""', '```'];
+function parseRow(line) {
+    const content = line.replace(/^\|/, '').replace(/(?<!\\)\|$/, '');
+    return content
+        .split(/(?<!\\)\|/)
+        .map(cell => cell.trim().replace(/\\\|/g, '|'));
+}
+function stripIndent(line, indent) {
+    const leading = line.length - line.trimStart().length;
+    return line.slice(Math.min(indent, leading));
+}
+/**
+ * Parse template text into steps. Supports data tables (`| a | b |` lines)
+ * and doc strings (`"""` or ``` blocks) placed after a step.
+ */
+function parseTemplate(scenario) {
+    const lines = scenario.split('\n');
+    const steps = [];
+    const previousStep = (line) => {
+        const step = steps.at(-1);
+        if (!step)
+            throw new Error(`Template argument "${line.trim()}" must follow a step`);
+        return step;
+    };
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        const trimmed = line.trim();
+        if (!trimmed)
+            continue;
+        const delimiter = DOC_STRING_DELIMITERS.find(d => trimmed.startsWith(d));
+        if (delimiter) {
+            const step = previousStep(line);
+            const indent = line.indexOf(delimiter);
+            const content = [];
+            for (i++; i < lines.length && lines[i].trim() !== delimiter; i++) {
+                content.push(stripIndent(lines[i], indent));
+            }
+            step.argument = content.join('\n');
+            continue;
+        }
+        if (trimmed.startsWith('|')) {
+            const step = previousStep(line);
+            if (!Array.isArray(step.argument))
+                step.argument = [];
+            step.argument.push(parseRow(trimmed));
+            continue;
+        }
+        steps.push({ text: trimmed });
+    }
+    return steps;
+}
 /**
  * Define template step
- * @param {string} scenario - multiline string with steps
+ * @param {string} scenario - multiline string with steps; steps can have data tables and doc strings
  * @example
  * When('I click {string} and verify {string}', Template((locator, expected) => `
  *     I click '${locator}'
  *     I expect '${locator} > Value' to equal '${expected}'
+ *     I fill form
+ *       | name | John |
  * `));
  */
 function Template(scenario) {
     return new Proxy(scenario, {
         apply: async function (template, world, args) {
-            const scenario = template(...args);
-            const steps = scenario
-                .split('\n')
-                .map(step => step.trim())
-                .filter(Boolean);
-            for (const step of steps) {
-                await world.executeStep(step);
+            for (const step of parseTemplate(template(...args))) {
+                await world.executeStep(step.text, step.argument);
             }
         },
     });

package/adapter/Template.js.map

@@ -1 +1 @@
-{"version":3,"file":"Template.js","sourceRoot":"","sources":["../src/Template.ts"],"names":[],"mappings":";;AAWA,4BAaC;AAtBD;;;;;;;;GAQG;AACH,SAAgB,QAAQ,CAAC,QAAwC;IAC7D,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE;QACvB,KAAK,EAAE,KAAK,WAAW,QAAwC,EAAE,KAAgB,EAAE,IAAe;YAC9F,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;YACnC,MAAM,KAAK,GAAG,QAAQ;iBACjB,KAAK,CAAC,IAAI,CAAC;iBACX,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;iBACxB,MAAM,CAAC,OAAO,CAAC,CAAC;YACrB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACvB,MAAM,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YAClC,CAAC;QACL,CAAC;KACJ,CAAC,CAAC;AACP,CAAC"}
+{"version":3,"file":"Template.js","sourceRoot":"","sources":["../src/Template.ts"],"names":[],"mappings":";;;;AAOA,MAAM,qBAAqB,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAE7C,SAAS,QAAQ,CAAC,IAAY;IAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;IAClE,OAAO,OAAO;SACT,KAAK,CAAC,WAAW,CAAC;SAClB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,WAAW,CAAC,IAAY,EAAE,MAAc;IAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC;IACtD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACH,uBAA8B,QAAgB;IAC1C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,KAAK,GAAmB,EAAE,CAAC;IACjC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,EAAE;QAClC,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC;QACpF,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC;IACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACtB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,OAAO;YAAE,SAAS;QACvB,MAAM,SAAS,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QACzE,IAAI,SAAS,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;YAChC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACvC,MAAM,OAAO,GAAa,EAAE,CAAC;YAC7B,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/D,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAChD,CAAC;YACD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnC,SAAS;QACb,CAAC;QACD,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAAE,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;YACtD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACtC,SAAS;QACb,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;;;;;GAUG;AACH,kBAAyB,QAAoC;IACzD,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE;QACvB,KAAK,EAAE,KAAK,WAAW,QAAwC,EAAE,KAAgB,EAAE,IAAe;YAC9F,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC;gBAClD,MAAM,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;KACJ,CAAC,CAAC;AACP,CAAC"}

package/adapter/cucumberAdapter.d.ts

@@ -1,2 +1,9 @@
+import type { Pickle } from '@cucumber/messages';
 import type { CucumberAdapterConfig } from './types';
+/**
+ * Create scenario filter from tag expressions keyed by their source (used in error messages),
+ * e.g. `{ 'tags option': config.tags, 'CUCUMBER_TAGS env variable': process.env.CUCUMBER_TAGS }`.
+ * All expressions must match.
+ */
+export declare function createTagFilter(sources: Record<string, string | undefined>): (pickle: Pickle) => boolean;
 export declare function defineConfig(config: CucumberAdapterConfig): void;