0.01
A long-lived project that still receives updates
SCC style guides and shared style configs.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Scc::Codestyle

Shared Ruby style guide used by the SCC Team.

Installation

Add this line to your application's Gemfile:

group :test, :development do
  gem 'scc-codestyle'
end

You do not need to include RuboCop directly in your application's dependencies. Scc::Codestyle will include a specific version of rubocop and rubocop-rspec that is shared across all projects.

Usage

Create a .rubocop.yml with the following directives:

inherit_gem:
  scc-codestyle:
    - default.yml

Now, run:

$ bundle exec rubocop

You can also automatically generate a .rubocop_todo.yml file to temporarily ignore failing cops until the offenses are removed from your code base. Run:

$ bundle exec rubocop --auto-gen-config

And add this to .rubocop.yml below the previous block:

inherit_from: .rubocop_todo.yml

Development

Build the docker container with:

$ make build

And then enter in the container with:

$ make console