Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Accessibility testing in the browser and on the server.
JavaScript HTML Other
Failed to load latest commit information.
bin Introduce quailGenerate to build assessment test assets.
config Pull jQuery from node_modules for karma tests
docs Update aLinksMakeSenseOutOfContext.rst
examples finished getStackedAssert
lib Converted formHasSubmitButton to Selenium
logs Keep the logs directory
scripts Added spec template rewrite
src Removed the formDeleteIsReversisble assessment
tasks Remove an empty file
test Converted formHasSubmitButton to Selenium
.editorconfig JSCS: Add linefeed at the end of each file
.gitattributes Merged branch from https://github.com/nschonni/quail.git git-dotfiles…
.gitignore Use the local phantomjs binary
.jscsrc Remove redundant style check from jscrc
.jshintrc jshinted all the lib/*.js files
.nvmrc Added nvmrc file with version 0.10 of nodejs
.travis.yml Don't put saucelabs through the wringer until we get the tests passin…
CHANGELOG.md Merge branch 'master-2.2.x'
Gruntfile.js Remove the build test json task from the Gruntfile.
LICENSE-MIT Changed license to MIT. Updated changelog. Fixes #61
README.md Adding a link in the README to HTML Test Suite for WCAG 2.0 Sorted by…
bower.json Remove .jshintrc from ignore list
package.json Use the local phantomjs binary
quail.jquery.json Resynced dev with release.
quail.js Building a proper Node module
quail.json Replaced kevee/quail with quailjs/quail

README.md

Build Status

Quail: Accessibility Information Library

The project website is quailjs.io.

Quail is a Node module and a jQuery plugin that lets you easily check HTML for adherence to accessibility standards. It comes with over 200 tests which implement Open Accessibility Tests and comes with WCAG 1.0, WCAG 2.0, and Section 508 guidelines.

Developers can build their own guidelines, or easily build a custom guideline that integrates with their project. While the project supports checking entire HTML pages, integration with a CMS to check partial HTML content is probably the most popular use case.

Notice for developers working in the 2.2.x version.

Please base your changes on the master-2.2.x branch.

Requirements

You will need the following installed on your system to run Quail.

  1. Node.js
  2. Grunt & Grunt CLI
  3. Bower
  4. Java JDK (To run Selenium Server)
  5. Karma

Using Quail

Setup

Run the following commands to build Quail.

git clone https://github.com/quailjs/quail.git
cd quail
npm install
bower install
grunt build

Using Quail from the command line

To see the Quail CLI API, run the following. You can also add the Quail bin directory to your PATH if you are so inclined.

./bin/quail --help

Once the command is set up, you can run the following to test any addressable web page.

./bin/quail eval http://placekitten.com

Write the results as a JSON object out to file in an existing directory.

./bin/quail evaluate http://placekitten.com -o ./analyses

To work on an existing assessment in a browser (so that breakpoints can be set in the console), run the following.

./bin/quail dev aMustHaveTitle

The following is experimental, which means it probably won\'t work. You can generate a new assessment with this command.

./bin/quail gen someNewAssessment

Testing

Core unit tests in Karma

./node_modules/karma/bin/karma start ./config/karma-unit.conf.js

Testing assessments in Selenium

All assessments. This takes about 10 minutes to run.

node ./test/assessmentSpecs/testRunner.js

An individual assessment. This takes about 2 seconds to run.

node ./test/assessmentSpecs/testRunner.js -I aMustHaveTitle

In a specific browser.

_BROWSER=chrome node ./test/assessmentSpecs/testRunner.js

Documentation

Full documentation is available via readthedocs.org.

Contributing

Pull requests should be made against the master branch.

Credits

References

HTML Test Suite for WCAG 2.0, Sorted by Guideline

Legal

QUAIL is covered under the MIT License, and is copyright (c) 2015 by Jesse Beach. Current license is at http://quailjs.org/license.

Something went wrong with that request. Please try again.