https://github.com/spitfiresatya/accessibility-html-reporter
An html reporter for Accessibility which uses Access-sniff
https://github.com/spitfiresatya/accessibility-html-reporter
accessibility html-report
Last synced: about 1 year ago
JSON representation
An html reporter for Accessibility which uses Access-sniff
- Host: GitHub
- URL: https://github.com/spitfiresatya/accessibility-html-reporter
- Owner: SpitfireSatya
- License: mit
- Created: 2018-07-28T15:32:28.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T21:54:04.000Z (over 3 years ago)
- Last Synced: 2025-05-07T06:15:32.954Z (about 1 year ago)
- Topics: accessibility, html-report
- Language: JavaScript
- Size: 275 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```bash
npm install accessibility-html-reporter --save-dev
```
## Usage
Simple require the module in your script/gulp task and invoke it with the desired config
```js
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
```js
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
