Skip to content
Joe Geldart edited this page Mar 24, 2015 · 1 revision

Eyemask is a tool to help you make richer specifications for your stakeholders, including easy diagrams and other pictures. This will help you collaborate more effectively, and increase the value you get from Behaviour Driven Development practices.

The tool works using the output of the Cucumber JSON formatter and can function as a UNIX filter. This lets you do any preprocessing you want, and send the output into another tool. This can be used as part of a pipeline of tools to deliver up to date rich specifications. Adding this as a job on a CI system would let you combine the benefits of a traditional specification document, with those of living documentation.

Features

  • Treats any descriptive text (that before a scenario header or between that and the first Given, When, or Then) as Markdown and includes it in the output.
  • Special support for the inclusion of call-out boxes for questions, stories, and other notes.
  • Special support for embedded diagrams using a simple text syntax if you install PlantUML.
  • Includes templates optimised for use with PrinceXML for high-quality output.
  • Ability to create your own templates to suit your circumstances.
Clone this wiki locally