@gherlint/gherlint

GherLint

GherLint, a tool for checking patterns on Gherkin files.

Installation

Using npm:

npm install -D @gherlint/gherlint

Using yarn:

yarn add -D @gherlint/gherlint

Usage

npx gherlint features/

Apply fix with --fix option.

npx gherlint --fix features/

Configuration

GherLint supports configuring rules and other options via a config file. We support the following config file formats:

NOTE: Priority is given to the config file in the following order:

.gherlintrc
.gherlintrc.js
.gherlintrc.json

See Configuration for defaults.

Code of Conduct

GherLint adheres to this Code of Conduct.

Contributing

Please make sure to read our Contributing Guide before making a pull request.

Feature Request / Bug Report

Please make sure to follow the issue templates when opening an issue.

For a feature request, use this template: Feature Request.

For a bug report, use this template: Bug Report.

Adding New Rule

If you want to contribute by adding a new rule, please follow the Adding New Rule guide.

License

MIT License