Question 1

How to ignore files in gherkin-lint?

Accepted Answer

Use a .gherkin-lintignore file with glob patterns or the -i command-line option. For example, add 'legacy/**' to ignore all files in a legacy directory, overriding settings if needed.

Question 2

How to write a custom rule for gherkin-lint?

Accepted Answer

Create JavaScript files in a directory and load them with the --rulesdir option. The README points to the 'no-empty-file' rule as a simple example, which checks for empty feature files to guide development.

Question 3

Gherkin-lint vs Cucumber's built-in validator: which is better?

Accepted Answer

Gherkin-lint offers more extensive and configurable style and consistency checks beyond Cucumber's basic syntax validation. If you need advanced enforcement like tag rules or custom linting, gherkin-lint is superior, but for simple validation, Cucumber's tools may suffice.

Question 4

Can gherkin-lint be integrated with pre-commit hooks?

Accepted Answer

Yes, as a Node.js package, it can be added to npm scripts or husky pre-commit hooks to run on staged feature files, automating quality checks before commits.

Question 5

What rules are always on in gherkin-lint?

Accepted Answer

Rules like 'no-tags-on-backgrounds' and 'no-multiline-steps' are non-configurable and always enabled because they prevent crashes in the underlying Gherkin parser, as noted in the README.

Question 6

How to set up indentation rules in gherkin-lint?

Accepted Answer

Configure the 'indentation' rule in .gherkin-lintrc with specific spaces for elements like Feature or Step. For instance, set 'Step': 2 to enforce two-space indentation for all steps, overriding defaults.

gherkin-lint

What is gherkin-lint?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions