grunt-a11y Build Status devDependency Status Dependency Status

Grunt wrapper for a11y(link is external), automate your accessibility audits

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt(link is external) before, be sure to check out the Getting Started(link is external) guide, as it explains how to create a Gruntfile(link is external) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-a11y --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-a11y');

The "a11y" task

Overview

In your project's Gruntfile, add a section named a11y to the data object passed into grunt.initConfig().


grunt.initConfig({
  a11y: {
    dev: {
      options: {
        urls: ['www.twitter.com', 'www.google.com', 'dist/**/*.html']
      }
    }
  }
});

Options

options.urls

Type: Array
Default value: []

An Array of strings representing the url's to process. Supports globbing.

options.failOnError

Type: Boolean
Default value: false

If set to true, the grunt task fails when there is an accessibility error in one of the audits.

options.viewportSize

Type: String
Default value: 1024x768

Sets the viewport size

options.vebose

Type: Boolean
Default value: false

Sets the viewport size

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt(link is external).

Contributors

Release History

0.1.5 Adds verbose flag. #19(link is external) Thanks to @srescio(link is external).

0.1.4 Makes protocolify and globby part of dependencies. #13(link is external)) Thanks to @shortdiv(link is external)

0.1.3 Added globbing possibility to urlsoption (See #12(link is external)) Thanks to @peterhaldbaek(link is external)

0.1.2 Added viewportSize option (See #10(link is external))

0.1.1 Added failOnError option (See #2(link is external))

0.1.0 First release just wrapping a11y

Rating

0 out of 5 Stars 0 Review

5 Stars
 
0.00%
4 Stars
 
0.00%
3 Stars
 
0.00%
2 Stars
 
0.00%
1 Star
 
0.00%

About

  • There are no comments yet

Thank you! Review submitted.

Ok