grunt-git-hooks

grunt-git-hooks

A Grunt plugin to help bind Grunt tasks to Git Hooks

Getting Started

This plugin requires Grunt ~0.4.5

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-git-hooks --save-dev

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

grunt.loadNpmTasks('grunt-git-hooks');

grunt-git-hooks task

Run this task with the grunt git-hooks command.

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

Usage Example

module.exports = function (grunt) {
	grunt.initConfig({
		'git-hooks': {
			hooks: {
				'prepare-commit-msg': 'hooks/prepare-commit-msg.sh'
			}
		}
	});

	grunt.loadNpmTasks('grunt-git-hooks');
	grunt.registerTask('default', ['git-hooks']);
};

Result

.git/hooks/prepare-commit-msg

NOTE: Grunt tasks will not remove your hooks (only copying)!

Options

git

Type: string
Default: .git

This option as an advanced way to choose in which directory the hooks should be placed.

grunt.initConfig({
	'git-hooks': {
		options: {
			git: '.git'
		},

		hooks: {
			'prepare-commit-msg': 'prepare-commit-msg.sh'
		}
	}
});

Tests

grunt test

License

MIT

Links

Git Hooks

Task submitted by Alexander Abashkin