A grunt task that reads a folder of Cucumber/SpecFlow feature files and generates an html report
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
test
.gitignore
.jshintrc
.travis.yml
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

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: Build Status

NPM

Getting Started

This plugin requires Grunt ~0.4.2

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

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:

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().

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.