Interface: GherkinPluginOptions

@termwright/gherkin

---

@termwright/gherkin / GherkinPluginOptions

Interface: GherkinPluginOptions<Fixtures>

Defined in: plugin.ts:43

Options for a Gherkin transform using an optional project fixture surface.

Type Parameters

Fixtures

Fixtures extends object = Record<string, unknown>

Properties

featureRoot?

readonly optional featureRoot?: string

Defined in: plugin.ts:45

Directory against which feature paths and pairing templates are resolved. Defaults to Vite’s root.

---

fixtureNames?

readonly optional fixtureNames?: readonly Exclude<Extract<keyof Fixtures, string>, GherkinReservedFixtureName>[]

Defined in: plugin.ts:60

Custom test.extend() fixture names forwarded into every Gherkin context.

---

generatedImports?

readonly optional generatedImports?: GeneratedGherkinImports

Defined in: plugin.ts:58

Module specifiers emitted into transformed feature files.

---

includeFeatures?

readonly optional includeFeatures?: boolean

Defined in: plugin.ts:56

Add physical .feature files to Vitest discovery. Used by managed hosts such as termwright ui.

The feature patterns are derived from the resolved Vitest test.include patterns. This deliberately does not widen a narrowly configured suite to every feature below the project root.

---

stepDefinitions?

readonly optional stepDefinitions?: readonly string[]

Defined in: plugin.ts:47

Cypress-compatible [filepath] / [filepart] glue patterns.

---

tags?

readonly optional tags?: string

Defined in: plugin.ts:65

Cucumber tag expression selecting Scenario and Outline cases.