node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org »

grunt-accessibility-html-reporter

grunt-accessibility-html-reporter

NPM version Build Status Dependency Status devDependency Status Greenkeeper badge semantic-release

NPM Downloads

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)
fs.writeFileSync('report.html', output, 'utf-8')

Contributing

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

Release History

  • 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 Ferdinand Prantl

Licensed under the MIT license.