RuboCop GOV.UK

This repository provides common RuboCop rules for use with GOV.UK Ruby projects to comply with our style guides.

Installation

Add rubocop-govuk to your Gemfile and then run bundle install:

# Gemfile
gem 'rubocop-govuk'

Inherit rules from the gem by adding the following to your project's RuboCop config:

# .rubocop
inherit_gem:
  rubocop-govuk: 
    - config/default.yml

or if you also need Rails specific rules:

# .rubocop
inherit_gem:
  rubocop-govuk: 
    - config/default.yml
    - config/rails.yml

Usage

Run RuboCop:

bundle exec rubocop