Spicerack::Styleguide

Gem Version Build Status Maintainability Test Coverage

Installation

Add this line to your application's Gemfile:

gem 'spicerack-styleguide'

And then execute:

$ bundle

Or install it yourself as:

$ gem install spicerack-styleguide

Usage

Add the following to the top of your rubocop.yml file - this will set your default Rubocop rules to anything we've set (which is most everything).

inherit_gem:
  spicerack-styleguide:
    - rubocop.yml

If you'd like to override any rules we've set, just list them underneath the inherit block:

inherit_gem:
  spicerack-styleguide:
    - rubocop.yml

# You're gonna want a flak jacket for this one
Style/StringLiterals:
  Enabled: true
  EnforcedStyle: single_quotes

Development

See https://github.com/Freshly/spicerack/blob/master/README.md

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Freshly/spicerack.

License

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