Chutney

This tool lints gherkin files

Read the documentation here.

Your documentation is precious and should be treated as such. Chutney is a tool to help you keep your gherkin files in good shape. It will help you to write better gherkin and keep your feature files consistent through an opinionated, but optional, set of rules.

Installation

Ruby

Chutney is a ruby gem, so relies on you having ruby installed. It requires ruby 3.2 or later.

For macOS, Linux or other Unix-like systems, I recommend using a version manager like rvm, asdf or rbenv.

For Windows, you can use RubyInstaller.

Chutney

To install chutney system-wide, run:

gem install chutney

To install chutney for a specific project, add it to your Gemfile:

gem 'chutney'

Usage

To run chutney, simply run:

chutney

It will search for any .feature files beneath the current directory and give you an opinion. It comes with a default set of rules and will give you a little nudge if you haven't got your own chutney configuration file.

To create a configuration file, run:

chutney --init

(Configuration files can in either .chutney.yml or .chutney.yml and reside in the top-level of the project or in a /config directory.)

See this page for a full list of the rules chutney encourages.

Notes

Chutney 3+ has replaced its direct dependency on Cucumber and instead uses the excellent cuke_modeller to parse your feature files.