README.md

ScaffoLint

The linter file that doesn't lead junior developers to bad habits.

Read .rubocop.yml for details.

Quickstart

1. Add Rubocop to your Gemfile

   group :development, :test do
     gem "rubocop", "1.20"
   end

2. Run bundle install

3. Copy the ScaffoLint config file to your project

   ; curl -o .rubocop.yml https://raw.githubusercontent.com/makersacademy/scaffolint/v2.2.0/.rubocop-stub.yml

   Or, if you already have a Rubocop config file, add the relevant lines from the stub file.

4. Gitignore the cached Rubocop file

# File: .gitignore

# Local cache of Rubocop remote config
.rubocop-*

5. Run rubocop

Editor integration

We recommend installing Rubocop support for your editor to get fast feedback as you write your code:

• Visual Studio Code: ruby-rubocop extension
• Atom: linter-rubocop package