access-sniff

AccessSniff

A CLI and Phantom.js library for HTML_CodeSniffer

• Gulp plugin
• Grunt plugin

Getting Started

Install this plugin with npm install access-sniff then use it in your project with

const AccessSniff  = require('access-sniff');
const files = ['**/*.html'];

AccessSniff
  .default(files, options)
  .then(report => AccessSniff.report(report, reportOptions))

or install the module globally and type

sniff test/**/*.html -r json -l reports

AccessSniff can test both locally hosted files and websites.

sniff http://statamic.com/ -r json -l reports

Options

You can pass the following options

Accessibility Level

accessibilityLevel is a string

options: {
  accessibilityLevel: 'WCAG2A'
}

Levels are WCAG2A, WCAG2AA, and WCAG2AAA

Accessibilityrc

accessibilityrc is a boolean

options: {
  accessibilityrc: true
}

Set to true to access a .accessibilityrc file in your project which should be layed out as:

{
  "ignore": [
  "WCAG2A.Principle2.Guideline2_4.2_4_2.H25.1.NoTitleEl",
  "WCAG2A.Principle3.Guideline3_1.3_1_1.H57.2"
  ]
}

Ignore

ignore is a array

You can ignore rules by placing them in an array outlined below

options: {
  ignore : [
    'WCAG2A.Principle2.Guideline2_4.2_4_2.H25.1.NoTitleEl'
    'WCAG2A.Principle3.Guideline3_1.3_1_1.H57.2'
  ]
}

Verbose output

verbose is a boolean

options: {
  verbose: false
}

Output messages to console, set to true by default

DomElement

domElement is a boolean

options: {
  domElement: false
}

Include reference (tag name, class names & id) to reported elements. Optional for both output formats.

Force

force is a boolean

options: {
  force: true
}

Continue running grunt in the event of failures

Reports

You can pass the following options to the report generator

Reports are now generated from the returned json to the report module

Modular Reporting

You can use the inbuilt system or create your own

AccessSniff.report(report, reportOptions)

Report Type

reportType is a string

options: {
  reportType: 'json'
}

Text, CSV or JSON format output

• 'txt' will output text files
• 'json' will output .json files
• 'csv' will output csv

Report Location

reportLocation is a string

  options: {
    reportLocation : 'reports'
  }

Set the value to where you want reports created

Report Levels

reportLevels is a object

  options: {
    reportLevels: {
      notice: true,
      warning: true,
      error: true
    }
  }

Set a value to false to limit output

CLI

You can use the CLI component by installing it globally with npm install -g access-sniff

sniff test/**/*.html -r json -l reports
sniff test/**/*.html -r csv -l reports
sniff test/**/*.html -r txt -l reports

Options

Report Type

-r or -reportType

txt, csv, json.

Report Location

-r or -reportLocation

Quiet

-q or -quiet