grunt-passfail

Run functions when your tasks complete or fail.

grunt-passfail

Run functions when your tasks complete or fail.

This plugin requires Grunt ~0.4.1

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-passfail --save-dev

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

grunt.loadNpmTasks('grunt-passfail');

In your project's Gruntfile, add a section named passfail to the data object passed into grunt.initConfig().

grunt.initConfig({
  passfail: {
    options: {
      // Task-specific options go here. 
    },
    your_target: {
      // Target-specific file lists and/or options go here. 
    },
  },
})

All callbacks called in task context, giving you access to the "inside tasks" API: http://gruntjs.com/api/inside-tasks

Could be useful, for example, to run async logic with this.async

Type: Boolean Default value: true

Alias for the --force option on the command line. Defaults to true. This plugin won't work without force, since it will presumably be the last task run and will never be run if a previous task fails without --force set.

Type: Function

A function to be run when at least one warning or error has occured anywhere in the current task. Is passed the number of warnings and errors occurred.

callback(warncount, errorcount)

Type: Function

A function to be run when no errors nor warnings have occurred. Also, the options ignoreWarn and ignoreError can be supplied to affect the condition on which success is callled.

Type: Function

A function to be run when at least one error has occurred in the current task. It is passed the number of errors occurred.

callback(errorcount)

Type: Function

A function to be run when at least one warning has occurred in the current task. It is passed the number of warnings occurred.

callback(warncount)

Type: Boolean Default: false

If set to true, warnings will not affect whether the success function will be run.

Type: Boolean Default: false

If set to true, errors will not affect whether the success function will be run.

grunt.initConfig({
  passfail: {
    all: {
      successfunction() {
        console.log("Cool :)")
      },
      failfunction() {
        console.log("Lame :'(")
      }
    }
  }
})
  • Use this.requires for success / fail checking?
  • Allow customizable success and failure conditions?

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.