Skip to content

Gherkin RefineA Gherkin linter you can trust in CI

Fast, deterministic linting and safe fixes for Cucumber feature files, built on the official parser.

Install ​

sh
npm install --save-dev gherkin-refine
npx gherkin-refine .

Requires Node.js 22.18 or later. Continue to Getting started for configuration, safe fixes, and GitHub Actions.

Read the practical tutorial on the original site, Medium, or DEV.to.

Guides ​

  1. Getting started installs the CLI, runs it in GitHub Actions, and applies safe fixes.
  2. Migration describes migrating from gherkin-lint.
  3. Comparison compares Gherkin Refine with gherkin-lint feature by feature.
  4. Configuration explains config files, rule options, overrides, and inline suppression.
  5. Rules lists the built in rules and their defaults.
  6. Plugins explains how to write and load custom rules.
  7. AI agent integration covers structured output and an agent remediation loop.

Technical notes ​

  1. Architecture describes the parser, lint pipeline, and public interfaces.
  2. Performance documents the benchmark method and a local measurement.

Released under the MIT License.