a11y-sitechecker
TypeScript icon, indicating that this package has built-in type declarations

6.1.0 • Public • Published

a11y-sitechecker

npm version Codacy Badge Commits since last release Libraries.io dependency status for GitHub repo Downloads per month

A11y-sitecheker is a tool to check a site against accessibility criteria. It uses axe-core with the option to combine results of multiple sites. On the one hand there is the option to let the tool crawl your whole site and on the other site you can provide urls which should be checked by the tool. The results are printed to the console, saved as JSONs or returned. The tool can be called by javascript or directly by command line. Additionally there are Images created which indicates the errors, shows the tab-order and other features.

Features

  • Crawls Websites automatically for accessibility issues
    • In addition clicking all Clickable Items (Alpha Status)
  • Analyze a Set of URLs agains accessibility criteria
  • Provide Images for
    • Tab-Order (A C means you have to check if there are click and key interaction is possible!)
    • Errors highlighted
    • View of site in general
  • Results for different viewports

Test Coverage

Statements Branches Functions Lines
Statements Branches Functions Lines

Install

npm install a11y-sitechecker | yarn add a11y-sitechecker

Usage

Commandline

You can use it in your package.json or in your console like the following:

a11y-sitechecker --config=config.json -T=1000

The available options on the commandline are:

-j | --json: "Output results as JSON. Otherwise output is displayed on the console"
--config <string>: "Provide a config.json"
-T, --threshold <number> "permit this number of errors, warnings, or notices, otherwise fail with exit code 2"

Typescript

Call the entry function in your code and use the provided interfaces. The result is an array which contains a result for every specified viewport. Only return defined if there is console output or not.

export async function entry(
    config: Config,
    axeSpecs: Spec,
    url: string,
    onlyReturn?: boolean,
): Promise<A11ySitecheckerResult[]>;

Configuration File Options

Every option can be inserted in a json Format and wil be parsed at startup. Examples are below, how to define it in a json file!

Overview

export interface Config {
    json: boolean;
    resultsPath: string;
    resultsPathPerUrl: string;
    axeConfig?: AxeConfig;
    login?: Login;
    saveImages?: boolean;
    imagesPath?: string;
    launchOptions?: LaunchOptions;
    ignoreElementAttributeValues?: string[];
    urlsToAnalyze: string[];
    clickableItemSelector?: string;
    analyzeClicks?: boolean;
    analyzeClicksWithoutNavigation?: boolean;
    threshold: number;
    timeout: number;
    debugMode: boolean;
    viewports: SitecheckerViewport[];
    resultTypes: resultGroups[];
    idTags?: IdTag;
    runOnly: RunOnly | TagValue[] | string[];
    crawl: boolean;
    name: string;
    cookieSelector?: string; // provide a selector for clicking cookie consent button (example: "[id*=cookie] a, [class*=cookie] a, [id*=cookie] button, [class*=cookie] button, [id*=didomi] button")
    cookieText?: string; //provides a text for cookie consent text (example: "^(Alle akzeptieren|Akzeptieren|Verstanden|Zustimmen|Okay|OK|Alle Cookies akzeptieren)$")
    screenshotPadding?: number; //padding for making screenshots (Standardvalue is 10). Sometime you like to see more of the element, because you are using small elements, like icon Buttons to check
}

Config Option Details

Every configuration which is not inserted in the config file is by default false or undefined if not explicitly mentioned!

Name

The name is the major element to identify your run! You have to provide it

{
  "name": "MyName"
}
JSON Output

Define if output should be to a json file. You can additionally add a path to store the results.json file!

{
  "json": true,
  "resultsPath": "to a folder, starting with the folder where the script is executed"
}
Axe-core Language

If you like to choose your own language for the axe-core results, you can define a locale from the standard locales your you can provide your own locale with a path!

{
  "axeConfig": {
    "locale": "de",
    "localePath": "path to locale"
  }
}
Login steps

If your site need some login steps you can define it here! The input array defines the elements with css-selectors where you like to input the value! In the end you have to define the button which is clicked after the form is filled! You can repeat this steps if needed!

{
  "login": {
    "url": "http://myloginurl.at",
    "steps": [
      {
        "input": [
          {
            "selector": "#user_login",
            "value": "user"
          },
          {
            "selector": "#user_pass",
            "value": "passwort"
          }
        ],
        "submit": "#wp-submit"
      }
    ]
  }
}
Images

If you like to take Screenshots during the evaluation, define it here! The images are saved in a folder images under the results path!

{
  "saveImages": true
}
Launch Options

You can define launch Options for puppeteer. Please see the documentation here

{
  "launchOptions": {}
}
Ignoring Elements

You can define string which should lead to ignored links and button clicks. Usually if you a are in a logged in context the crawle should not do a logout!

{
  "ignoreElementAttributeValues": [
    "logout"
  ]
}
Links to Analyze

You have to define the links you like to analyze. If you specify 1 link, you can use the crawl function, which crawls then the url. If you provide more then 1 url, you are not allowed to set crawl to true. It is by default false!

{
  "urlsToAnalyze": [
    "www.test.at"
  ],
  "crawl": true
}
Analyzing Clicks

It is possible to analyze clickable Items, which are not links (buttons who change the view,...). By default it searches by this selector : "button, select, details, [tabindex]:not([tabindex="-1"])" You can activate this by:

{
  "analyzeClicks": true,
  "clickableItemSelector": "button, details"
}
Clicks without Navigation

It is possible to analyze button clicks which does not affect the url. If you like to use this feature activate it here!

{
  "analyzeClicksWithoutNavigation": true
}
Deactive analyze of clicks

You can activate/deactive the analyze of clicks (alpha status). Standard is false!

{
  "analyzeClicks": true
}
Threshold and Timeout

You can specify a timeout in ms for operations which can lead to errors (for example a selector is not found). To cause the console to end with an error if there are more errors than allowed (for example in build pipelines) you can specifiy a threshold (same like in the command line). Standard: threshold 0, timeout 30000

{
  "threshold": 100,
  "timeout": 1000
}
DebugMode

Activating the debugMode leads to more logs presented in the console output. By default it is false

{
  "debugMode": true
}
Specifiying viewport

Viewports are used for different devices. Sometimes there are different elements which can cause new or other accessibility problems! Standard viewport ist 1920*1080!

{
  "viewports": [
    {
      "width": 1920,
      "height": 1080
    }
  ]
}
Result types

Result types are used to reduce effort for axe-core (Documentation) Standard is violations and incomplete!

{
  "resultTypes": [
    "violations",
    "incomplete"
  ]
}
ID-Tags

ID-Tags are used to mark axe-core rules with own Tags (for example if someone wants to know only these results)

{
  "idTags": {
    "aria-required-attr": [
      "XYZ"
    ],
    "meta-viewport": [
      "XYZ"
    ]
  }
}

Package Sidebar

Install

npm i a11y-sitechecker

Weekly Downloads

159

Version

6.1.0

License

GPL-3.0-or-later

Unpacked Size

91 kB

Total Files

60

Last publish

Collaborators

  • forsti