grunt-commitplease

Validate strings as jQuery commit messages

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

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

grunt.loadNpmTasks('grunt-commitplease');

commitplease task

Run this task with the grunt commitplease command.

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

For more explanations of the errors commitplease will throw at you please visit jzaefferer/commitplease.

Options

Any specified option will be passed through directly to jzaefferer/commitplease, thus you can specify any option that it supports. See jzaefferer/commitplease documentation for a list of supported options.

path

Type: String Default: . ()

The path to the repository.

committish

Type: String Default: HEAD (current branch)

Committish range to analyze.

License

MIT © Rafael Xavier de Souza