rubocop-rails-accessibility icon indicating copy to clipboard operation
rubocop-rails-accessibility copied to clipboard

This repository provides recommended RuboCop configuration and additional accessibility RuboCop Rails cops for use on open source and internal Rails projects.

RuboCop Rails Accessibility

This repository provides recommended RuboCop configuration and additional accessibility RuboCop Rails cops for use on open source and internal Rails projects.

Installation

Install the rubocop-rails-accessibility gem

gem install rubocop-rails-accessibility

or if you use bundler put this in your Gemfile

gem 'rubocop-rails-accessibility'
gem "rubocop-performance", require: false
gem "rubocop-rails", require: false

Usage

You need to tell RuboCop to load RuboCop Rails Accessibility.

Put this into your .rubocop.yml.

require:
  - rubocop-rails-accessibility

Testing

Install all of the required gems

bundle install

Run the tests

bundle exec rake

The Cops

All cops are located under lib/rubocop/cop/rails_accessibility, and contain examples/documentation.

Rules

  • RailsAccessibility/ImageHasAlt
  • RailsAccessibility/NoPositiveTabindex
  • RailsAccessibility/NoRedundantImageAlt

Contributing

If you have any suggestion for how this project could be improved, please read the contributing guidelines.