DEPRECATED

This gem was deprecated on March 4th, 2022 after lying fallow for four years.

DlssCops

DlssCops is a Rubocop configuration gem that holds DLSS's baseline Ruby style guide. See https://github.com/sul-dlss/DeveloperPlaybook/tree/master/style for more information about the DLSS style. See https://github.com/bbatsov/rubocop for more information about Rubocop.

Installation

We recommend you use the latest version of DlssCops but if needed, you can select a specific version to manage change.

Add a development_dependency in your gem's gemspec file

  gemspec.add_development_dependency 'dlss_cops'

OR, if it's not a gem, add these lines to your Gemfile:

group :development, :test do
  gem 'dlss_cops'
end

Usage

Set up your .rubocop.yml file:

inherit_gem:
  dlss_cops: "config/dlss_baseline.yml"

AllCops:
  TargetRubyVersion: 2.2

Then you can launch rubocop via: bundle exec rubocop <options>

See https://github.com/bbatsov/rubocop#basic-usage for more information.