Gulp plugin for AccessSniff
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
errors
example
img
test
.eslintrc
.gitignore
.jshintrc
.nvmrc
.travis.yml
README.md
appveyor.yml
gulpfile.js
index.js
package-lock.json
package.json
yarn.lock

README.md

Gulp Accessibility

Build Status Build status

Uses AccessSniff and HTML Codesniffer to grade your sites accessibility using different levels of the WCAG guidelines

Gulp Accessibility example

Getting Started

Install this gulp plugin next to your project's gulpfile with: npm install gulp-accessibility --save-dev

Then add this line to your project's gulpfile.js gulpfile:

var access = require('gulp-accessibility');

Documentation

Place this in your gulp file.

gulp.task('test', function() {
  return gulp.src('./example/**/*.html')
    .pipe(access({
      force: true
    }))
    .on('error', console.log)
    .pipe(access.report({reportType: 'txt'}))
    .pipe(rename({
      extname: '.txt'
    }))
    .pipe(gulp.dest('reports/txt'));
});

Report Generation

You can link to the files you wish to lint using the gulp api

You'll need to add the below to convert into other formats

.pipe(access.report({reportType: 'txt'}))

Options

View AccessSniff options for all available options.

License

Copyright (c) 2015 Steven Miller Licensed under the MIT license.