##grunt-fail
Stop grunt execution with an error message and exit code of choice.
###Installation
- Change directories to the root directory of your project
npm install grunt-fail- Add the following line to your
Gruntfile.js
grunt.loadNpmTasks('grunt-fail');###Usage
The simplest usage is without any arguments, e.g.
from the command line
grunt failfrom within a Gruntfile
grunt.registerTask('default', ['fail']);####Arguments
grunt-fail takes an optional error message and an optional exit code as arguments.
For example
grunt "fail:Don't deploy:26"If there is just one argument, it can be either a numerical exit code, or an error message.
The default message is "Failed on purpose."
The default exit code is 255.
####More examples
command line
grunt "fail:no thanks"Gruntfile
grunt.registerTask('test', ['vows', 'fail:99']);###Exit codes
Exit codes between 1 and 255 work well on all systems. Other codes may not work as expected.
Grunt doesn't consider an exit code of zero an error, so it won't fail. Don't use it!
Here are the exit codes used by grunt for reference.
###Bugs, etc.
Please report any bugs, feature requests, etc. to grunt-fail's github issue tracker.