You are reading the documentation for gurkencheck 0.0.10. Go to version 0.0.10.

gurkencheck A linter for Gherkin feature files.

file-name

Keeps every feature file named in the same style.

What it does#

Mixed file naming makes a folder hard to scan. Pick one style and this rule tells you the exact name to rename a file to.

Turning it on#

Add this to your .gurkencheckrc:

{
  "file-name": ["on", {"style": "kebab-case"}]
}

Settings#

SettingValueIf you leave it outWhat it does
style one of PascalCase, Title Case, camelCase, kebab-case, snake_case PascalCase The naming style every feature file has to follow.

Examples#

Passes
# File: logging-in.feature
Feature: Logging in

  Scenario: A known user logs in
    Given I am a known user
Fails
# File: LoggingIn.feature
Feature: Logging in

  Scenario: A known user logs in
    Given I am a known user

gurkencheck reports: File names should be written in kebab-case e.g. "logging-in.feature"