Repository is archived
No commit activity in last 3 years
No release in over 3 years
Hint shared Rubocop style guide
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.15
~> 10.0

Runtime

 Project Readme

Hint::RubocopStyle

Shared Hint Rubocop style config

Installation

Add this line to your application's Gemfile:

group :development, :test do
  gem 'hint-rubocop_style'
end

This gem includes Rubocop and RubocopRspec as dependencies.

And then execute:

$ bundle

Or install it yourself as:

$ gem install hint-rubocop_style

Usage

Either create or update the .rubocop.yml with the following:

inherit_gem:
  hint-rubocop_style:
    - default.yml

AllCops:
  TargetRubyVersion: PROJECT_RUBY_VERSION
  TargetRailsVersion: PROJECT_RAILS_VERSION
  DisplayCopNames: true
  Exclude:
    - 'bin/**/*'
    - 'config/**/*'
    - 'db/**/*'
    - 'Gemfile*'
    - 'script/**/*'
    - 'test/**/*'
    - 'vendor/**/*'

If there are project specific styles you can override the Hint gem by adding them to .rubocop.yml

Rubocop's inheritance trail is:

inherit_gem -> inherit_from -> .rubocop.yml

Contributing

Pull requests are welcome on GitHub at https://github.com/hintmedia/hint-rubocop_style.

License

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