BOXT Ruby Style Guide

Ruby style guide and base Rubocop settings for Boxt Ruby projects.

For the most part we are using this Ruby style guide as the base guide, with any deviations can be found in the default.yml.

Installation

Add this line to your application's Gemfile:

group :development, :test do
  # ...
  gem "boxt_ruby_style_guide"
end

And then execute:

bundle

To make the lint rake tasks available to non Rails apps and gems, add the following to the project's Rakefile:

require "boxt_ruby_style_guide"
BoxtRubyStyleGuide.install_tasks

Rails apps should have access to the lint tasks by default.

Add a .rubocop.yml file to the root of your project with the following settings:

inherit_gem:
  boxt-ruby-style-guide:
    - default.yml

Lint tasks to run against files listed as changed by Git.

To run rubocop against any changed files use:

rake lint:rubocop

If there are no changed files the commands will run against all files.

There are also some useful Rubocop editor plugins to help with in-editor linting.

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

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