Skip to content
Roberto Lo Giacco edited this page May 28, 2020 · 25 revisions

This project aims to build a set of Eclipse plugins to provide a smooth experience in editing and maintaining BDD files. The currently supported languages are Cucumber (Gherkin syntax) and JBehave, the latter still in early development stage.

Install

This plugin requires Eclipse 3.6 or above and Xtext 2.3.1 or above.

If you need instructions to install the plugin please have a look at the installation guide.

Update site

An Eclipse update site is available at http://rlogiacco.github.com/Natural.

Archived site

Archived sites are available from the releases section, but the update site is the preferred installation method as dependencies are resolved seamlessly.

Limitations

Help is needed

The current build is not able to provide step completion proposals for stepdefs classes depending from cucumber-java versions prior to 1.1.1 due to a different package naming: if you need such support you should clone the source repo, modify the sources and rebuild the plugin yourself.

The current plugin release is compatible with English feature files only: if you need support for a different language clone the source repo, modify the sources and rebuild the plugin yourself.

Contribute

If you wish to contribute to the plugin please have a look at the instructions.

Main Features

All you need for a smooth experience is there! Feel free to have a look at our screenshots if you like.

Syntax highlighting

Keywords are highlighted so that it will be much easier to follow through your files and explain them to your business partners. Please note that the syntax highlighting is completely customizable through Window > Preferences > Cucumber > Syntax Coloring

Auto completion

Type CTRL-space and you will be prompted with a list of grammar valid options or with a code template (look at the code templates feature for more details).

Step definition auto completion

Yes, you heard it right! When you are on a step definition type the usual CTRL-space and a list of valid step definition mappings will be prompted! Isn't it the cool feature you were looking for?

Outline navigation

Your files are becoming complex and long? No worries, use the outline view on your right to quickly find what you are looking for!

Grammar validation

Your grammar is being validated while you type, which means no more unnecessary executions just to check your files.

Hyperlink to Java mappings

This is the coolest: hover onto a step definition, hit the CTRL key and it will probably get highlighted in blue and underlined which means there's a Java method annotated to map to your step definition. It doesn't get hyperlinked? No worries, it means you do not have a mapping for it yet! Do you have multiple mappings for the same definition (which is probably bad)? You will get a list of options when you CTRL-hover over your step!

Step definition validation

Another cool feature: while you are editing your feature files a warning will be created if no definition can be found for a step or multiple matching definitions can be found! No more weird runtime behavior due to multiple matches!

Code templates

This I think will allow people to really speed up feature writing. It works as part of the code completion but it's user customizable: just open your plugin preferences (Window > Preferences > Cucumber > Templates) and start messing with the default ones!

Source formatting

Yes, you know what it is: just hit CTRL + SHIFT + F to have your source code pretty formatted with indentation all the bells and whistles of the editor there!

DocString support

Ever wondered how to push some raw data into your step description? not many knows about the Gherkin support for DocStrings (aka PyStrings) and now the editor supports them as well! Happy feature writing!