Compare commits

...

15 Commits
3.3.0 ... 4.2.0

Author SHA1 Message Date
Jose Bolos
3b76433cf3 Version 4.2.0 2022-03-30 17:19:08 +01:00
Jose Bolos
f3462f0c1e Bump webservice, deps, and linter configuration
* Bump webservice to require the latest 4.0.1 version
* Bump other dependencies
* Update linter conf to v2 which avoids the "Unsupported engine" warning when using node 12
* Keep all other devdependencies as they are so they stay consistent with the other repos
2022-03-30 18:16:25 +02:00
Jose Bolos
9dbee59746 Add request logging using morgan
This commit adds request logging to the app using morgan.

Every request will now be logged not one but twice: one when the request is received, and a second time when the response is sent.

The response logging also prints out the time elapsed in processing the request, which will be useful to debug performance issues (calls to the dashboard home are currently taking 4 - 15s on a populated database).

The new code uses a tiny middleware that uses nanoid to generate a random request id that can be used to match requests in the logs.

This logging will help us determine which requests are successful, which requests are slow, and establish what requests may have contributed to causing an application crash, making future debugging easier.
2022-03-08 11:19:15 +01:00
Jose Bolos
321d7bb6ba Split initApp in different functions
This makes the function easier to understand and fixes eslint complaints
about the function having too many statements.
2022-03-07 15:55:34 +01:00
Jose Bolos
4fd73bcf2f Make .editorconfig consistent between repos 2022-03-03 13:59:11 +00:00
Jose Bolos
0072fe8965 Version 4.1.0 2021-11-26 16:25:06 +00:00
Jose Bolos
30c1ff171d Update troubleshooting guide and move to README 2021-11-26 16:24:09 +00:00
Sangita Mane
a0b3fa843f Updated rulesets list to add WCAG 2.1 options 2021-11-26 17:05:50 +01:00
Jose Bolos
a424cfade7 Version 4.0.0 2021-11-26 15:34:37 +00:00
Jose Bolos
cbc9da2d93 update test matrix 2021-11-26 15:26:54 +00:00
Jose Bolos
19f4d32bf0 Fix linter errors 2021-11-26 15:22:28 +00:00
Jose Bolos
ff87055cc4 Update dependencies and devDependencies 2021-11-26 15:20:52 +00:00
Sangita Mane
4c0bd924ab Fixed the a11y errors on Pa11y dashboard results and add new url page (#285)
* Fixed the a11y errors on Pa11y dashboard results page and add new url page.

* Removed few more unnecessary roles along with Holli's suggestions implemented.

* Added close button ARIA label

Co-authored-by: Hollie Kay <1948361+hollsk@users.noreply.github.com>

Co-authored-by: Hollie Kay <1948361+hollsk@users.noreply.github.com>
2021-05-26 16:38:38 +02:00
Jose Bolos
6d4b8c9676 Add mongo version to brew start command 2021-05-18 14:32:35 +01:00
Jose Bolos
0654790289 Improve installation instructions
* Clarify the requirements for running Pa11y Dashboard, and specifically the versions of MongoDB supported
* Split the installation process in sections so it's easy to follow
* Instead of trying to cover the MongoDB installation on the Readme, refer to the MongoDB docs, but still including a macOS example for easy reference
* Clarify the use of the config files and how they relate to the NODE_ENV variable
* Use a slightly less informal language in a few places
2021-05-18 14:32:35 +01:00
25 changed files with 669 additions and 358 deletions

View File

@@ -5,9 +5,19 @@ root = true
[*] [*]
charset = utf-8 charset = utf-8
end_of_line = lf end_of_line = lf
insert_final_newline = true indent_size = 4
indent_style = tab indent_style = tab
insert_final_newline = true
trim_trailing_whitespace = true trim_trailing_whitespace = true
[*.md] [*.md]
indent_style = spaces
trim_trailing_whitespace = false trim_trailing_whitespace = false
[*.yml]
indent_style = space
indent_size = 2
[package.json]
indent_style = space
indent_size = 2

View File

@@ -17,10 +17,9 @@ jobs:
strategy: strategy:
matrix: matrix:
include: include:
- node-version: 8.x
lint: true # Linter is run only once to shorten the total build time
- node-version: 10.x
- node-version: 12.x - node-version: 12.x
lint: true # Linter is run only once to shorten the total build time
- node-version: 14.x
steps: steps:
- name: Checkout code from ${{ github.repository }} - name: Checkout code from ${{ github.repository }}

View File

@@ -1,5 +1,21 @@
# Changelog # Changelog
## 4.2.0 (2022-03-30)
* Add request logging for easier debugging
* Dependencies update
## 4.1.0 (2021-11-26)
* Add support for new WCAG 2.1 rules and remove all references to Section 508.
* Move troubleshooting guide to the README.
## 4.0.0 (2021-11-26)
* Update pa11y to version 6.
* Drop support for versions of Node.js older than 12.
* Update MongoDB Node driver from v2 to v3, which adds support for MongoDB v4 databases.
## 3.3.0 (2021-04-27) ## 3.3.0 (2021-04-27)
* Add new list view to the dashboard (thanks @sangitamane) * Add new list view to the dashboard (thanks @sangitamane)

View File

@@ -2,12 +2,22 @@
Pa11y Dashboard's API changes between major versions. This is a guide to help you make the switch when this happens. Pa11y Dashboard's API changes between major versions. This is a guide to help you make the switch when this happens.
## Table of Contents ## Table of contents
- [Migrating from 2.0 to 3.0](#migrating-from-20-to-30) * [Table of contents](#table-of-contents)
- [Migrating from 1.0 to 2.0](#migrating-from-10-to-20) * [Migrating from 3.0 to 4.0](#migrating-from-30-to-40)
* [Migrating from 2.0 to 3.0](#migrating-from-20-to-30)
* [PhantomJS to Headless Chrome](#phantomjs-to-headless-chrome)
* [Node.js Support](#nodejs-support)
* [Miscellaneous](#miscellaneous)
* [Migrating from 1.0 to 2.0](#migrating-from-10-to-20)
* [Node.js Support](#nodejs-support-1)
## Migrating from 2.0 to 3.0 ## Migrating from 3.0 to 4.0
Pa11y Dashboard requires Node.js version 12 or greater. Versions 8 and 10 are not supported any more.
## Migrating from 2.0 to 3.0
### PhantomJS to Headless Chrome ### PhantomJS to Headless Chrome
@@ -17,13 +27,13 @@ As a result of this change, [Pa11y Dashboard's requirements](../README.md#requir
### Node.js Support ### Node.js Support
Pa11y Webservice 3 requires Node.js version 8 or greater. Versions 4 and 6 are not supported any more. Pa11y Dashboard 3 requires Node.js version 8 or greater. Versions 4 and 6 are not supported any more.
### Miscellaneous ### Miscellaneous
The default viewport dimensions for Pa11y have been changed from `1024x768` to `1280x1024`. This could make pa11y report a different number of errors if different content appears on the page based on its width, so results obtained with v2 and v3 may not be comparable. The default viewport dimensions for Pa11y have been changed from `1024x768` to `1280x1024`. This could make pa11y report a different number of errors if different content appears on the page based on its width, so results obtained with v2 and v3 may not be comparable.
## Migrating from 1.0 to 2.0 ## Migrating from 1.0 to 2.0
### Node.js Support ### Node.js Support

108
README.md
View File

@@ -14,15 +14,15 @@ Pa11y Dashboard is a web interface to the [Pa11y][pa11y] accessibility reporter;
## Requirements ## Requirements
Pa11y Dashboard is a [Node.js][node] application and requires a stable or LTS version of Node, currently version 8 or greater. Pa11y Dashboard is a [Node.js][node] application and requires a stable or LTS version of Node, currently version 12 or 14.
Pa11y Dashboard also requires a [MongoDB][mongo] database to be available so it can store the results of the tests. The database doesn't have to be in the same server or computer where Pa11y Dashboard is running from. ⚠️ At the moment, Pa11y Dashboard won't work with Node.js v16. Please use Node.js 12 or 14. ⚠️
Since version 3, Pa11y Dashboard uses Headless Chrome in order to run the tests. This means that additional dependencies maybe be required. Pa11y Dashboard uses a [MongoDB][mongo] database to store the results of the tests. The database doesn't have to be in the same server or computer where Pa11y Dashboard is running from.
In [Unix-like](https://en.wikipedia.org/wiki/Unix-like) systems you may need to install the `libnss3` and `libgconf-2-4` libraries in order to be able to run Chrome. If you're trying to run the app in a headless environment (e.g. the cloud, or a headless server), you may also need to configure Xvfb before. Please refer to the documentation from your provider for details on how to do this. Pa11y Dashboard uses [puppeteer](https://www.npmjs.com/package/puppeteer) to create a headless instance of the Chromium browser in order to run the tests. On certain environments this may require additional dependencies to be installed. For example, in Debian/Ubuntu systems you may need to install the `libnss3` and `libgconf-2-4` libraries in order to be able to run tests on Pa11y Dashboard. Please refer to the documentation from your provider for details on how to do this.
## Setup ## Setting up Pa11y Dashboard
In order to run Pa11y Dashboard, we recommend cloning this repository locally: In order to run Pa11y Dashboard, we recommend cloning this repository locally:
@@ -37,11 +37,47 @@ cd pa11y-dashboard
npm install npm install
``` ```
You'll also need to have [MongoDB][mongo] installed and running. For quick access, you can install via a package manager such as on Mac OS `brew install mongodb` or on Linux (Debian) it would be `apt-get install mongodb`. To run MongoDB, you can run `mongod` in the command line. See the [MongoDB install guide][mongo-install] for more detailed information. ### Installing MongoDB
The last step before being able to run the application is to define a configuration for it. This can be done in two ways: Instructions for installing and running MongoDB are outside the scope of this document. When in doubt, please refer to the [MongoDB installation instructions](https://docs.mongodb.com/manual/installation/) for details of how to install and run MongoDB on your specific operating system. An example of the installation and configuration process for macOS follows.
### Option 1: Using Environment Variables Pa11y Dashboard currently uses version 3 of the Node.js MongoDB driver, which means that [only MongoDB servers of versions 4.4 or older are supported](https://docs.mongodb.com/drivers/node/current/compatibility/#mongodb-compatibility). Please ensure that your MongoDB server fills the requirements before trying to run Pa11y Dashboard.
#### Example MongoDB installation for macOS
On recent versions of macOS (10.13 or later), you can use [Homebrew](https://brew.sh/) to install MongoDB Community Edition. More recent versions of MongoDB are untested and unsupported.
Tap the MongoDB Homebrew Tap:
```sh
brew tap mongodb/brew
```
Install a supported Community version of MongoDB:
```sh
brew install mongodb-community@4.4
```
Start the MongoDB server:
```sh
brew services start mongodb/brew/mongodb-community@4.4
```
Check that the service has started properly:
```sh
$ brew services list
Name Status User Plist
mongodb-community started pa11y /Users/pa11y/Library/LaunchAgents/homebrew.mxcl.mongodb-community.plist
```
### Configuring Pa11y Dashboard
The last step before being able to run Pa11y Dashboard is to define a configuration for it. This can be done in two ways:
#### Option 1: Using environment variables
Each configuration can be set with an environment variable rather than a config file. For example to run the application on port `8080` you can use the following: Each configuration can be set with an environment variable rather than a config file. For example to run the application on port `8080` you can use the following:
@@ -49,11 +85,17 @@ Each configuration can be set with an environment variable rather than a config
PORT=8080 node index.js PORT=8080 node index.js
``` ```
The [available configurations are documented here](#configurations). The [available configurations](#configurations) are documented in the next section.
### Option 2: Using Config Files #### Option 2: Using config files
You'll need to copy and modify different config files depending on your environment (set with `NODE_ENV`): You can store the configuration for Pa11y Dashboard on a JSON file. You can use a different configuration file for each environment you're planning to run Pa11y Dashboard on. You can choose a specific environment to run the application from by setting the `NODE_ENV` environment variable:
```sh
NODE_ENV=development node index.js
```
Three example files are provided in this repository, you can copy and customise them to your liking:
```sh ```sh
cp config/development.sample.json config/development.json cp config/development.sample.json config/development.json
@@ -61,35 +103,32 @@ cp config/production.sample.json config/production.json
cp config/test.sample.json config/test.json cp config/test.sample.json config/test.json
``` ```
Each of these files defines configurations for a different environment. If you're just running the application locally, then you should be OK with just development and test configurations. The [available configurations are documented here](#configurations). The [available configurations](#configurations) are documented in the next section.
Now that you've got your application configured, make sure you have a MongoDB server running with the `mongod` command in another terminal window. You can run in each mode by changing the `NODE_ENV` environment variable: If you run into problems, check the [troubleshooting guide][#troubleshooting].
```sh
NODE_ENV=development node index.js
```
See [Contributing](#contributing) for more information about running locally (and restarting automatically when files change).
If you run into problems, check the [troubleshooting guide][troubleshooting].
## Configurations ## Configurations
The boot configurations for Pa11y Dashboard are as follows. Look at the sample JSON files in the repo for example usage. The boot configurations for Pa11y Dashboard are as follows. Look at the sample JSON files in the repo for example usage.
### port ### port
*(number)* The port to run the application on. Set via a config file or the `PORT` environment variable. *(number)* The port to run the application on. Set via a config file or the `PORT` environment variable.
### noindex ### noindex
*(boolean)* If set to `true` (default), the dashboard will not be indexed by search engines. Set to `false` to allow indexing. Set via a config file or the `NOINDEX` environment variable. *(boolean)* If set to `true` (default), the dashboard will not be indexed by search engines. Set to `false` to allow indexing. Set via a config file or the `NOINDEX` environment variable.
### readonly ### readonly
*(boolean)* If set to `true`, users will not be able to add, delete or run URLs (defaults to `false`). Set via a config file or the `READONLY` environment variable. *(boolean)* If set to `true`, users will not be able to add, delete or run URLs (defaults to `false`). Set via a config file or the `READONLY` environment variable.
### siteMessage ### siteMessage
*(string)* A message to display prominently on the site home page. Defaults to `null`. *(string)* A message to display prominently on the site home page. Defaults to `null`.
### webservice ### webservice
This can either be an object containing [Pa11y Webservice configurations][pa11y-webservice-config], or a string which is the base URL of a [Pa11y Webservice][pa11y-webservice] instance you are running separately. If using environment variables, prefix the webservice vars with `WEBSERVICE_`. This can either be an object containing [Pa11y Webservice configurations][pa11y-webservice-config], or a string which is the base URL of a [Pa11y Webservice][pa11y-webservice] instance you are running separately. If using environment variables, prefix the webservice vars with `WEBSERVICE_`.
## Contributing ## Contributing
@@ -117,11 +156,22 @@ make less # Compile the site CSS from LESS files
make uglify # Compile and uglify the client-side JavaScript make uglify # Compile and uglify the client-side JavaScript
``` ```
## Useful Resources ## Useful resources
* [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitalOcean](https://una.im/pa11y-dash/) * [Setting up An Accessibility Dashboard from Scratch with Pa11y on DigitalOcean](https://una.im/pa11y-dash/)
* [Monitoring Web Accessibility Compliance With Pa11y Dashboard](https://www.lullabot.com/articles/monitoring-web-accessibility-compliance-with-pa11y-dashboard) * [Monitoring Web Accessibility Compliance With Pa11y Dashboard](https://www.lullabot.com/articles/monitoring-web-accessibility-compliance-with-pa11y-dashboard)
## Troubleshooting
### Common issues
* `500` errors or `Could not connect to pa11y-webservice` messages are often related to MongoDB. Ensure that you have the [appropriate version of MongoDB][#installing-mongodb] installed, and that it's running - it doesn't always start automatically.
* Error messages saying that pa11y-webservice isn't running may be due to dependency installation problems. Try deleting your `pa11y-dashboard/node_modules` directory and running `npm install` again.
### Create a new issue
Check the [issue tracker][issues] for similar issues before creating a new one. If the problem that you're experiencing is not covered by one of the existing issues, you can [create a new issue][create-issue]. Please include your node.js and MongoDB version numbers, and your operating system, as well as any information that may be useful in debugging the issue.
## Support and Migration ## Support and Migration
Pa11y Dashboard major versions are normally supported for 6 months after their last minor release. This means that patch-level changes will be added and bugs will be fixed. The table below outlines the end-of-support dates for major versions, and the last minor release for that version. Pa11y Dashboard major versions are normally supported for 6 months after their last minor release. This means that patch-level changes will be added and bugs will be fixed. The table below outlines the end-of-support dates for major versions, and the last minor release for that version.
@@ -130,8 +180,9 @@ We also maintain a [migration guide](MIGRATION.md) to help you migrate.
| :grey_question: | Major Version | Last Minor Release | Node.js Versions | Support End Date | | :grey_question: | Major Version | Last Minor Release | Node.js Versions | Support End Date |
| :-------------- | :------------ | :----------------- | :--------------- | :--------------- | | :-------------- | :------------ | :----------------- | :--------------- | :--------------- |
| :heart: | 3 | N/A | 8+ | N/A | | :heart: | 4 | N/A | 12+ | N/A |
| :hourglass: | 2 | 2.4.2 | 4+ | 2020-01-16 | | :hourglass: | 3 | 3.3.0 | 8+ | 2022-05-26 |
| :skull: | 2 | 2.4.2 | 4+ | 2020-01-16 |
| :skull: | 1 | 1.12 | 0.106 | 2016-12-05 | | :skull: | 1 | 1.12 | 0.106 | 2016-12-05 |
If you're opening issues related to these, please mention the version that the issue relates to. If you're opening issues related to these, please mention the version that the issue relates to.
@@ -143,16 +194,11 @@ Copyright &copy; 20132020, Team Pa11y and contributors
[gpl]: http://www.gnu.org/licenses/gpl-3.0.html [gpl]: http://www.gnu.org/licenses/gpl-3.0.html
[mongo]: http://www.mongodb.org/ [mongo]: http://www.mongodb.org/
[mongo-install]: https://docs.mongodb.org/manual/installation/
[node]: http://nodejs.org/ [node]: http://nodejs.org/
[pa11y]: https://github.com/pa11y/pa11y [pa11y]: https://github.com/pa11y/pa11y
[pa11y-webservice-config]: https://github.com/pa11y/webservice#configurations [pa11y-webservice-config]: https://github.com/pa11y/webservice#configurations
[phantom]: http://phantomjs.org/ [issues]: https://github.com/pa11y/pa11y-dashboard/issues?utf8=%E2%9C%93&q=is%3Aissue
[sidekick-proposal]: https://github.com/pa11y/sidekick/blob/master/PROPOSAL.md [create-issue]: https://github.com/pa11y/pa11y-dashboard/issues/new
[travis]: https://travis-ci.org/pa11y/dashboard
[travis-img]: https://travis-ci.org/pa11y/dashboard.png?branch=master
[troubleshooting]: https://github.com/pa11y/dashboard/blob/master/TROUBLESHOOTING.md
[info-node]: package.json [info-node]: package.json
[info-build]: https://travis-ci.org/pa11y/pa11y-dashboard [info-build]: https://travis-ci.org/pa11y/pa11y-dashboard
[info-license]: LICENSE [info-license]: LICENSE

View File

@@ -1,27 +0,0 @@
Troubleshooting
===============
Common issues
-----
* `500` errors or `Could not connect to pa11y-webservice` messages are often related to MongoDB. Ensure that you have the [latest version of MongoDB][mongo-install] installed, and that it's running - it doesn't always start automatically.
* Error messages saying that pa11y-webservice isn't running may be due to dependency installation problems. Try deleting your `pa11y-dashboard/node_modules` directory and running `npm install` again.
Check to see if the issue has been reported
-----
* Check the [issue tracker][issues] for similar issues.
Create an issue
-----
If all else fails, [create an issue][create-issue] and we'll help you. Please include your node.js, Phantom, and MongoDB version numbers, and your operating system.
[issues]: https://github.com/pa11y/dashboard/issues?utf8=%E2%9C%93&q=is%3Aissue
[mongo-install]: https://docs.mongodb.org/manual/installation/
[create-issue]: https://github.com/pa11y/dashboard/issues/new

78
app.js
View File

@@ -20,6 +20,8 @@ const createClient = require('pa11y-webservice-client-node');
const EventEmitter = require('events').EventEmitter; const EventEmitter = require('events').EventEmitter;
const express = require('express'); const express = require('express');
const hbs = require('express-hbs'); const hbs = require('express-hbs');
const morgan = require('morgan');
const {nanoid} = require('nanoid');
const http = require('http'); const http = require('http');
const pkg = require('./package.json'); const pkg = require('./package.json');
@@ -35,14 +37,57 @@ function initApp(config, callback) {
} }
const app = new EventEmitter(); const app = new EventEmitter();
app.address = null; app.address = null;
app.express = express(); app.express = express();
app.server = http.createServer(app.express); app.server = http.createServer(app.express);
app.webservice = createClient(webserviceUrl); app.webservice = createClient(webserviceUrl);
loadMiddleware(app);
// View engine
loadViewEngine(app, config);
// Load routes
loadRoutes(app, config);
// Error handling
loadErrorHandling(app, config, callback);
}
// Get default configurations
function defaultConfig(config) {
if (typeof config.noindex !== 'boolean') {
config.noindex = true;
}
if (typeof config.readonly !== 'boolean') {
config.readonly = false;
}
return config;
}
function loadMiddleware(app) {
// Compression // Compression
app.express.use(compression()); app.express.use(compression());
// Adds an ID to every request, used later for logging
app.express.use(addRequestId);
// Logging middleware
morgan.token('id', request => {
return request.id;
});
// Log the start of all HTTP requests
const startLog = '[:date[iso] #:id] Started :method :url for :remote-addr';
// Immediate: true is required to log the request
// before the response happens
app.express.use(morgan(startLog, {immediate: true}));
// Log the end of all HTTP requests
const endLog = '[:date[iso] #:id] Completed :status :res[content-length] in :response-time ms';
app.express.use(morgan(endLog));
// Public files // Public files
app.express.use(express.static(`${__dirname}/public`, { app.express.use(express.static(`${__dirname}/public`, {
maxAge: (process.env.NODE_ENV === 'production' ? 604800000 : 0) maxAge: (process.env.NODE_ENV === 'production' ? 604800000 : 0)
@@ -53,8 +98,9 @@ function initApp(config, callback) {
app.express.use(bodyParser.urlencoded({ app.express.use(bodyParser.urlencoded({
extended: true extended: true
})); }));
}
// View engine function loadViewEngine(app, config) {
app.express.engine('html', hbs.express4({ app.express.engine('html', hbs.express4({
extname: '.html', extname: '.html',
contentHelperName: 'content', contentHelperName: 'content',
@@ -89,10 +135,16 @@ function initApp(config, callback) {
response.locals.host = request.hostname; response.locals.host = request.hostname;
next(); next();
}); });
}
// Load routes function loadRoutes(app, config) {
// Because there's some overlap between the different routes,
// they have to be loaded in a specific order in order to avoid
// passing mongo the wrong id which would result in
// "ObjectID generation failed." errors (e.g. #277)
require('./route/index')(app); require('./route/index')(app);
require('./route/result/download')(app); require('./route/result/download')(app);
if (!config.readonly) { if (!config.readonly) {
require('./route/new')(app); require('./route/new')(app);
require('./route/task/delete')(app); require('./route/task/delete')(app);
@@ -101,12 +153,14 @@ function initApp(config, callback) {
require('./route/task/ignore')(app); require('./route/task/ignore')(app);
require('./route/task/unignore')(app); require('./route/task/unignore')(app);
} }
// Needs to be loaded after `/route/new` // Needs to be loaded after `/route/new`
require('./route/task/index')(app); require('./route/task/index')(app);
// Needs to be loaded after `/route/task/edit` // Needs to be loaded after `/route/task/edit`
require('./route/result/index')(app); require('./route/result/index')(app);
}
// Error handling function loadErrorHandling(app, config, callback) {
app.express.get('*', (request, response) => { app.express.get('*', (request, response) => {
response.status(404); response.status(404);
response.render('404'); response.render('404');
@@ -129,16 +183,14 @@ function initApp(config, callback) {
app.address = `http://${address.address}:${address.port}`; app.address = `http://${address.address}:${address.port}`;
callback(error, app); callback(error, app);
}); });
} }
// Get default configurations // Express middleware
function defaultConfig(config) { function addRequestId(request, response, next) {
if (typeof config.noindex !== 'boolean') { // Create a random request (nano)id, 10 characters long
config.noindex = true; // Nano ids are [0-9A-Za-z_-] so chance of collision is 1 in 64^10
} // If a site has so much traffic that this chance is too high
if (typeof config.readonly !== 'boolean') { // we probably have worse things to worry about
config.readonly = false; request.id = nanoid(10);
} next();
return config;
} }

View File

@@ -1,7 +1,7 @@
'use strict'; 'use strict';
// Clone the main config // Clone the main config
var config = module.exports = JSON.parse(JSON.stringify(require('../.eslintrc'))); const config = module.exports = JSON.parse(JSON.stringify(require('../.eslintrc')));
// Disable max line length/statements // Disable max line length/statements
config.rules['max-len'] = 'off'; config.rules['max-len'] = 'off';

View File

@@ -20,211 +20,6 @@ module.exports = getStandards;
function getStandards() { function getStandards() {
return [ return [
{
title: 'Section508',
rules: [
{
name: 'Section508.A.Audio',
description: 'For multimedia containing audio only, ensure an alternative is available, such as a full text transcript.'
},
{
name: 'Section508.A.Img.EmptyAltInLink',
description: 'Img element is the only content of the link, but is missing alt text. The alt text should describe the purpose of the link.'
},
{
name: 'Section508.A.Img.NullAltWithTitle',
description: 'Img element with empty alt text must have absent or empty title attribute.'
},
{
name: 'Section508.A.Img.Ignored',
description: 'Img element is marked so that it is ignored by Assistive Technology.'
},
{
name: 'Section508.A.Img.MissingAlt',
description: 'Img element missing an alt attribute. Use the alt attribute to specify a short text alternative.'
},
{
name: 'Section508.A.Img.GeneralAlt',
description: 'Ensure that the img element\'s alt text serves the same purpose and presents the same information as the image.'
},
{
name: 'Section508.A.InputImage.MissingAlt',
description: 'Image submit button missing an alt attribute. Specify a text alternative that describes the button\'s function, using the alt attribute.'
},
{
name: 'Section508.A.InputImage.GeneralAlt',
description: 'Ensure that the image submit button\'s alt text identifies the purpose of the button.'
},
{
name: 'Section508.A.Area.MissingAlt',
description: 'Area element in an image map missing an alt attribute. Each area element must have a text alternative that describes the function of the image map area.'
},
{
name: 'Section508.A.Area.GeneralAlt',
description: 'Ensure that the area element\'s text alternative serves the same purpose as the part of image map image it references.'
},
{
name: 'Section508.A.Object.MissingBody',
description: 'Object elements must contain a text alternative after all other alternatives are exhausted.'
},
{
name: 'Section508.A.Object.GeneralAlt',
description: 'Check that short (and if appropriate, long) text alternatives are available for non-text content that serve the same purpose and present the same information.'
},
{
name: 'Section508.A.Applet.MissingBody',
description: 'Applet elements must contain a text alternative in the element\'s body, for browsers without support for the applet element.'
},
{
name: 'Section508.A.Applet.MissingAlt',
description: 'Applet elements must contain an alt attribute, to provide a text alternative to browsers supporting the element but are unable to load the applet.'
},
{
name: 'Section508.A.Applet.GeneralAlt',
description: 'Check that short (and if appropriate, long) text alternatives are available for non-text content that serve the same purpose and present the same information.'
},
{
name: 'Section508.B.Video',
description: 'For multimedia containing video, ensure a synchronised audio description or text alternative for the video portion is provided.'
},
{
name: 'Section508.B.Captions',
description: 'For multimedia containing synchronised audio and video, ensure synchronised captions are provided for the audio portion.'
},
{
name: 'Section508.C.Colour',
description: 'Ensure that any information conveyed using colour alone is also available without colour, such as through context or markup.'
},
{
name: 'Section508.D.Linearised',
description: 'Ensure that content is ordered in a meaningful sequence when linearised, such as when style sheets are disabled.'
},
{
name: 'Section508.D.HiddenText',
description: 'If content is hidden and made visible using scripting (such as "click to expand" sections), ensure this content is readable when scripts and style sheets are disabled.'
},
{
name: 'Section508.D.[msgCode]',
description: 'Semantic markup should be used to mark emphasised or special text so that it can be programmatically determined.'
},
{
name: 'Section508.D.HeadingOrder',
description: 'The heading structure is not logically nested. This [Node name, eg. h2] element appears to be the primary document heading, so should be an h1 element.'
},
{
name: 'Section508.D.HeadingOrder',
description: 'The heading structure is not logically nested. This [Node name, eg. h4] element should be an [Expected heading node name, eg. h2] to be properly nested.'
},
{
name: 'Section508.G.TableHeaders',
description: 'This table has no headers. If this is a data table, ensure row and column headers are identified using th elements.'
},
{
name: 'Section508.H.IncorrectHeadersAttr',
description: 'Incorrect headers attribute on this td element. Expected "[Expected list of IDs]" but found "[Actual list of IDs]".'
},
{
name: 'Section508.H.MissingHeadersAttrs',
description: 'The relationship between td elements and their associated th elements is not defined. As this table has multiple levels of th elements, you must use the headers attribute on td elements.'
},
{
name: 'Section508.H.MissingHeaderIds',
description: 'Not all th elements in this table contain an id attribute. These cells should contain ids so that they may be referenced by td elements headers attributes.\''
},
{
name: 'Section508.H.IncompleteHeadersAttrs',
description: 'Not all td elements in this table contain a headers attribute. Each headers attribute should list the ids of all th elements associated with that cell.'
},
{
name: 'Section508.I.Frames',
description: 'This [Node Name] element is missing title text. Frames should be titled with text that facilitates frame identification and navigation.'
},
{
name: 'Section508.J.Flicker',
description: 'Check that no component of the content flickers at a rate of greater than 2 and less than 55 times per second.'
},
{
name: 'Section508.K.AltVersion',
description: 'If this page cannot be made compliant, a text-only page with equivalent information or functionality should be provided. The alternative page needs to be updated in line with this page\'s content.'
},
{
name: 'Section508.L.EmptyAnchorNoId',
description: 'Anchor element found with no link content and no name and/or ID attribute.'
},
{
name: 'Section508.L.PlaceholderAnchor',
description: 'Anchor element found with link content, but no href, ID or name attribute has been supplied.'
},
{
name: 'Section508.L.NoContentAnchor',
description: 'Anchor element found with a valid href attribute, but no link content has been supplied.'
},
{
name: 'Section508.L.DblClick',
description: 'Ensure the functionality provided by double-clicking on this element is available through the keyboard.'
},
{
name: 'Section508.L.MouseOver',
description: 'Ensure the functionality provided by mousing over this element is available through the keyboard; for instance, using the focus event.'
},
{
name: 'Section508.L.MouseOut',
description: 'Ensure the functionality provided by mousing out of this element is available through the keyboard; for instance, using the blur event.'
},
{
name: 'Section508.L.MouseMove',
description: 'Ensure the functionality provided by moving the mouse on this element is available through the keyboard.'
},
{
name: 'Section508.L.MouseDown',
description: 'Ensure the functionality provided by mousing down on this element is available through the keyboard; for instance, using the keydown event.'
},
{
name: 'Section508.L.MouseUp',
description: 'Ensure the functionality provided by mousing up on this element is available through the keyboard; for instance, using the keyup event.'
},
{
name: 'Section508.M.PluginLink',
description: 'If external media requires a plugin or application to view, ensure a link is provided to a plugin or application that complies with Section 508 accessibility requirements for applications.'
},
{
name: 'Section508.N.Errors',
description: 'If an input error is automatically detected in this form, check that the item(s) in error are identified and the error(s) are described to the user in text.'
},
{
name: 'Section508.N.Labels',
description: 'Check that descriptive labels or instructions (including for required fields) are provided for user input in this form.'
},
{
name: 'Section508.N.KeyboardNav',
description: 'Ensure that this form can be navigated using the keyboard and other accessibility tools.'
},
{
name: 'Section508.O.SkipLinks',
description: 'Ensure that any common navigation elements can be bypassed; for instance, by use of skip links, header elements, or ARIA landmark roles.'
},
{
name: 'Section508.O.NoSuchID',
description: 'This link points to a named anchor [ID] within the document, but no anchor exists with that name.'
},
{
name: 'Section508.O.NoSuchIDFragment',
description: 'This link points to a named anchor [ID] within the document, but no anchor exists with that name in the fragment tested.'
},
{
name: 'Section508.P.TimeLimit',
description: 'If a timed response is required on this page, alert the user and provide sufficient time to allow them to indicate that more time is required.'
},
{
name: 'Section508.P.MetaRedirect',
description: 'Meta refresh tag used to redirect to another page, with a time limit that is not zero. Users cannot control this time limit.'
},
{
name: 'Section508.P.MetaRefresh',
description: 'Meta refresh tag used to refresh the current page. Users cannot control the time limit for this refresh.'
}
]
},
{ {
title: 'WCAG2A', title: 'WCAG2A',
rules: [ rules: [
@@ -516,6 +311,10 @@ function getStandards() {
name: 'WCAG2A.Principle2.Guideline2_1.2_1_2.F10', name: 'WCAG2A.Principle2.Guideline2_1.2_1_2.F10',
description: 'Check that this applet or plugin provides the ability to move the focus away from itself when using the keyboard.' description: 'Check that this applet or plugin provides the ability to move the focus away from itself when using the keyboard.'
}, },
{
name: 'WCAG2A.1.Principle1.Guideline2_1.2_1_4.Check',
description: 'Check that if a keyboard shortcut is implemented in content using only letter (including upper- and lower-case letters), punctuation, number, or symbol characters, then at least one of the following is true: \nTurn off: A mechanism is available to turn the shortcut off;\nRemap: A mechanism is available to remap the shortcut to use one or more non- printable keyboard characters(e.g.Ctrl, Alt, etc);\nActive only on focus: The keyboard shortcut for a user interface component is only active when that component has focus.'
},
{ {
name: 'WCAG2A.Principle2.Guideline2_2.2_2_1.F40.2', name: 'WCAG2A.Principle2.Guideline2_2.2_2_1.F40.2',
description: 'Meta refresh tag used to redirect to another page, with a time limit that is not zero. Users cannot control this time limit.' description: 'Meta refresh tag used to redirect to another page, with a time limit that is not zero. Users cannot control this time limit.'
@@ -536,6 +335,10 @@ function getStandards() {
name: 'WCAG2A.Principle2.Guideline2_2.2_2_2.F47', name: 'WCAG2A.Principle2.Guideline2_2.2_2_2.F47',
description: 'Blink elements cannot satisfy the requirement that blinking information can be stopped within five seconds.' description: 'Blink elements cannot satisfy the requirement that blinking information can be stopped within five seconds.'
}, },
{
name: 'WCAG2A.Principle1.Guideline2_2.2_2_6.Check',
description: 'Check that users are warned of the duration of any user inactivity that could cause data loss, unless the data is preserved for more than 20 hours when the user does not take any actions.'
},
{ {
name: 'WCAG2A.Principle2.Guideline2_3.2_3_1.G19,G176', name: 'WCAG2A.Principle2.Guideline2_3.2_3_1.G19,G176',
description: 'Check that no component of the content flashes more than three times in any 1-second period, or that the size of any flashing area is sufficiently small.' description: 'Check that no component of the content flashes more than three times in any 1-second period, or that the size of any flashing area is sufficiently small.'
@@ -584,6 +387,38 @@ function getStandards() {
name: 'WCAG2A.Principle2.Guideline2_4.2_4_4.H77,H78,H79,H80,H81', name: 'WCAG2A.Principle2.Guideline2_4.2_4_4.H77,H78,H79,H80,H81',
description: 'Check that the link text combined with programmatically determined link context identifies the purpose of the link.' description: 'Check that the link text combined with programmatically determined link context identifies the purpose of the link.'
}, },
{
name: 'WCAG2A.Principle1.Guideline2_5.2_5_1.Check',
description: 'Check that all functionality that uses multipoint or path-based gestures for operation can be operated with a single pointer without a path-based gesture, unless a multipoint or path-based gesture is essential.'
},
{
name: 'WCAG2A.Principle1.Guideline2_5.2_5_2.SinglePointer_Check',
description: 'Check that for functionality that can be operated using a single pointer, at least one of the following is true: \nNo Down- Event: The down - event of the pointer is not used to execute any part of the function; \nAbort or Undo: Completion of the function is on the up - event, and a mechanism is available to abort the function before completion or to undo the function after completion; \nUp Reversal: The up - event reverses any outcome of the preceding down - event; \nEssential: Completing the function on the down - event is essential.'
},
{
name: 'WCAG2A.Principle1.Guideline2_5.2_5_2.Mousedown_Check',
description: 'This element has an mousedown event listener. Check that for functionality that can be operated using a single pointer, at least one of the following is true: \nNo Down- Event: The down - event of the pointer is not used to execute any part of the function; \nAbort or Undo: Completion of the function is on the up - event, and a mechanism is available to abort the function before completion or to undo the function after completion; \nUp Reversal: The up - event reverses any outcome of the preceding down - event; \nEssential: Completing the function on the down - event is essential.'
},
{
name: 'WCAG2A.Principle1.Guideline2_5.2_5_2.Touchstart_Check',
description: 'This element has a touchstart event listener. Check that for functionality that can be operated using a single pointer, at least one of the following is true: \nNo Down- Event: The down - event of the pointer is not used to execute any part of the function; \nAbort or Undo: Completion of the function is on the up - event, and a mechanism is available to abort the function before completion or to undo the function after completion; \nUp Reversal: The up - event reverses any outcome of the preceding down - event; \nEssential: Completing the function on the down - event is essential.'
},
{
name: 'WCAG2A.Principle1.Guideline2_5.2_5_3_F96.Check',
description: 'Check that for user interface components with labels that include text or images of text, the name contains the text that is presented visually.'
},
{
name: 'WCAG2A.Principle1.Guideline2_5.2_5_3_F96.AccessibleName',
description: 'Accessible name for this element does not contain the visible label text. Check that for user interface components with labels that include text or images of text, the name contains the text that is presented visually.'
},
{
name: 'WCAG2A.Principle1.Guideline2_5.2_5_4.Check',
description: 'Check that functionality that can be operated by device motion or user motion can also be operated by user interface components and responding to the motion can be disabled to prevent accidental actuation, except when: \nSupported Interface: The motion is used to operate functionality through an accessibility supported interface; \nEssential: The motion is essential for the function and doing so would invalidate the activity.'
},
{
name: 'WCAG2A.Principle1.Guideline2_5.2_5_4.Devicemotion',
description: 'This element has a devicemotion event listener. Check that functionality that can be operated by device motion or user motion can also be operated by user interface components and responding to the motion can be disabled to prevent accidental actuation, except when: \nSupported Interface: The motion is used to operate functionality through an accessibility supported interface; \nEssential: The motion is essential for the function and doing so would invalidate the activity.'
},
{ {
name: 'WCAG2A.Principle3.Guideline3_1.3_1_1.H57.2', name: 'WCAG2A.Principle3.Guideline3_1.3_1_1.H57.2',
description: 'The html element should have a lang or xml:lang attribute which describes the language of the document.' description: 'The html element should have a lang or xml:lang attribute which describes the language of the document.'
@@ -901,6 +736,54 @@ function getStandards() {
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_3.G96', name: 'WCAG2AA.Principle1.Guideline1_3.1_3_3.G96',
description: 'Where instructions are provided for understanding the content, do not rely on sensory characteristics alone (such as shape, size or location) to describe objects.' description: 'Where instructions are provided for understanding the content, do not rely on sensory characteristics alone (such as shape, size or location) to describe objects.'
}, },
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_4.RestrictView',
description: 'Check that content does not restrict its view and operation to a single display orientation, such as portrait or landscape, unless a specific display orientation is essential.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.FaultyValue',
description: 'This element contains a potentially faulty value in its autocomplete attribute.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Text',
description: 'Invalid autocomplete value. Element does not belong to Text control group.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Multiline',
description: 'Invalid autocomplete value. Element does not belong to Multiline control group.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Password',
description: 'Invalid autocomplete value. Element does not belong to Password control group.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Url',
description: 'Invalid autocomplete value. Element does not belong to Url control group.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Telephone',
description: 'Invalid autocomplete value. Element does not belong to Telephone control group.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Numeric',
description: 'Invalid autocomplete value. Element does not belong to Numeric control group.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Month',
description: 'Invalid autocomplete value. Element does not belong to Month control group.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Date',
description: 'Invalid autocomplete value. Element does not belong to Date control group.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.Purpose',
description: 'Check that the input field serves a purpose identified in the Input Purposes for User Interface Components section; and that the content is implemented using technologies with support for identifying the expected meaning for form input data.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_3.1_3_5_H98.MissingAutocomplete',
description: 'This element does not have an autocomplete attribute. If this field collects information about the user, consider adding one to comply with this Success Criterion.'
},
{ {
name: 'WCAG2AA.Principle1.Guideline1_4.1_4_1.G14,G182', name: 'WCAG2AA.Principle1.Guideline1_4.1_4_1.G14,G182',
description: 'Check that any information conveyed using colour alone is also available in text, or through other visual cues.' description: 'Check that any information conveyed using colour alone is also available in text, or through other visual cues.'
@@ -922,7 +805,7 @@ function getStandards() {
description: 'This element\'s text is placed on a background image. Ensure the contrast ratio between the text and all covered parts of the image are at least 4.5:1.' description: 'This element\'s text is placed on a background image. Ensure the contrast ratio between the text and all covered parts of the image are at least 4.5:1.'
}, },
{ {
name: 'WCAG2AA.Principle1.Guideline1_4.1_4_3.G145', name: 'WCAG2AA.Principle1.Guideline1_4.1_4_3.G145 ',
description: 'This element\'s text is placed on a background image. Ensure the contrast ratio between the text and all covered parts of the image are at least 3:1.' description: 'This element\'s text is placed on a background image. Ensure the contrast ratio between the text and all covered parts of the image are at least 3:1.'
}, },
{ {
@@ -941,6 +824,30 @@ function getStandards() {
name: 'WCAG2AA.Principle1.Guideline1_4.1_4_5.G140,C22,C30.AALevel', name: 'WCAG2AA.Principle1.Guideline1_4.1_4_5.G140,C22,C30.AALevel',
description: 'If the technologies being used can achieve the visual presentation, check that text is used to convey information rather than images of text, except when the image of text is essential to the information being conveyed, or can be visually customised to the user\'s requirements.' description: 'If the technologies being used can achieve the visual presentation, check that text is used to convey information rather than images of text, except when the image of text is essential to the information being conveyed, or can be visually customised to the user\'s requirements.'
}, },
{
name: 'WCAG2AA.Principle1.Guideline1_4.1_4_10_C32,C31,C33,C38,SCR34,G206.Check',
description: 'Check that content can be presented without loss of information or functionality, and without requiring scrolling in two dimensions for: \nVertical scrolling content at a width equivalent to 320 CSS pixels;\\n Horizontal scrolling content at a height equivalent to 256 CSS pixels; \nExcept for parts of the content which require two-dimensional layout for usage or meaning.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_4.1_4_10_C32,C31,C33,C38,SCR34,G206.Fixed',
description: 'Principle1.Guideline1_4.1_4_10_C32,C31,C33,C38,SCR34,G206.Scrolling'
},
{
name: 'WCAG2AA.Principle1.Guideline1_4.1_4_10_C32,C31,C33,C38,SCR34,G206.Zoom',
description: 'Interfering with a user agents ability to zoom may be a failure of this Success Criterion.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_4.1_4_11_G195,G207,G18,G145,G174,F78.Check',
description: 'Check that the visual presentation of the following have a contrast ratio of at least 3:1 against adjacent color(s): \nUser Interface Components: Visual information required to identify user interface components and states, except for inactive components or where the appearance of the component is determined by the user agent and not modified by the author; \nGraphical Objects: Parts of graphics required to understand the content, except when a particular presentation of graphics is essential to the information being conveyed.'
},
{
name: 'WCAG2AA.Principle1.Guideline1_4.1_4_12_C36,C35.Check',
description: 'Check that no loss of content or functionality occurs by setting all of the following and by changing no other style property: \nLine height(line spacing) to at least 1.5 times the font size; \nSpacing following paragraphs to at least 2 times the font size; \nLetter spacing(tracking) to at least 0.12 times the font size; \nWord spacing to at least 0.16 times the font size'
},
{
name: 'WCAG2AA.Principle1.Guideline1_4.1_4_13_F95.Check',
description: 'Check that where receiving and then removing pointer hover or keyboard focus triggers additional content to become visible and then hidden, the following are true: \nDismissable: A mechanism is available to dismiss the additional content without moving pointer hover or keyboard focus, unless the additional content communicates an input error or does not obscure or replace other content; \nHoverable: If pointer hover can trigger the additional content, then the pointer can be moved over the additional content without the additional content disappearing; \nPersistent: The additional content remains visible until the hover or focus trigger is removed, the user dismisses it, or its information is no longer valid.'
},
{ {
name: 'WCAG2AA.Principle2.Guideline2_1.2_1_1.SCR20.DblClick', name: 'WCAG2AA.Principle2.Guideline2_1.2_1_1.SCR20.DblClick',
description: 'Ensure the functionality provided by double-clicking on this element is available through the keyboard.' description: 'Ensure the functionality provided by double-clicking on this element is available through the keyboard.'
@@ -969,6 +876,10 @@ function getStandards() {
name: 'WCAG2AA.Principle2.Guideline2_1.2_1_2.F10', name: 'WCAG2AA.Principle2.Guideline2_1.2_1_2.F10',
description: 'Check that this applet or plugin provides the ability to move the focus away from itself when using the keyboard.' description: 'Check that this applet or plugin provides the ability to move the focus away from itself when using the keyboard.'
}, },
{
name: 'WCAG2AA.Principle1.Guideline2_1.2_1_4.Check',
description: 'Check that if a keyboard shortcut is implemented in content using only letter (including upper- and lower-case letters), punctuation, number, or symbol characters, then at least one of the following is true: \nTurn off: A mechanism is available to turn the shortcut off; \nRemap: A mechanism is available to remap the shortcut to use one or more non- printable keyboard characters(e.g.Ctrl, Alt, etc); \nActive only on focus: The keyboard shortcut for a user interface component is only active when that component has focus.'
},
{ {
name: 'WCAG2AA.Principle2.Guideline2_2.2_2_1.F40.2', name: 'WCAG2AA.Principle2.Guideline2_2.2_2_1.F40.2',
description: 'Meta refresh tag used to redirect to another page, with a time limit that is not zero. Users cannot control this time limit.' description: 'Meta refresh tag used to redirect to another page, with a time limit that is not zero. Users cannot control this time limit.'
@@ -989,6 +900,10 @@ function getStandards() {
name: 'WCAG2AA.Principle2.Guideline2_2.2_2_2.F47', name: 'WCAG2AA.Principle2.Guideline2_2.2_2_2.F47',
description: 'Blink elements cannot satisfy the requirement that blinking information can be stopped within five seconds.' description: 'Blink elements cannot satisfy the requirement that blinking information can be stopped within five seconds.'
}, },
{
name: 'WCAG2AA.Principle1.Guideline2_2.2_2_6.Check',
description: 'Check that users are warned of the duration of any user inactivity that could cause data loss, unless the data is preserved for more than 20 hours when the user does not take any actions.'
},
{ {
name: 'WCAG2AA.Principle2.Guideline2_3.2_3_1.G19,G176', name: 'WCAG2AA.Principle2.Guideline2_3.2_3_1.G19,G176',
description: 'Check that no component of the content flashes more than three times in any 1-second period, or that the size of any flashing area is sufficiently small.' description: 'Check that no component of the content flashes more than three times in any 1-second period, or that the size of any flashing area is sufficiently small.'
@@ -1049,6 +964,38 @@ function getStandards() {
name: 'WCAG2AA.Principle2.Guideline2_4.2_4_7.G149,G165,G195,C15,SCR31', name: 'WCAG2AA.Principle2.Guideline2_4.2_4_7.G149,G165,G195,C15,SCR31',
description: 'Check that there is at least one mode of operation where the keyboard focus indicator can be visually located on user interface controls.' description: 'Check that there is at least one mode of operation where the keyboard focus indicator can be visually located on user interface controls.'
}, },
{
name: 'WCAG2AA.Principle1.Guideline2_5.2_5_1.Check',
description: 'Check that all functionality that uses multipoint or path-based gestures for operation can be operated with a single pointer without a path-based gesture, unless a multipoint or path-based gesture is essential.'
},
{
name: 'WCAG2AA.Principle1.Guideline2_5.2_5_2.SinglePointer_Check',
description: 'Check that for functionality that can be operated using a single pointer, at least one of the following is true: \nNo Down- Event: The down - event of the pointer is not used to execute any part of the function; \nAbort or Undo: Completion of the function is on the up - event, and a mechanism is available to abort the function before completion or to undo the function after completion; \nUp Reversal: The up - event reverses any outcome of the preceding down - event; \nEssential: Completing the function on the down - event is essential.'
},
{
name: 'WCAG2AA.Principle1.Guideline2_5.2_5_2.Mousedown_Check',
description: 'This element has an mousedown event listener. Check that for functionality that can be operated using a single pointer, at least one of the following is true: \nNo Down- Event: The down - event of the pointer is not used to execute any part of the function; \nAbort or Undo: Completion of the function is on the up - event, and a mechanism is available to abort the function before completion or to undo the function after completion; \nUp Reversal: The up - event reverses any outcome of the preceding down - event; \nEssential: Completing the function on the down - event is essential.'
},
{
name: 'WCAG2AA.Principle1.Guideline2_5.2_5_2.Touchstart_Check',
description: 'This element has a touchstart event listener. Check that for functionality that can be operated using a single pointer, at least one of the following is true: \nNo Down- Event: The down - event of the pointer is not used to execute any part of the function; \nAbort or Undo: Completion of the function is on the up - event, and a mechanism is available to abort the function before completion or to undo the function after completion; \nUp Reversal: The up - event reverses any outcome of the preceding down - event; \nEssential: Completing the function on the down - event is essential.'
},
{
name: 'WCAG2AA.Principle1.Guideline2_5.2_5_3_F96.Check',
description: 'Check that for user interface components with labels that include text or images of text, the name contains the text that is presented visually.'
},
{
name: 'WCAG2AA.Principle1.Guideline2_5.2_5_3_F96.AccessibleName',
description: 'Accessible name for this element does not contain the visible label text. Check that for user interface components with labels that include text or images of text, the name contains the text that is presented visually.'
},
{
name: 'WCAG2AA.Principle1.Guideline2_5.2_5_4.Check',
description: 'Check that functionality that can be operated by device motion or user motion can also be operated by user interface components and responding to the motion can be disabled to prevent accidental actuation, except when: \nSupported Interface: The motion is used to operate functionality through an accessibility supported interface; \nEssential: The motion is essential for the function and doing so would invalidate the activity.'
},
{
name: 'WCAG2AA.Principle1.Guideline2_5.2_5_4.Devicemotion',
description: 'WCAG2AA.This element has a devicemotion event listener. Check that functionality that can be operated by device motion or user motion can also be operated by user interface components and responding to the motion can be disabled to prevent accidental actuation, except when: \nSupported Interface: The motion is used to operate functionality through an accessibility supported interface; \nEssential: The motion is essential for the function and doing so would invalidate the activity.'
},
{ {
name: 'WCAG2AA.Principle3.Guideline3_1.3_1_1.H57.2', name: 'WCAG2AA.Principle3.Guideline3_1.3_1_1.H57.2',
description: 'The html element should have a lang or xml:lang attribute which describes the language of the document.' description: 'The html element should have a lang or xml:lang attribute which describes the language of the document.'
@@ -1140,6 +1087,10 @@ function getStandards() {
{ {
name: 'WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.[NodeName].Value', name: 'WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.[NodeName].Value',
description: 'This [element type] does not have a value available to an accessibility API. Add one [using a element-specific method].' description: 'This [element type] does not have a value available to an accessibility API. Add one [using a element-specific method].'
},
{
name: 'WCAG2AA.Principle1.Guideline4_1.4_1_3_ARIA22,G199,ARIA19,G83,G84,G85,G139,G177,G194,ARIA23.Check',
description: 'Check that status messages can be programmatically determined through role or properties such that they can be presented to the user by assistive technologies without receiving focus.'
} }
] ]
}, },
@@ -1410,6 +1361,58 @@ function getStandards() {
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_3.G96', name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_3.G96',
description: 'Where instructions are provided for understanding the content, do not rely on sensory characteristics alone (such as shape, size or location) to describe objects.' description: 'Where instructions are provided for understanding the content, do not rely on sensory characteristics alone (such as shape, size or location) to describe objects.'
}, },
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_4.RestrictView',
description: 'Check that content does not restrict its view and operation to a single display orientation, such as portrait or landscape, unless a specific display orientation is essential.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.FaultyValue',
description: 'This element contains a potentially faulty value in its autocomplete attribute.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Text',
description: 'Invalid autocomplete value. Element does not belong to Text control group.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Multiline',
description: 'Invalid autocomplete value. Element does not belong to Multiline control group.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Password',
description: 'Invalid autocomplete value. Element does not belong to Password control group.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Url',
description: 'Invalid autocomplete value. Element does not belong to Url control group.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Telephone',
description: 'Invalid autocomplete value. Element does not belong to Telephone control group.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Numeric',
description: 'Invalid autocomplete value. Element does not belong to Numeric control group.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Month',
description: 'Invalid autocomplete value. Element does not belong to Month control group.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.InvalidAutocomplete_Date',
description: 'Invalid autocomplete value. Element does not belong to Date control group.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.Purpose',
description: 'Check that the input field serves a purpose identified in the Input Purposes for User Interface Components section; and that the content is implemented using technologies with support for identifying the expected meaning for form input data.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_5_H98.MissingAutocomplete',
description: 'This element does not have an autocomplete attribute. If this field collects information about the user, consider adding one to comply with this Success Criterion.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_3.1_3_6_ARIA11.Check',
description: 'Check that the purpose of User Interface Components, icons, and regions can be programmatically determined.'
},
{ {
name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_1.G14,G182', name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_1.G14,G182',
description: 'Check that any information conveyed using colour alone is also available in text, or through other visual cues.' description: 'Check that any information conveyed using colour alone is also available in text, or through other visual cues.'
@@ -1427,11 +1430,11 @@ function getStandards() {
description: 'This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of /{value/}. Recommendation: /{colour recommendations/}.' description: 'This element has insufficient contrast at this conformance level. Expected a contrast ratio of at least 4.5:1, but text in this element has a contrast ratio of /{value/}. Recommendation: /{colour recommendations/}.'
}, },
{ {
name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_6.G17', name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_6.G17 ',
description: 'This element\'s text is placed on a background image. Ensure the contrast ratio between the text and all covered parts of the image are at least 7:1.' description: 'This element\'s text is placed on a background image. Ensure the contrast ratio between the text and all covered parts of the image are at least 7:1.'
}, },
{ {
name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_6.G18', name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_6.G18 ',
description: 'This element\'s text is placed on a background image. Ensure the contrast ratio between the text and all covered parts of the image are at least 4.5:1.' description: 'This element\'s text is placed on a background image. Ensure the contrast ratio between the text and all covered parts of the image are at least 4.5:1.'
}, },
{ {
@@ -1462,6 +1465,34 @@ function getStandards() {
name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_9.G140,C22,C30.NoException', name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_9.G140,C22,C30.NoException',
description: 'Check that images of text are only used for pure decoration or where a particular presentation of text is essential to the information being conveyed.' description: 'Check that images of text are only used for pure decoration or where a particular presentation of text is essential to the information being conveyed.'
}, },
{
name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_10_C32,C31,C33,C38,SCR34,G206.Check',
description: 'Check that content can be presented without loss of information or functionality, and without requiring scrolling in two dimensions for: \nVertical scrolling content at a width equivalent to 320 CSS pixels;\\n Horizontal scrolling content at a height equivalent to 256 CSS pixels; \nExcept for parts of the content which require two-dimensional layout for usage or meaning.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_10_C32,C31,C33,C38,SCR34,G206.Fixed',
description: 'Principle1.Guideline1_4.1_4_10_C32,C31,C33,C38,SCR34,G206.Scrolling'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_10_C32,C31,C33,C38,SCR34,G206.Zoom',
description: 'Interfering with a user agents ability to zoom may be a failure of this Success Criterion.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_11_G195,G207,G18,G145,G174,F78.Check',
description: 'Check that the visual presentation of the following have a contrast ratio of at least 3:1 against adjacent color(s): \nUser Interface Components: Visual information required to identify user interface components and states, except for inactive components or where the appearance of the component is determined by the user agent and not modified by the author; \nGraphical Objects: Parts of graphics required to understand the content, except when a particular presentation of graphics is essential to the information being conveyed.'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_12_C36,C35.Check',
description: 'Check that no loss of content or functionality occurs by setting all of the following and by changing no other style property: \nLine height(line spacing) to at least 1.5 times the font size; \nSpacing following paragraphs to at least 2 times the font size; \nLetter spacing(tracking) to at least 0.12 times the font size; \nWord spacing to at least 0.16 times the font size'
},
{
name: 'WCAG2AAA.Principle1.Guideline1_4.1_4_13_F95.Check',
description: 'Check that where receiving and then removing pointer hover or keyboard focus triggers additional content to become visible and then hidden, the following are true: \nDismissable: A mechanism is available to dismiss the additional content without moving pointer hover or keyboard focus, unless the additional content communicates an input error or does not obscure or replace other content; \nHoverable: If pointer hover can trigger the additional content, then the pointer can be moved over the additional content without the additional content disappearing; \nPersistent: The additional content remains visible until the hover or focus trigger is removed, the user dismisses it, or its information is no longer valid.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_1.2_1_4.Check',
description: 'Check that if a keyboard shortcut is implemented in content using only letter (including upper- and lower-case letters), punctuation, number, or symbol characters, then at least one of the following is true: \nTurn off: A mechanism is available to turn the shortcut off; \nRemap: A mechanism is available to remap the shortcut to use one or more non- printable keyboard characters(e.g.Ctrl, Alt, etc); \nActive only on focus: The keyboard shortcut for a user interface component is only active when that component has focus.'
},
{ {
name: 'WCAG2AAA.Principle2.Guideline2_1.2_1_1.SCR20.DblClick', name: 'WCAG2AAA.Principle2.Guideline2_1.2_1_1.SCR20.DblClick',
description: 'Ensure the functionality provided by double-clicking on this element is available through the keyboard.' description: 'Ensure the functionality provided by double-clicking on this element is available through the keyboard.'
@@ -1522,10 +1553,58 @@ function getStandards() {
name: 'WCAG2AAA.Principle2.Guideline2_2.2_2_5.G105,G181', name: 'WCAG2AAA.Principle2.Guideline2_2.2_2_5.G105,G181',
description: 'If this Web page is part of a set of Web pages with an inactivity time limit, check that an authenticated user can continue the activity without loss of data after re-authenticating.' description: 'If this Web page is part of a set of Web pages with an inactivity time limit, check that an authenticated user can continue the activity without loss of data after re-authenticating.'
}, },
{
name: 'WCAG2AAA.Principle1.Guideline2_2.2_2_6.Check',
description: 'Check that users are warned of the duration of any user inactivity that could cause data loss, unless the data is preserved for more than 20 hours when the user does not take any actions.'
},
{ {
name: 'WCAG2AAA.Principle2.Guideline2_3.2_3_2.G19', name: 'WCAG2AAA.Principle2.Guideline2_3.2_3_2.G19',
description: 'Check that no component of the content flashes more than three times in any 1-second period.' description: 'Check that no component of the content flashes more than three times in any 1-second period.'
}, },
{
name: 'WCAG2AAA.Principle1.Guideline2_3.2_3_3.Check',
description: 'Check that motion animation triggered by interaction can be disabled, unless the animation is essential to the functionality or the information being conveyed.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_5.2_5_1.Check',
description: 'Check that all functionality that uses multipoint or path-based gestures for operation can be operated with a single pointer without a path-based gesture, unless a multipoint or path-based gesture is essential.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_5.2_5_2.SinglePointer_Check',
description: 'Check that for functionality that can be operated using a single pointer, at least one of the following is true: \nNo Down- Event: The down - event of the pointer is not used to execute any part of the function; \nAbort or Undo: Completion of the function is on the up - event, and a mechanism is available to abort the function before completion or to undo the function after completion; \nUp Reversal: The up - event reverses any outcome of the preceding down - event; \nEssential: Completing the function on the down - event is essential.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_5.2_5_2.Mousedown_Check',
description: 'This element has an mousedown event listener. Check that for functionality that can be operated using a single pointer, at least one of the following is true: \nNo Down- Event: The down - event of the pointer is not used to execute any part of the function; \nAbort or Undo: Completion of the function is on the up - event, and a mechanism is available to abort the function before completion or to undo the function after completion; \nUp Reversal: The up - event reverses any outcome of the preceding down - event; \nEssential: Completing the function on the down - event is essential.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_5.2_5_2.Touchstart_Check',
description: 'This element has a touchstart event listener. Check that for functionality that can be operated using a single pointer, at least one of the following is true: \nNo Down- Event: The down - event of the pointer is not used to execute any part of the function; \nAbort or Undo: Completion of the function is on the up - event, and a mechanism is available to abort the function before completion or to undo the function after completion; \nUp Reversal: The up - event reverses any outcome of the preceding down - event; \nEssential: Completing the function on the down - event is essential.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_5.2_5_3_F96.Check',
description: 'Check that for user interface components with labels that include text or images of text, the name contains the text that is presented visually.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_5.2_5_3_F96.AccessibleName',
description: 'Accessible name for this element does not contain the visible label text. Check that for user interface components with labels that include text or images of text, the name contains the text that is presented visually.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_5.2_5_4.Check',
description: 'Check that functionality that can be operated by device motion or user motion can also be operated by user interface components and responding to the motion can be disabled to prevent accidental actuation, except when: \nSupported Interface: The motion is used to operate functionality through an accessibility supported interface; \nEssential: The motion is essential for the function and doing so would invalidate the activity.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_5.2_5_4.Devicemotion',
description: 'WCAG2AA.This element has a devicemotion event listener. Check that functionality that can be operated by device motion or user motion can also be operated by user interface components and responding to the motion can be disabled to prevent accidental actuation, except when: \nSupported Interface: The motion is used to operate functionality through an accessibility supported interface; \nEssential: The motion is essential for the function and doing so would invalidate the activity.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_5.2_5_5.Check',
description: 'Check that the size of the target for pointer inputs is at least 44 by 44 CSS pixels except when:\nEquivalent: The target is available through an equivalent link or control on the same page that is at least 44 by 44 CSS pixels;\nInline: The target is in a sentence or block of text;\nUser Agent Control: The size of the target is determined by the user agent and is not modified by the author;\nEssential: A particular presentation of the target is essential to the information being conveyed.'
},
{
name: 'WCAG2AAA.Principle1.Guideline2_5.2_5_6.Check',
description: 'Check that the content does not restrict use of input modalities available on a platform except where the restriction is essential, required to ensure the security of the content, or required to respect user settings.'
},
{ {
name: 'WCAG2AAA.Principle2.Guideline2_4.2_4_1.H64.1', name: 'WCAG2AAA.Principle2.Guideline2_4.2_4_1.H64.1',
description: 'Iframe element requires a non-empty title attribute that identifies the frame.' description: 'Iframe element requires a non-empty title attribute that identifies the frame.'
@@ -1713,6 +1792,10 @@ function getStandards() {
{ {
name: 'WCAG2AAA.Principle4.Guideline4_1.4_1_2.H91.[NodeName].Value', name: 'WCAG2AAA.Principle4.Guideline4_1.4_1_2.H91.[NodeName].Value',
description: 'This [element type] does not have a value available to an accessibility API. Add one [using a element-specific method].' description: 'This [element type] does not have a value available to an accessibility API. Add one [using a element-specific method].'
},
{
name: 'WCAG2AAA.Principle1.Guideline4_1.4_1_3_ARIA22,G199,ARIA19,G83,G84,G85,G139,G177,G194,ARIA23.Check',
description: 'Check that status messages can be programmatically determined through role or properties such that they can be presented to the user by assistive technologies without receiving focus.'
} }
] ]
} }

View File

@@ -603,6 +603,114 @@ function getTechniques() {
H91: { H91: {
title: 'H91: Using HTML form controls and links', title: 'H91: Using HTML form controls and links',
url: 'http://www.w3.org/TR/WCAG20-TECHS/H91' url: 'http://www.w3.org/TR/WCAG20-TECHS/H91'
},
F102: {
title: 'F102: Failure of Success Criterion 1.4.10 due to content disappearing and not being available when content has reflowed',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F102'
},
F103: {
title: 'F103: Failure of Success Criterion 4.1.3 due to providing status messages that cannot be programmatically determined through role or properties',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F103'
},
F104: {
title: 'F104: Failure of Success Criterion 1.4.12 due to clipped or overlapped content when text spacing is adjusted',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F104'
},
F105: {
title: 'F105: Failure of Success Criterion 2.5.1 due to providing functionality via a path- based gesture without simple pointer alternative',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F105'
},
F106: {
title: 'F106: Failure due to inability to deactivate motion actuation',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F106'
},
G216: {
title: 'G216: Providing single point activation for a control slider',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/general/G216'
},
G215: {
title: 'G215: Providing controls to achieve the same result as path based or multipoint gestures',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/general/G215'
},
F100: {
title: 'F100: Failure of Success Criterion 1.3.4 due to showing a message asking to reorient device',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F100'
},
G214: {
title: 'G214: Using a control to allow access to content in different orientations which is otherwise restricted',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/general/G214'
},
C40: {
title: 'C40: Creating a two-color focus indicator to ensure sufficient contrast with all components',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/css/C40'
},
F99: {
title: 'F99: Failure of Success Criterion 2.1.4 due to implementing character key shortcuts that cannot be turned off or remapped',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F99'
},
SCR39: {
title: 'SCR39: Making content on focus or hover hoverable, dismissible, and persistent',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/client-side-script/SCR39'
},
G212: {
title: 'G212: Using native controls to ensure functionality is triggered on the up-event.',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/general/G212'
},
F98: {
title: 'F98: Failure due to interactions being limited to touch-only on touchscreen devices',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F98'
},
G213: {
title: 'G213: Provide conventional controls and an application setting for motion activated input',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/general/G213'
},
ARIA24: {
title: 'ARIA24: Semantically identifying a font icon with role="img"',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/aria/ARIA24'
},
F97: {
title: 'F97: Failure due to locking the orientation to landscape or portrait view',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F97'
},
F52: {
title: 'F52: Failure of Success Criterion 3.2.1 and 3.2.5 due to opening a new window as soon as a new page is loaded ',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F52'
},
G209: {
title: 'G209: Provide sufficient contrast at the boundaries between adjoining colors',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/general/G209'
},
C39: {
title: 'C39: Using the CSS reduce-motion query to prevent motion',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/css/C39'
},
G207: {
title: 'G207: Ensuring that a contrast ratio of 3:1 is provided for icons',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/general/G207'
},
C38: {
title: 'C38: Using CSS width, max-width and flexbox to fit labels and inputs',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/css/C38'
},
C34: {
title: 'C34: Using media queries to un-fixing sticky headers / footers',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/css/C34'
},
C36: {
title: 'C36: Allowing for text spacing override',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/css/C36'
},
C37: {
title: 'C37: Using CSS max-width and height to fit images',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/css/C37'
},
F95: {
title: 'F95: Failure of Success Criterion 1.4.13 due to content shown on hover not being hoverable',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F95'
},
F96: {
title: 'F96: Failure due to the accessible name not containing the visible label text',
url: 'https://www.w3.org/WAI/WCAG21/Techniques/failures/F96'
} }
}; };
} }

View File

@@ -1,6 +1,6 @@
{ {
"name": "pa11y-dashboard", "name": "pa11y-dashboard",
"version": "3.3.0", "version": "4.2.0",
"private": true, "private": true,
"description": "Pa11y Dashboard is a visual web interface to the Pa11y accessibility reporter", "description": "Pa11y Dashboard is a visual web interface to the Pa11y accessibility reporter",
"keywords": [ "keywords": [
@@ -21,28 +21,29 @@
"bugs": "https://github.com/pa11y/dashboard/issues", "bugs": "https://github.com/pa11y/dashboard/issues",
"license": "GPL-3.0", "license": "GPL-3.0",
"engines": { "engines": {
"node": ">=8", "node": ">=12 <16"
"npm": ">=6"
}, },
"dependencies": { "dependencies": {
"body-parser": "~1.19.0", "body-parser": "~1.19.2",
"compression": "~1.7.4", "compression": "~1.7.4",
"express": "~4.17.1", "express": "~4.17.3",
"express-hbs": "~2.4.0", "express-hbs": "~2.4.0",
"http-headers": "~3.0.2", "http-headers": "~3.0.2",
"kleur": "~4.1.2", "kleur": "~4.1.4",
"moment": "~2.29.0", "moment": "~2.29.1",
"pa11y-webservice": "~3.2.1", "morgan": "~1.10.0",
"pa11y-webservice-client-node": "~2.0.0", "nanoid": "~3.3.2",
"underscore": "~1.11.0" "pa11y-webservice": "~4.0.1",
"pa11y-webservice-client-node": "~3.0.0",
"underscore": "~1.13.2"
}, },
"devDependencies": { "devDependencies": {
"bower": "^1.8.8", "bower": "^1.8.13",
"cheerio": "^1.0.0-rc.3", "cheerio": "^1.0.0-rc.10",
"eslint": "^6.8.0", "eslint": "^7.27.0",
"less": "^3.11.1", "less": "^3.11.1",
"mocha": "^7.2.0", "mocha": "^8.4.0",
"pa11y-lint-config": "^1.2.1", "pa11y-lint-config": "^2.0.0",
"proclaim": "^3.6.0", "proclaim": "^3.6.0",
"request": "^2.88.2", "request": "^2.88.2",
"uglify-js": "^3.11.0" "uglify-js": "^3.11.0"

File diff suppressed because one or more lines are too long

View File

@@ -175,7 +175,6 @@
text-transform: uppercase; text-transform: uppercase;
display: block; display: block;
line-height: 1.4; line-height: 1.4;
.opacity(.8);
} }
// Stats box colours // Stats box colours
@@ -753,3 +752,11 @@ ul.date-links {
border-top-right-radius: 0; border-top-right-radius: 0;
} }
} }
/*close button on success alert*/
.alert-success {
.close {
color: #fff;
opacity: 1;
};
}

View File

@@ -18,9 +18,9 @@
// ------------------------- // -------------------------
@brand-primary: #2C3E50; @brand-primary: #2C3E50;
@brand-success: #00806F; @brand-success: #006053;
@brand-warning: #A86700; @brand-warning: #b24d04;
@brand-danger: #D83D2D; @brand-danger: #c92a2a;
@brand-info: #177BBE; @brand-info: #177BBE;
// Scaffolding // Scaffolding

View File

@@ -1,7 +1,7 @@
'use strict'; 'use strict';
// Clone the main config // Clone the main config
var config = module.exports = JSON.parse(JSON.stringify(require('../.eslintrc'))); const config = module.exports = JSON.parse(JSON.stringify(require('../.eslintrc')));
// We use `this` all over the integration tests // We use `this` all over the integration tests
config.rules['no-invalid-this'] = 'off'; config.rules['no-invalid-this'] = 'off';

View File

@@ -19,7 +19,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<p class="h2">Let's see what we can do here:</h2> <p class="h2">Let's see what we can do here:</h2>
<ul> <ul>
<li>Do you have <a href="https://www.mongodb.com/">MongoDB</a> installed and <code>mongod</code> running?</li> <li>Do you have <a href="https://www.mongodb.com/">MongoDB</a> installed and <code>mongod</code> running?</li>
<li>Check out the <a href="https://github.com/pa11y/dashboard/blob/master/TROUBLESHOOTING.md">Troubleshooting doc</a> for more information.</li> <li>Check out the <a href="https://github.com/pa11y/dashboard/blob/master/README.md#troubleshooting">Troubleshooting guide</a> for more information.</li>
<li>Search for a related <a href="https://github.com/pa11y/dashboard/issues">Github issue</a>, or open one yourself.</li> <li>Search for a related <a href="https://github.com/pa11y/dashboard/issues">Github issue</a>, or open one yourself.</li>
</ul> </ul>
{{#if error}} {{#if error}}

View File

@@ -40,7 +40,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#deleted}} {{#deleted}}
<div class="col-md-12 clearfix" data-test="alert"> <div class="col-md-12 clearfix" data-test="alert">
<div class="alert alert-info"> <div class="alert alert-info">
<button aria-hidden="true" data-dismiss="alert" class="close" type="button">×</button> <button data-dismiss="alert" class="close" type="button" aria-label="Close">×</button>
<strong>Bye Bye URL</strong> <strong>Bye Bye URL</strong>
<p>The URL you selected and its associated results have been deleted.</p> <p>The URL you selected and its associated results have been deleted.</p>
</div> </div>

View File

@@ -19,7 +19,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
Add a new URL Add a new URL
{{/content}} {{/content}}
<form role="form" class="col-md-12" action="/new" method="post" data-test="new-url-form"> <form class="col-md-12" action="/new" method="post" data-test="new-url-form">
<div class="legend"> <div class="legend">
<h1 class="h2 crunch-top">Add a new URL</h1> <h1 class="h2 crunch-top">Add a new URL</h1>

View File

@@ -15,7 +15,7 @@ You should have received a copy of the GNU General Public License
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>. along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}} }}
<footer> <footer>
<div class="footer" role="contentinfo"> <div class="footer">
<div class="container"> <div class="container">
<div class="col-md-5"> <div class="col-md-5">
<small>&copy; 2013{{year}} Team Pa11y.<br/>Pa11y Dashboard is licensed under the GNU General Public License 3.0.<br/>Version {{version}}</small> <small>&copy; 2013{{year}} Team Pa11y.<br/>Pa11y Dashboard is licensed under the GNU General Public License 3.0.<br/>Version {{version}}</small>
@@ -29,7 +29,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<a href="{{bugtracker}}">Bug Tracker</a> <a href="{{bugtracker}}">Bug Tracker</a>
</li> </li>
<li> <li>
<a href="http://www.w3.org/TR/WCAG20/">WCAG 2.0 spec</a> <a href="https://www.w3.org/TR/WCAG21/">WCAG 2.1 spec</a>
</li> </li>
<li> <li>
<a href="http://squizlabs.github.io/HTML_CodeSniffer/">HTML_CodeSniffer</a> <a href="http://squizlabs.github.io/HTML_CodeSniffer/">HTML_CodeSniffer</a>

View File

@@ -15,7 +15,7 @@ You should have received a copy of the GNU General Public License
along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>. along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
}} }}
<header> <header>
<div role="banner" class="header"> <div class="header">
<div class="container"> <div class="container">
{{#if isHomePage}}<h1>{{else}}<div class="h1">{{/if}} {{#if isHomePage}}<h1>{{else}}<div class="h1">{{/if}}
<a href="/">Pa11y Dashboard</a> - <a href="/">Pa11y Dashboard</a> -

View File

@@ -40,12 +40,14 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<h2 class="h4"> <h2 class="h4">
<span class="glyphicon glyphicon-calendar" aria-hidden="true"></span>&nbsp;&nbsp;{{date-format task.lastResult.date format="DD MMM YYYY"}} <span class="glyphicon glyphicon-calendar" aria-hidden="true"></span>&nbsp;&nbsp;{{date-format task.lastResult.date format="DD MMM YYYY"}}
</h2> </h2>
<h3 class="h5 show-stats">Select a date to show stats for:</h3> <h3 class="h5 show-stats" id="dates-navigation">Select a date to show stats for:</h3>
<ul role="navigation" class="dates-list"> <nav aria-labelledby="dates-navigation">
{{#results}} <ul class="dates-list">
<li><a class="" href="{{href}}">{{date-format date format="DD MMM YYYY"}}</a></li> {{#results}}
{{/results}} <li><a class="" href="{{href}}">{{date-format date format="DD MMM YYYY"}}</a></li>
</ul> {{/results}}
</ul>
</nav>
</div> </div>
</div> </div>
</div> </div>
@@ -61,7 +63,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
</div> </div>
</div> </div>
<div class="col-md-9" role="main"> <div class="col-md-9">
<ul class="nav nav-tabs category-list" role="tablist"> <ul class="nav nav-tabs category-list" role="tablist">
<li class="category-list__item category-list__item_type_error active" role="presentation"> <li class="category-list__item category-list__item_type_error active" role="presentation">
<a class="category-list__link" id="errors" href="#errors-list" aria-controls="errors-list" role="tab" data-toggle="tab" data-test="task-errors"> <a class="category-list__link" id="errors" href="#errors-list" aria-controls="errors-list" role="tab" data-toggle="tab" data-test="task-errors">
@@ -116,10 +118,10 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="task-details collapse" id="error-index-{{@index}}"> <div class="task-details collapse" id="error-index-{{@index}}">
{{#if solutions.length}} {{#if solutions.length}}
<div class="subtitle" id="error-solutions">Solutions:</div> <div class="subtitle">Solutions:</div>
<ul class="list-unstyled solutions-list" role="list" aria-labelledby="error-solutions"> <ul class="list-unstyled solutions-list">
{{#each solutions}} {{#each solutions}}
<li class="list-unstyled__item" role="listitem"> <li class="list-unstyled__item">
<a class="link" href="{{url}}" target="_blank"> <a class="link" href="{{url}}" target="_blank">
<span class="glyphicon glyphicon-share" aria-hidden="true"></span>&nbsp;{{title}} <span class="glyphicon glyphicon-share" aria-hidden="true"></span>&nbsp;{{title}}
</a> </a>
@@ -129,10 +131,10 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{/if}} {{/if}}
{{#if items.length}} {{#if items.length}}
<div class="subtitle" id="error-selectors">Selectors:</div> <div class="subtitle">Selectors:</div>
<ul class="list-unstyled selectors-list" role="list" aria-labelledby="error-selectors"> <ul class="list-unstyled selectors-list">
{{#each items}} {{#each items}}
<li class="list-unstyled__item" role="listitem"> <li class="list-unstyled__item">
<span title="Context" data-role="context-popover" data-toggle="popover" data-content="{{context}}"> <span title="Context" data-role="context-popover" data-toggle="popover" data-content="{{context}}">
<code class="code">{{selector}}</code> <code class="code">{{selector}}</code>
</span> </span>
@@ -182,10 +184,10 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="task-details collapse" id="warning-index-{{@index}}"> <div class="task-details collapse" id="warning-index-{{@index}}">
{{#if solutions.length}} {{#if solutions.length}}
<div class="subtitle" id="warning-solutions">Solutions:</div> <div class="subtitle">Solutions:</div>
<ul class="list-unstyled solutions-list" role="list" aria-labelledby="warning-solutions"> <ul class="list-unstyled solutions-list">
{{#each solutions}} {{#each solutions}}
<li class="list-unstyled__item" role="listitem"> <li class="list-unstyled__item">
<a class="link" href="{{url}}" target="_blank"> <a class="link" href="{{url}}" target="_blank">
<span class="glyphicon glyphicon-share" aria-hidden="true"></span>&nbsp;{{title}} <span class="glyphicon glyphicon-share" aria-hidden="true"></span>&nbsp;{{title}}
</a> </a>
@@ -195,10 +197,10 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{/if}} {{/if}}
{{#if items.length}} {{#if items.length}}
<div class="subtitle" id="warning-selectors">Selectors:</div> <div class="subtitle">Selectors:</div>
<ul class="list-unstyled selectors-list" role="list" aria-labelledby="warning-selectors"> <ul class="list-unstyled selectors-list">
{{#each items}} {{#each items}}
<li class="list-unstyled__item" role="listitem"> <li class="list-unstyled__item">
<span title="Context" data-role="context-popover" data-toggle="popover" data-content="{{context}}"> <span title="Context" data-role="context-popover" data-toggle="popover" data-content="{{context}}">
<code class="code">{{selector}}</code> <code class="code">{{selector}}</code>
</span> </span>
@@ -248,10 +250,10 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="task-details collapse" id="notice-index-{{@index}}"> <div class="task-details collapse" id="notice-index-{{@index}}">
{{#if solutions.length}} {{#if solutions.length}}
<div class="subtitle" id="notice-solutions">Solutions:</div> <div class="subtitle">Solutions:</div>
<ul class="list-unstyled solutions-list" role="list" aria-labelledby="notice-solutions"> <ul class="list-unstyled solutions-list">
{{#each solutions}} {{#each solutions}}
<li class="list-unstyled__item" role="listitem"> <li class="list-unstyled__item">
<a class="link" href="{{url}}" target="_blank"> <a class="link" href="{{url}}" target="_blank">
<span class="glyphicon glyphicon-share" aria-hidden="true"></span>&nbsp;{{title}} <span class="glyphicon glyphicon-share" aria-hidden="true"></span>&nbsp;{{title}}
</a> </a>
@@ -261,10 +263,10 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{/if}} {{/if}}
{{#if items.length}} {{#if items.length}}
<div class="subtitle" id="notice-selectors">Selectors:</div> <div class="subtitle">Selectors:</div>
<ul class="list-unstyled selectors-list" role="list" aria-labelledby="notice-selectors"> <ul class="list-unstyled selectors-list">
{{#each items}} {{#each items}}
<li class="list-unstyled__item" role="listitem"> <li class="list-unstyled__item">
<span title="Context" data-role="context-popover" data-toggle="popover" data-content="{{context}}"> <span title="Context" data-role="context-popover" data-toggle="popover" data-content="{{context}}">
<code class="code">{{selector}}</code> <code class="code">{{selector}}</code>
</span> </span>

View File

@@ -24,11 +24,13 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
<div class="run-details task-header clearfix"> <div class="run-details task-header clearfix">
<div class="col-md-12 clearfix"> <div class="col-md-12 clearfix">
{{#unless readonly}} {{#unless readonly}}
<ul class="inline-list" role="menu"> <nav aria-label="task tools">
<li><a href="/{{task.id}}/edit">Edit this task</a></li> <ul class="inline-list">
<li><a href="/{{task.id}}/delete">Delete this task</a></li> <li><a href="/{{task.id}}/edit">Edit this task</a></li>
<li><a href="{{task.hrefRun}}" data-test="run-task">Run Pa11y</a></li> <li><a href="/{{task.id}}/delete">Delete this task</a></li>
</ul> <li><a href="{{task.hrefRun}}" data-test="run-task">Run Pa11y</a></li>
</ul>
</nav>
{{/unless}} {{/unless}}
{{#if mainResult}} {{#if mainResult}}
<div class="date">Last run: <strong>{{date-format mainResult.date format="DD MMM YYYY"}}</strong></div> <div class="date">Last run: <strong>{{date-format mainResult.date format="DD MMM YYYY"}}</strong></div>

View File

@@ -56,12 +56,14 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#unless ../readonly}} {{#unless ../readonly}}
<div class="btn-group options-button text-right"> <div class="btn-group options-button text-right">
<button type="button" class="btn btn-info btn-xs dropdown-toggle" data-toggle="dropdown"><span class="sr-only">Options</span><span class="glyphicon glyphicon-cog"></span></button> <button type="button" class="btn btn-info btn-xs dropdown-toggle" data-toggle="dropdown"><span class="sr-only">Options</span><span class="glyphicon glyphicon-cog"></span></button>
<ul class="dropdown-menu pull-right" role="menu"> <nav aria-label="task tools">
<li><a href="{{href}}/edit">Edit this task</a></li> <ul class="dropdown-menu pull-right">
<li><a href="{{href}}/delete">Delete this task</a></li> <li><a href="{{href}}/edit">Edit this task</a></li>
<li class="divider"></li> <li><a href="{{href}}/delete">Delete this task</a></li>
<li><a href="{{href}}/run" data-test="run-task">Run Pa11y</a></li> <li class="divider"></li>
</ul> <li><a href="{{href}}/run" data-test="run-task">Run Pa11y</a></li>
</ul>
</nav>
</div> </div>
{{/unless}} {{/unless}}
</li> </li>

View File

@@ -29,7 +29,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
</div> </div>
{{/edited}} {{/edited}}
<form role="form" class="col-md-12" action="/{{task.id}}/edit" method="post" data-test="edit-url-form"> <form class="col-md-12" action="/{{task.id}}/edit" method="post" data-test="edit-url-form">
<div class="legend"> <div class="legend">
<h1 class="h2 crunch-top">Edit URL</h1> <h1 class="h2 crunch-top">Edit URL</h1>

View File

@@ -22,7 +22,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#added}} {{#added}}
<div class="col-md-12 clearfix" data-test="alert"> <div class="col-md-12 clearfix" data-test="alert">
<div class="alert alert-success"> <div class="alert alert-success">
<button aria-hidden="true" data-dismiss="alert" class="close" type="button">×</button> <button data-dismiss="alert" class="close" type="button">×</button>
<strong>Whoop whoop!</strong> <strong>Whoop whoop!</strong>
<p>Your new URL has been added.</p> <p>Your new URL has been added.</p>
</div> </div>
@@ -32,7 +32,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#running}} {{#running}}
<div class="col-md-12 clearfix" data-test="alert"> <div class="col-md-12 clearfix" data-test="alert">
<div class="alert alert-success"> <div class="alert alert-success">
<button aria-hidden="true" data-dismiss="alert" class="close" type="button">×</button> <button data-dismiss="alert" class="close" type="button">×</button>
<strong>New results incoming!</strong> <strong>New results incoming!</strong>
<p> <p>
New results are being generated for this URL in the background. New results are being generated for this URL in the background.
@@ -45,7 +45,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#ruleIgnored}} {{#ruleIgnored}}
<div class="col-md-12 clearfix" data-test="alert"> <div class="col-md-12 clearfix" data-test="alert">
<div class="alert alert-success"> <div class="alert alert-success">
<button aria-hidden="true" data-dismiss="alert" class="close" type="button">×</button> <button data-dismiss="alert" class="close" type="button">×</button>
<strong>Rule ignored!</strong> <strong>Rule ignored!</strong>
<p> <p>
You've ignored an accessibility rule for this URL. You've ignored an accessibility rule for this URL.
@@ -58,7 +58,7 @@ along with Pa11y Dashboard. If not, see <http://www.gnu.org/licenses/>.
{{#ruleUnignored}} {{#ruleUnignored}}
<div class="col-md-12 clearfix" data-test="alert"> <div class="col-md-12 clearfix" data-test="alert">
<div class="alert alert-success"> <div class="alert alert-success">
<button aria-hidden="true" data-dismiss="alert" class="close" type="button">×</button> <button data-dismiss="alert" class="close" type="button">×</button>
<strong>Rule unignored!</strong> <strong>Rule unignored!</strong>
<p> <p>
You've removed an ignored accessibility rule for this URL. You've removed an ignored accessibility rule for this URL.