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

gurkencheck A linter for Gherkin feature files.

no-restricted-tags

Bans tags you do not want committed.

What it does#

Tags such as @wip or @only are handy while you work and harmful once merged. List them here and nobody can commit them by accident.

Turning it on#

Add this to your .gurkencheckrc:

{
  "no-restricted-tags": ["on", {
    "tags": ["@wip", "@only"],
    "patterns": ["^@debug"]
  }]
}

Settings#

SettingValueIf you leave it outWhat it does
tags list of tag names empty list Tags that are forbidden, written exactly as they appear.
patterns list of regular expressions empty list A tag is forbidden when it matches any of these.

Examples#

Passes
@smoke
Feature: Logging in

  Scenario: A known user logs in
    Given I am a known user
Fails
@wip
Feature: Logging in

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

gurkencheck reports: Forbidden tag @wip on Feature