Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel6
outlinefalse
stylenone
typeflat
printabletrue

Gherkin Keywords

Gherkin Keywordsinfo
Panel
bgColor#FFFFFF

All Gherkin keywords are highlighted using colour and bold font

image-20241001-112014.png
Note

No '*'

Note that using * (asterisk character) character as a step keyword is not supported as it does not improve readability of the examples

User Story Keywords

Panel
bgColor#FFFFFF

User Story Keywords

The commonly used set of user story keywords (As a, I want to, So that) can be entered in the Feature title section like below:

image-20240928-170258.png

...

Info

In order to

Instead of “So that” you can use

...

“In order

...

to” so that you can start with the why

image-20241001-094117.pngImage Modified
Info

...

User story keywords don’t need to be at the start of the line and you can use either lower or upper case as needed

image-20241001-094034.pngImage Modified

...

Info

The 'to’ part in the “I want to“ keyword can be omitted and in the “As a” keyword you can enter either “As a“ or “As an

image-20241001-094308.pngImage Modified

Simple Step Parameters

Panel
bgColor#FFFFFF

Simple parameters (those that are on the same line as the step keyword) can be highlighted by simply wrapping them in single or double quotes

image-20241001-094952.pngImage Modified

Scenario Outline Parameters

Panel
bgColor#FFFFFF

<> delimited step parameters which are used as part of Scenario Template or Scenario Outline are highlighted automatically in orange

...

image-20241001-130625.pngImage Added

Info

Use autocomplete

Use autocompletion support to quickly populate Examples table header section with the names of the parameters that you have used in parameterized steps above. Simply press 'Ctrl+Space' to bring up the auto completion menu

...

image-20241001-130806.pngImage Added

Info

Scenario outline parameters are also supported inside tabular step parameters

image-20241001-142943.pngImage Added

Doc String Step Parameters

Panel
bgColor#FFFFFF

Doc strings are highlighted in purple colour

...

image-20241001-135042.pngImage Added

Info

Backticks ```

The use of backtick characters instead of quotes

...

is supported

...

image-20241001-135156.pngImage Added

XML Step Parameters

Panel
bgColor#FFFFFF

If you enter 'xml' after the opening

...

characters of a

...

doc strings parameter then any XML that you enter before the closing

...

doc strings characters is automatically syntax highlighted

...

image-20241001-135818.pngImage Added

...

Tags

Panel
bgColor#FFFFFF

Tags are highlighted in grey colour

image-20241001-112249.pngImage Modified

Comments

Panel
bgColor#FFFFFF

Comments are highlighted in grey colour

image-20241001-143620.pngImage Added
Info

Fold comments

Comments spanning several lines can be conveniently folded using fold/unfold gutter icons

image-20241001-143744.pngImage Added

Questions & Answers

Panel
bgColor#FFFFFF

A comment prefix character '#' is used followed by ‘Q:' or 'A:’ to highlight questions and answers respectively. Or the more elaborate version: “Question:“ and “Answer:”

image-20241001-150955.pngImage Added
Info

Tip - you can turn off the showing of gutter icons on the left via an editor menu option shown below

image-20241001-151149.pngImage Added

Invalid text

Panel
bgColor#FFFFFF

If there is any text that according to the Cucumber Gherkin syntax does not belong to any of the Feature file elements, then it is underlined in red and an error icon is shown in the gutter

image-20241001-151652.pngImage Added

Note that such errors to be highlighted the 'Errors' option in the Gutter options drop down menu must be turned on as shown below

image-20241001-151856.pngImage Added