ga

gulp-accessibility

Gulp plugin for AccessSniff

Showing:

Popularity

Downloads/wk

990

GitHub Stars

48

Maintenance

Last Commit

4yrs ago

Contributors

4

Package

Dependencies

4

License

ISC

Type Definitions

Tree-Shakeable

No?

Categories

Readme

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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial