grunt-contrib-nodeunit

Run Nodeunit unit tests.

npm install grunt-contrib-nodeunit
2 205 downloads in the last day
10 489 downloads in the last week
38 095 downloads in the last month

grunt-contrib-nodeunit v0.3.3 Build Status

Run Nodeunit unit tests.

Getting Started

This plugin requires Grunt ~0.4.0

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-contrib-nodeunit --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-contrib-nodeunit');

Nodeunit task

Run this task with the grunt nodeunit command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

This plugin provides server-side JavaScript unit testing via nodeunit. If you're looking to test JavaScript that uses window or the DOM, please use the grunt-contrib-qunit pluginqunit task.

Settings

options.reporter

  • Type: String
  • Default: 'grunt'

Specifies the reporter you want to use. For example, default, verbose or tap.

options.reporterOutput

  • Type: Boolean
  • Default: false

Specifies the file the reporter's output should be saved to. For example, tests.tap.

options.reporterOptions

  • Type: Object
  • Default: {}

Specifies the options passed to the reporter. For example, the junit reporter requires the output option to be set:

grunt.initConfig({
  nodeunit: {
    all: ['test/*_test.js'],
    options: {
      reporter: 'junit',
      reporterOptions: {
        output: 'outputdir'
      }
    }
  }
});

Usage examples

Wildcards

In this example, grunt nodeunit:all or grunt nodeunit will test all files ending with _test.js in the test directory.

grunt.initConfig({
  nodeunit: {
    all: ['test/*_test.js']
  }
});

With a slight modification, grunt nodeunit:all will test files matching the same pattern in the test directory and all subdirectories.

grunt.initConfig({
  nodeunit: {
    all: ['test/**/*_test.js']
  }
});

Using Other Reporters

To use a reporter other than the default one, you can specify the reporter and reporterOutput parameters.

grunt.initConfig({
  nodeunit: {
    all: ['test/*_test.js'],
    options: {
      reporter: 'tap',
      reporterOutput: 'tests.tap',
      reporterOptions: {
        output: 'outputdir'
      }
    }
  }
});

Release History

  • 2014-01-26   v0.3.0   Adds 'reporter' and 'reporterOutput' options.
  • 2013-10-19   v0.2.2   Allow missing operators on error object.
  • 2013-09-24   v0.2.1   Fix error display.
  • 2013-05-23   v0.2.0   Bump nodeunit to v0.8.0
  • 2013-02-15   v0.1.2   First official release for Grunt 0.4.0.
  • 2013-01-18   v0.1.2rc6   Updating grunt/gruntplugin dependencies to rc6. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions.
  • 2013-01-09   v0.1.2rc5   Updating to work with grunt v0.4.0rc5. Switching to this.filesSrc api.
  • 2012-11-13   v0.1.1   Switch to this.file api internally.
  • 2012-11-04   v0.1.0   Work in progress, not yet officially released.

Task submitted by "Cowboy" Ben Alman

This file was generated on Tue Mar 11 2014 18:48:11.

npm loves you