gulp-axe-webdriver
Gulp plugin for aXe utilizing WebDriverJS.
Inspired by grunt-axe-webdriver and gulp-axe-core.
This plugin checks local and remote urls.
Install
$ npm install --save-dev gulp-axe-webdriver
The task
Usage
var gulp = require('gulp');
var axe = require('gulp-axe-webdriver');
gulp.task('axe', function(done) {
var options = {
saveOutputIn: 'allHtml.json',
urls: ['http://www.foobar-url-1/', 'http://www.foobar-url-2/']
};
return axe(options, done);
});
With Chrome (default)
var gulp = require('gulp');
var axe = require('gulp-axe-webdriver');
gulp.task('axe', function(done) {
var options = {
saveOutputIn: 'allHtml.json',
urls: ['src/file2.html']
};
return axe(options, done);
});
With PhantomJS
var gulp = require('gulp');
var axe = require('gulp-axe-webdriver');
gulp.task('axe', function() {
var options = {
saveOutputIn: 'allHtml.json',
browser: 'phantomjs',
urls: ['src/file2.html']
};
return axe(options, done);
});
With Glob patterns
var gulp = require('gulp');
var axe = require('gulp-axe-webdriver');
gulp.task('axe', function() {
var options = {
saveOutputIn: 'allHtml.json',
browser: 'phantomjs',
urls: ['src/*.html', 'http://www.foobar-url-2/']
};
return axe(options, done);
});
Options
Type: Object
Default value:
{
threshold: 0,
browser: 'chrome',
folderOutputReport: 'aXeReports',
saveOutputIn: '',
tags: null
}
a11yCheckOptions
Type: Object
Specifies options to be used by axe.a11yCheck. Will override any other configured options. See axe-core API documentation for information on its structure.
browser
Type: String
Default value: chrome
Which browser to run the tests in.
exclude
Type: String
Default value: null
Add a CSS selector to the list of elements to exclude from analysis.
include
Type: String
Default value: null
Adds a CSS selector to the list of elements to include in analysis.
folderOutputReport
Type: String
Default value: aXeReports
An optional folder to indicate where the output will be saved.
saveOutputIn
Type: String
Default value: ''
An optional file to which the results of the accessibility scans will be written as a JSON Array of results objects.
showOnlyViolations
Type: Boolean
Default value: false
Returns only the results with the accessibility issues.
tags
Type: String
or Array[String]
Default value: null
Which tags to filter violations on.
threshold
Type: Number
Default value: 0
A number that represents the maximum number of allowable violations. Each violation represents a rule that fails, it may fail for an number of nodes. It is recommended that this value not be changed. A negative value will prevent failure whatever the number of violations.
urls
Type: Array[String]
Default value: []
An Array of URLs that will be tested. The default value is an empty array, you must supply at least one URL in order to successfully complete this task.
Can also be a glob pattern;
verbose
Type: Boolean
Default value: false
Show status of the analysis.
Release History
Read the full changelog.
License
MIT © Felix Zapata