A11y::Lint

A Ruby gem for checking accessibility issues in your code.

Add the gem to your application's Gemfile:

gem "a11y-lint"

Then run:

bundle install

Or install it directly:

gem install a11y-lint

Run the linter on specific files or directories:

a11y-lint app/views/
a11y-lint app/views/home.html.slim app/views/about.html.slim

With no arguments, it scans the current directory recursively for .slim and .erb files:

a11y-lint

Create a .a11y-lint.yml file in your project root to enable or disable individual rules:

ImgMissingAlt:
  Enabled: false

ImageTagMissingAlt:
  Enabled: true

Rules not listed in the file are enabled by default. The linter searches for .a11y-lint.yml starting from the target directory and walking up to the filesystem root.

To specify a config file explicitly:

a11y-lint --config path/to/.a11y-lint.yml app/views/

require "a11y/lint"

source = File.read("app/views/home.html.slim")
runner = A11y::Lint::SlimRunner.new([A11y::Lint::Rules::ImgMissingAlt.new])
offenses = runner.run(source, filename: "app/views/home.html.slim")

offenses.each do |offense|
  puts "#{offense.filename}:#{offense.line} [#{offense.rule}] #{offense.message}"
end

• Ruby >= 3.1.0

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To run all checks (tests + linting):

bundle exec rake

To install this gem onto your local machine, run bundle exec rake install.

Bug reports and pull requests are welcome on GitHub at https://github.com/Guided-Rails/a11y-lint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the A11y::Lint project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.