grunt-accessibility-html-reporter

A custom reporter for grunt-accessibility - the HTML accessibility checking task - which formats the validation results to HTML. There is a Grunt task available for converting already written report files, which uses this reporter - grunt-accessibility-html-report-converter.

Notice: This project contained the Grunt task for the report format conversion in the version 0.0.1. If you look for this Grunt task, upgrade your project to depend on grunt-accessibility-html-report-converter, which cartries on providing the original functionality.

Installation

The reporter is usually installed and used together with other development tasks:

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

Usage

You can use the reporter programmatically to process validation results as an object in JavaScript. For example, for converting a JSON report file to a HTML report file:

const report = require('grunt-accessibility-html-reporter')
const input = fs.readFileSync('report.json', 'utf-8')
const results = JSON.parse(input)
const output = report(results, {
  showFileNameOnly: false
})
fs.writeFileSync('report.html', output, 'utf-8')

Options

showFileNameOnly

Type: Boolean Default value: false

Cuts the directory from tested HTML files, when creating page titles from in the report. If you use unique names for files alone, you will not get too long page titles, if you flip this flag tp true.

showCommonPathOnly

Type: Boolean Default value: true

Cuts the same initial part of the path from tested HTML files, when the paths are used for page titles in the report. If you use sub-directories to organize your files, this option will make the file paths in the report short, but still unique. The default is flipped to true already.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style.

Release History

• 2018-05-14 v3.1.0 Allow cutting the same initial part of the path from tested HTML files for displaying purposes
• 2018-04-27 v3.0.0 Dropped support of Node.js 4
• 2018-03-05 v2.2.0 Allow generating page titles from file names without directory
• 2018-03-04 v2.1.0 Add filtering and accessibility to the reports
• 2018-03-01 v2.0.2 Add <meta charset="utf-8"> to the HTML report page
• 2018-02-19 v2.0.0 Change the HTML format to look like Koa11y reports
• 2018-02-19 v1.0.0 Change column numbers from zero-based to one-based
• 2017-11-25 v0.1.1 Support Node.js < 7
• 2017-11-25 v0.1.0 Converted to a pure reporter module; the Grunt task moved to grunt-accessibility-html-report-converter
• 2017-11-22 v0.0.1 Initial release

License

Copyright (c) 2017-2019 Ferdinand Prantl

Licensed under the MIT license.