Java - Pre-Commit Checkstyle

Useful pre-commit hook for linting Java code. It uses as default The Google Style Guide

It uses the famous Checkstyle linter as a plugin for pre-commit.

Demo

Installation

First install the gems.

Pre-Commit Checkstyle

gem install pre-commit

Java Checkstyle Plugin

gem install java-checkstyle

Configuring

Use the pre-commit command to generate a stub pre-commit hook. Inside folder of your git repo:

pre-commit install

It will create a .git/hooks/pre-commit script which will check your git config and run checks that are enabled.

Enabling checks

pre-commit enable git checks checkstyle

OR

pre-commit enable yaml checks checkstyle

Result

Every time you try to commit some java code with style errors it will validate before.

---

Detailed version to install.

Still don't work? Try the detailed version here

---

Installing with RVM

If you are using rvm you need to install pre-commit into the default gemset, because it does not use the current environment

$ rvm default do gem install pre-commit

Alternatively you can configure pre-commit to use the current rvm gemset

$ git config pre-commit.ruby "rvm `rvm current` do ruby"

More details about this part see on: pre-commit

And your pre-commit hook has been configured.

Checkstyle Guide

It uses as default The Google Style Guide.

Tests

Running tests with rspec

Make sure you have been executed:

bundle install

Then run:

rspec

Contributing

1. Fork it
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 new Pull Request

Codeclimate

Before push, make sure you have been executed rubocop

rubocop lib/*

Pull request should have Unit Tests

Authors:

• Allen Madsen (Original Version 0.0.1)
• Alex Rocha
• Cristian Oliveira