HTML Codesniffer runner for CrawlKit

This runner can be used with CrawlKit in order to audit a website with the HTML Codesniffer.

Install

npm install crawlkit-runner-htmlcs --save

Example

const CrawlKit = require('crawlkit');
const HtmlCsRunner = require('crawlkit-runner-htmlcs');

const crawler = new CrawlKit('http://your/page');
// You could add a finder here in order to audit a whole network of pages
crawler.addRunner('htmlcs', new HtmlCsRunner());

crawler.crawl()
    .then((data) => {
        console.log(JSON.stringify(data.results, true, 2));
    }, (err) => console.error(err));

Only testing certain standards

The HTML Codesniffer runner supports a parameter where you can limit the standards to test for.

By default all standards are tested.

Supported standards are: WCAG2A, WCAG2AA, WCAG2AAA, Section508.

Use one:

// Test only WCAG2AA
crawler.addRunner('htmlcs', new HtmlCsRunner(), HtmlCsRunner.standard.WCAG2AA);

or multiple:

// Test WCAG2AA & Section508
crawler.addRunner('htmlcs', new HtmlCsRunner(), [HtmlCsRunner.standard.WCAG2AA, HtmlCsRunner.standard.Section508]);

Excluding messages

If you are not interested in all levels of findings, you can set a level threshold:

// Only interested in warnings & errors (notices are below the threshold)
crawler.addRunner('htmlcs', new HtmlCsRunner(), null, HtmlCsRunner.level.WARNING);

Valid thresholds are NOTICE, WARNING and ERROR (use the constants in HtmlCsRunner.level).

This project is in no way affiliated with squizlabs.