Spicerack::Styleguide
Wanna write code the Freshly way? Inherit this gem in your rubocop.yml and keep your code fresh
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
If your project doesn't have a rubocop file yet (and it's a Rails project), this generator will your life a little easier:
$ rails g spicerack:spicerack
create .rubocop.yml
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
This... is a yml. You don't develop it. Go home, boilerplate gem README text, you're drunk!
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/RubyAfterAll/spicerack.
License
The gem is available as open source under the terms of the MIT License.