Repository is archived
No commit activity in last 3 years
No release in over 3 years
Commsworld House Style: A centralised store of house style rules.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

 Project Readme

⚠️ DEPRECATION WARNING

This project has been replaced by commsworld/rubocop-commsworld which has approximately the same opinions about rubocop settings, and some custom cops.

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.