Version Dependencies Build Status Coverage Code Climate

GitHooks

Some usefull git hooks, it's written on ruby but can be used for other languages.

Installation

Add this line to your application's Gemfile:

gem 'git-hooks'

And then execute:

$ bundle

Or install it yourself as:

$ gem install git-hooks

Usage

Install git_hooks on project.

$ git_hooks install pre-commit [--force]

Create configuration file

Create a .git_hooks.yml on project root.

$ git_hooks init

By now you will find only some simple hooks to:

  • Prevent commit on master.
  • Prevent commit with rubocop offences.
  • Prevent commit with broken rspec tests.
  • Prevent commit with debugger
  • Prevent trailing whitespace

Ensure hooks existence

To ensure that hooks exists on .git/hooks, include on your application start up (probably config/environments/development.rb or config/environments/test.rb)

GitHooks.validate_hooks!

This will force git_hooks installation before your application start.

Contributing

  1. Fork it ( https://github.com/stupied4ever/ruby-git-hooks/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request