Lcgstyle - Version Pinned rubocop and sane defaults for Ruby
This is an internal style guide for chef ruby projects (chef-client, ohai, mixlib-shellout, mixlib-config, etc).
It is not meant for consumption by cookbooks or for any general purpose uses. It is not intended for any audience outside of chef core ruby development.
It will have many rules that are disabled simply because fixing a project as large as chef-client would be tedious and have little value. It will have other rules that are disabled because chef exposes edge conditions that make them falsely alert. Other rules will be selected based on the biases of the core chef developers which are often violently at odds with the rubocop core developers over ruby style.
Pull requests to this repo will not be accepted without corresponding PRs into at least the chef-client and ohai codebases to clean the code up. PRs will not be accepted that assume unfunded mandates for other people to finish the work. Do not open PRs offering opinions or suggestions without offering to do the work.
The project itself is a derivative of finstyle, but starts with all rules disabled. The active ruleset is in the config/lcgstyle.yml file.
How It Works
This library has a direct dependency on one specific version of RuboCop (at a time), and [patches it][patch] to load the [upstream configuration][upstream] and [custom set][config] of rule updates. When a new RuboCop release comes out, this library can rev its pinned version dependency and [re-vendor][rakefile] the upstream configuration to determine if any breaking style or lint rules were added/dropped/reversed/etc.
Installation
Add this line to your application's Gemfile:
gem 'lcgstyle'
And then execute:
$ bundle
Or install it yourself as:
$ gem install lcgstyle
Usage
Vanilla RuboCop
Run RuboCop as normal, simply add a -r lcgstyle
option when running:
rubocop -r lcgstyle -D --format offenses
lcgstyle Command
Use this tool just as you would RuboCop, but invoke the lcgstyle
binary
instead which patches RuboCop to load rules from the lcgstyle gem. For example:
lcgstyle -D --format offenses
Rake
In a Rakefile, the setup is exactly the same, except you need to require the lcgstyle library first:
require "lcgstyle"
require "rubocop/rake_task"
RuboCop::RakeTask.new do |task|
task. << "--display-cop-names"
end
guard-rubocop
You can use one of two methods. The simplest is to add the -r lcgstyle
option to the :cli
option in your Guardfile:
guard :rubocop, cli: "-r lcgstyle" do
watch(%r{.+\.rb$})
watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
end
Alternatively you could pass the path to Lcgstyle's configuration by using the Lcgstyle.config
method:
require "lcgstyle"
guard :rubocop, cli: "--config #{Lcgstyle.config}" do
watch(%r{.+\.rb$})
watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
end
.rubocop.yml
As with vanilla RuboCop, any custom settings can still be placed in a .rubocop.yml
file in the root of your project.