Skip to content

Commit 850ceda

Browse files
jcundilllgandecki
authored andcommitted
docs: Updated README with IDE support notes. (#227)
1 parent aa86925 commit 850ceda

File tree

1 file changed

+12
-15
lines changed

1 file changed

+12
-15
lines changed

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ You can follow the documentation below, or if you prefer to hack on a working ex
3131
* [Output](#output)
3232
* [IDE support](#ide-support)
3333
* [Webstorm](#webstorm)
34+
* [Intellij IDEA](#intellij-IDEA)
35+
* [Visual Studio Code](#visual-Studio-Code)
3436
* [TypeScript Support](#typeScript-support)
3537
* [How to contribute](#how-to-contribute)
3638
* [Roadmap](#roadmap)
@@ -361,26 +363,21 @@ generate | `false` | Flag to output cucumber.json or not
361363
## IDE support
362364
363365
### WebStorm
364-
If you want WebStorm to resolve your steps, use the capitalized `Given/When/Then` function names (instead of the initial given/when/then).
365-
Unfortunately, at this point WebStorm only understands regexp syntax or a backtick syntax but without Cucumber Expressions :-(
366+
If you want WebStorm to resolve your steps, use the capitalized `Given/When/Then` function names (instead of the initial given/when/then).
366367
367-
In other words, these work:
368+
Note, only WebStorm 2019.2 and later versions are able to [resolve steps located outside of a step_definitions folder](https://youtrack.jetbrains.com/issue/WEB-11505)
368369
369-
```javascript
370-
Given(/^user navigated to the Start page?/, () => { });
371-
```
370+
### Intellij IDEA
371+
Intellij IDEA Community Edition does not support cucumber in javascript, but the Ultimate Edition can provide the same level support for step resolution as WebStorm.
372372
373-
```javascript
374-
Given(`user navigated to the start page`, () => { });
375-
Then(/(.*?) is chosen/, choice => {})
376-
```
373+
To enable cucumber step resolution in Intellij IDEA Ulimate edition you will need to download and enable the JetBrains [Cucumber JS plugin](https://plugins.jetbrains.com/plugin/7418-cucumber-js/). In WebStorm this plugin is already bundled into the distribution.
377374
378-
But this doesn't:
379-
```javascript
380-
Then(`{word} is chosen`, choice => {})
381-
```
375+
### Visual Studio Code
376+
To get vscode to resolve your steps, install the [Cucumber (Gherkin) Full Support](https://marketplace.visualstudio.com/items?itemName=alexkrechik.cucumberautocomplete) extension from the marketplace.
377+
378+
You will also need to tell the extension the locations of your feature and step definition files [as described here](https://github.com/alexkrechik/VSCucumberAutoComplete#settings-example).
382379
383-
*See [#56](https://github.com/TheBrainFamily/cypress-cucumber-preprocessor/issues/56) for more details*
380+
Note, that unlike WebStorm which will correctly identify multiple implementations of matching steps, the vscode extension currently resolves to the first matching occurence it finds on its path.
384381
385382
## TypeScript Support
386383

0 commit comments

Comments
 (0)