grunt-simple-mocha's Introduction

grunt-simple-mocha

A simple wrapper for running tests with Mocha. It's pretty much a cleaned up and plugin-ized version of this helpful Gist by johnkpaul.

If you're looking to run client-side specs with PhantomJS, you might be interested in grunt-mocha.

Updating from 0.1.x

Important: If you were using 0.1.x, the task name has changed from mocha to simplemocha to avoid confusion with grunt-mocha. Please make sure your grunt.js file is updated. See #3.

Installation

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-simple-mocha
Then add this line to your project's grunt.js gruntfile:
```
grunt.loadNpmTasks('grunt-simple-mocha');
```

Usage

In your grunt.js:

grunt.initConfig({
  simplemocha: {
    all: {
      src: 'test/**/*.js',
      options: {
        globals: ['should'],
        timeout: 3000,
        ignoreLeaks: false,
        grep: '*-test',
        ui: 'bdd',
        reporter: 'tap'
      }
    }
  }
});

// For this to work, you need to have run `npm install grunt-simple-mocha`
grunt.loadNpmTasks('grunt-simple-mocha');

// Add a default task. This is optional, of course :)
grunt.registerTask('default', 'simplemocha');

Now, you can just run grunt simplemocha in your shell to run the tests. That's it!

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.