This repository and Gem has been deprecated and is no longer supported.
To lint Ruby and RSpec projects please consider using rubocop with rubocop-govuk.
To lint SASS projects please consider using scss-lint with scss-lint-govuk.
For guidance on upgrading to these tools see the migrate from govuk-lint page in the developer docs.
This repo configures various linters to comply with our style guides.
We maintain a set of tasks for linting and sanity checks in the gds-operations/puppet-syntax repository.
Linter: rubocop
To use, include govuk-lint in your Gemfile and run:
bundle exec govuk-lint-ruby <files and directories>
It's best to lint just your app directories and not those belonging to the framework, e.g.
bundle exec govuk-lint-ruby app lib spec
Useful options:
-a: Auto-correct violations if possible-R: Also run Rails-specific cops--diff: Only lint lines that have been changed in the current diff--cached: Used with--diffto lint only lines changed betweenorigin/masterandHEAD.
See more options in the rubocop README.
You can enable RSpec cops by adding the following line to the .rubocop.yml file in your project:
require: rubocop-rspec
Linter: scss-lint
To use, include govuk-lint in your Gemfile and run:
bundle exec govuk-lint-sass <directory or file>
bundle exec govuk-lint-sass app/assets/stylesheets
When linting your app any assets within vendor will be ignored by
default.
Auto-correction and --diff mode are unavailable.