Sha256: 583fac8e05aba7d3ab855493aaaaaa489a752bf2d415338a9e27be286451342e
Contents?: true
Size: 696 Bytes
Versions: 9
Compression:
Stored size: 696 Bytes
Contents
# RuboCop GOV.UK
This repository provides common RuboCop rules for use with GOV.UK Ruby projects to comply with our [style guides][guides].
## Installation
Add `rubocop-govuk` to your Gemfile and then run `bundle install`:
```ruby
# Gemfile
gem 'rubocop-govuk'
```
Inherit rules from the gem by adding the following to your project's RuboCop config:
```yaml
# .rubocop.yml
inherit_gem:
rubocop-govuk:
- config/default.yml
```
or if you also need Rails specific rules:
```yaml
# .rubocop.yml
inherit_gem:
rubocop-govuk:
- config/default.yml
- config/rails.yml
```
## Usage
Run RuboCop:
```sh
bundle exec rubocop
```
[guides]: https://github.com/alphagov/styleguides
Version data entries
9 entries across 9 versions & 1 rubygems