ArialLinter
ArialLinter main goal is to provide a simple accesibility linter for HTML documents. Our long-term vision is to enforce accesibility best practices directly into the developer workflow.
Getting Started
Grunt task
This plugin requires Grunt ~0.4.0
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile 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-arialinter --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-arialinter');
And then you should add the task, you can lint files and url's:
grunt.initConfig({
arialinter: {
files: [
'https://www.google.com/',
'<!doctype html><html lang="en"><head><title>titulo test</title></head><body style="background-color: white;"> <h1 style="color: black;">hola</h1><img src="asdf.jpg" alt="woop" /> <div class="entry"> <p>{{title}}</p> <h2>By {{author.name}}</h2> <div class="body">{{body}}</div></div> </body> </html>'
],
options: {
templates: true,
levels: 'A'
}
}
});
grunt.registerTask('default', ['arialinter']);
Note: If you dont specify a level, it will run for all the levels.
Nodejs
You can also use it with nodejs like a regular library
Install the package from npm
$ npm install arialinter --save-dev
And then you can consume the library:
var ArialLinter = require('arialinter');
var linter = new ArialLinter();
linter.initialize(fileOrUrl, function() {
if (linter.evaluate()){
console.log('success');
} else {
console.log('failed');
}
});
CLI
You can also run AriaLinter from the terminal
$ npm install -g arialinter
Display all the rules
$ arialinter --rules
Execute the linter just for templates
$ arialinter --templates test/testFiles/template.html
Execute the linter using all the rules of the level A
$ arialinter --level A test/testFiles/index.html
Execute the linter using all the rules of the level A and the rules that just apply for templates
$ arialinter --level A --templates test/testFiles/index.html
##Resources:
##License
Copyright (c) 2013 Globant UI Developers
Licensed under the MIT license.