Gherkin Editor

This is a web based editor for Gherkin - the language Cucumber features are written in. It's based on Ace in the browser and Node.js on the server. It currently supports:

• Code completion
• Syntax highlighting (partly implemented in a fork of ace)
• Syntax checking based on Gherkin.js. More info about that in this thread

Planned features

• Simple refactorings, like renaming a step and having all other related steps in the project be renamed too. Related steps would be found using stepdef regexps.

Features that would be nice, but shouldn't go into this project

• Integration with external file systems, using WebDav or REST towards a dedicated git-enabled server.

What it looks like so far

Ace branches

Achieving the goals listed above will require several changes to Ace. So far there are a few branches with different features on cucumber's ace fork. There may be more. And some may go away if the Ace project accepts them. Rejected Ace pull requests will likely move into this project so we don't have to depend on a forked ace long term.

gherkin-mode

This is the syntax highlighting support for gherkin. Currently there is no i18n. We should generate the highlighter from a template using the technique described here. The Ace gherkin-mode is likely to move into this project instead of living in Ace.

ace-connect

This is a small patch to make it easier to serve ace from node, as explained in this pull request

gherkin-editor

This branch contains the changes on the other branches so that all our fixes can be used in this project

Install and run

npm link
git submodule update --init --recursive
make
node server.js

Now go to http://localhost:8000

Tests

(These are currently broken after a major rewrite of the autocomplete widget)

node_modules/.bin/jasmine-node spec

Want to help?

Join the Cucumber Mailing list and discuss!

Hacking on Ace

Only edit files under lib - not under build - they are generated. To regenerate after hacking:

cd vendor/ace
git submodule update --init --recursive
./Makefile.dryice.js normal

Make a feature branch for everything you do

TODO

• Gherkin-editor users won't understand regexp anchors. Display a '*', '?' or '-' instead.
• Move autocomplete widget to ace-autocomplete project once it matures? May improve quality long term (more contributors).
• Fix 404 for jquery-ui png images. Ideally generate jquery-ui css files from current theme.
• Figure out how require-js works so we don't need to require so many files in our HTML.
• Separate displaying of autocompleted text from its content - we may want to indent (or use other visual style for) step examples to separate them from step definitions