https://github.com/opentable/grunt-gherkin-report
A grunt task that reads a folder of Cucumber/SpecFlow feature files and generates an html report
https://github.com/opentable/grunt-gherkin-report
Last synced: about 1 year ago
JSON representation
A grunt task that reads a folder of Cucumber/SpecFlow feature files and generates an html report
- Host: GitHub
- URL: https://github.com/opentable/grunt-gherkin-report
- Owner: opentable
- License: mit
- Created: 2014-03-10T03:10:18.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2016-02-20T23:03:48.000Z (over 10 years ago)
- Last Synced: 2024-11-01T22:38:48.408Z (over 1 year ago)
- Language: JavaScript
- Size: 304 KB
- Stars: 2
- Watchers: 26
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-gherkin-report
> It saves your gherkin features (generated by Cucumber, SpecFlow, Cucumber.js...) in a friendly html format
Node version: **0.8.0** required
Build status: [](http://travis-ci.org/opentable/grunt-gherkin-report)
[](https://npmjs.org/package/grunt-gherkin-report)
## Getting Started
This plugin requires Grunt `~0.4.2`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-gherkin-report --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-gherkin-report');
```
## The "gherkin_report" task
### Overview
In your project's Gruntfile, add a section named `gherkin_report` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
gherkin_report: {
my_project: {
// Target-specific file lists and/or options go here.
options: {
title: 'My project\'s features',
subtitle: 'Generated on ' + (new Date()).toISOString() + ', version: ' + grunt.option('versionNumber') || 'unknown',
destination: 'path-to-output/report.html'
},
files: [{
cwd: 'path/to/my/features',
src: ['**/*.feature']
}]
},
},
});
```
### Options
#### options.title
Type: `String`
The title of your report.
#### options.subtitle
Type: `String`
A string that is saved during the generation and placed on the top of the generated document. Cool to place a date and a version here. Look at the example.
#### options.destination
Type: `String`
The destination of your html report and its filename.
#### files
Type: `Object`
The features to import.