lewiseason / house-style

A shared house style for Ruby projects

House Style

Be nice and consistent from project to project.

This gem acts as a local repository for house style checkers for Ruby on Rails projects.

Heavily influenced by altimetric/house_style.

Installation

Add this gem as a dependency to your project's Gemfile:

gem "commsworld-house-style", "~> 2.0", group: [:development, :test]

And install:

bundle

Usage

For Rails projects, create a minimal .rubocop.yml file:

inherit_gem:
  commsworld-house-style: rubocop/rails.yml

If the project uses rspec:

inherit_gem:
  commsworld-house-style:
    - rubocop/rails.yml
    - rubocop/rspec.yml

Finally, add rubocop/rails32.yml if the app is a Rails 3.2 app.

License

This gem is available as open source under the terms of the MIT License.