grunt-vows-test

A grunt task to run your Vows tests.

npm install grunt-vows-test
8 downloads in the last week
22 downloads in the last month

The project is no longer maintained and incompatible with grunt 0.4.x. Please check grunt-vows-runner or grunt-wows packages.


grunt-vows

A grunt task to run Vows tests.

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with:

npm install grunt-vows-test

Then add this line to your project's grunt.js gruntfile:

grunt.loadNpmTasks('grunt-vows-test');

To check the installation, type grunt --help - you should see a vows task in the Available tasks list.

If everything is OK, you can just run the grunt task:

grunt vows

By default, the task will run all tests located in test/ folder.

Documentation

Task configuration

As like any other grunt task, grunt-vows can be configured by adding a vows object to the grunt.initConfig method. There are 3 configuration options available here:

vows: {
  files: 'test/file.js', // a string or an array of files to be tested. Default: test/*.js
  reporter: 'dot-matrix|spec|tab', // one of Vows reporter to be used. Default: dot-matrix
  params: '' // Any other parameter you want pass to Vows. Run 'vows --help' to see the full list.
}

It's highly recomended to change the grunt's default task, so it runs vows test every time you type grunt:

grunt.registerTask('default', 'lint vows');

Vows test files

All your Vows tests must be exported, ie. they must follow the pattern below :

vows.describe('subject').addBatch({/* ... */}).export(module);

Please check Vows documentation if you need more information about exporting your test suite.

Contributing

The plugin was created one Sunday afternoon, when I suprisingly couldn't find any grunt taks to let me run Vows test for my personal project.

Any feedback, bug report or, even better, a pull request is highly appreciated. Don't hesitate to contact me on GitHub or just ping me on Twitter @lukaszfiszer.

The plugin is auto testing, using grunt vows. The test files is test\vows_test.js and use some sample test suites that can be found in sub-folders. When adding some new feature, please write a test for it!

Release History

  • 2012/09/22 - 0.1.0 - Initial release

License

Copyright (c) 2012 Lukasz Fiszer Licensed under the MIT license.

npm loves you