Utilities for working with Gherkin documents and AST
- ✨ Formatting
- 👉 Translation of
.feature
files to.feature.md
- 🚶♂️ Document walker
- 📁 Document handler
Gherkin Utils is available on npm for JavaScript:
npm install @cucumber/gherkin-utils
Gherkin Utils is available on Maven Central for Java, by adding the dependency to your pom.xml
:
<dependencies>
<dependency>
<groupId>io.cucumber</groupId>
<artifactId>gherkin-utils</artifactId>
<version>9.0.0</version>
</dependency>
</dependencies>
The command-line tool can be used to format .feature
files or to translate .feature
files
into .feature.md
files.
The following example translates all .feature
files to .feature.md
files and then deletes the .feature
files (see Markdown with Gherkin).
Note: Globs must be quoted to prevent the shell from expanding the globs.
npx @cucumber/gherkin-utils format --move "features/**/*.feature" "features/**/*.feature.md"
For more details on usage, see the help menu.
npx @cucumber/gherkin-utils --help
This module can also be used as a library. It provides two main utilities, pretty
and gherkinDocumentWalker
.
This function takes a GherkinDocument as input and returns a pretty-printed representation in Gherkin or Markdown.
import { AstBuilder, GherkinClassicTokenMatcher, Parser } from '@cucumber/gherkin'
import { pretty } from '@cucumber/gherkin-utils'
import { IdGenerator } from '@cucumber/messages'
const uuidFn = IdGenerator.uuid()
const builder = new AstBuilder(uuidFn)
const matcher = new GherkinClassicTokenMatcher()
const parser = new Parser(builder, matcher)
const feature = `Feature:
Scenario:
Given step text`
const gherkinDocument = parser.parse(feature)
const formattedGherkinFeature = pretty(gherkinDocument)
/*
Feature:
Scenario:
Given step text
*/
const formattedGherkinMarkdownFeature = pretty(gherkinDocument, 'markdown')
/*
# Feature:
## Scenario:
* Given step text
*/
The GherkinDocumentWalker is a class for walking and filtering the AST produced by Gherkin after parsing a feature file.
When running walkGherkinDocument
on a GherkinDocument, it will produce a deep copy of the object.
It takes two arguments upon creation:
- filters: set of functions used to know if the walked elements are kept in the result. By default, all elements are kept.
- handlers: set of function that can be used to alter the produced elements.
Filtering keeps the meaning of the original GherkinDocument, which means:
- if a
Background
was present, it will always be in theFeature
(orRule
) - the kept scenarios will have the same steps and examples than the original
By default, all elements are accepted, which means that if you want to do filtering you should reject all other elements. To ease this, we also provide the rejectAllFilters
.
Here's an example:
import { GherkinDocumentWalker, rejectAllFilters } from '@cucumber/gherkin-utils';
// Only keeps scenarios which name include 'magic'
const filter = new GherkinDocumentWalker({
...rejectAllFilters,
...{ acceptScenario: (scenario) => scenario.name.includes('magic') },
})
// Makes a list with all the scenario names
const allScenarioNames: string[] = []
const scenarioNameFinder = new GherkinDocumentWalker({}, {
handleScenario: (scenario) => allScenarioNames.push(scenario.name),
})