accessibility-html-reporter
An html reporter for Accessibility which uses Access-sniff
Last updated 2 years ago by spitfiresatya .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install accessibility-html-reporter 
SYNC missed versions from official npm registry.

accessibility-html-reporter

A small module which runs Access sniff on the given source glob and generates a simple HTML report.

Installation

Install accessibility-html-reporter locally and add it to the dev dependancies

npm install accessibility-html-reporter --save-dev

Usage

Simple require the module in your script/gulp task and invoke it with the desired config

const accessibilityHtmlReporter = require('accessibility-html-reporter');

accessibilityHtmlReporter({/*config*/}, callback);

and you're done!!

Config

The accessibility-html-reporter takes the following config object and the default values are as below

config: {
  srcFiles: ['**/*.html'], // array of files to test

  accessibilityLevel: 'WCAG2AAA', // one of WCAG2A, WCAG2AA, WCAG2AAA, and Section508
  ignore: [], // rules to ignore eg. ['WCAG2A.Principle3.Guideline3_1.3_1_1.H57.2']
  verbose: false, // Verbose output
  force: true, // do not throw an error if errors found
  browser: false, // false = jsdom, true = phantomJS
  maxBuffer: 500 * 1024, // set buffer size

  fileName: 'accessibility-report', // name of json and html file generated
  reportLocation: 'reports/accessibility' // folder where report should be written
}

Sample Report

This is what the report looks like

Current Tags

  • 1.0.1                                ...           latest (2 years ago)

2 Versions

  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 1
Dependencies (3)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |