wcag-validator

    5.0.0 • Public • Published

    Build Status js-standard-style

    wcag-validator

    A Node.js module/CLI app for checking web accessibility using achecker.ca.

    In order to use this module you must supply a Web Service ID from achecker. You can register for free at http://achecker.ca/

    This module implements the Accessibility validation review from Achecker Web Service API.

    Installation

    $ npm install wcag-validator

    or globally for CLI app

    $ npm install wcag-validator -g

    Usage - module

    Create an options object.

    uri URI to page you want to validate (required)

    id Your web service ID from Achecker (required)

    output Output format of report. Defaults to 'html' can be set to 'rest'

    guide Guidelines to validate against. Defaults to 'WCAG2-AA'. Alternatives: 'BITV1', '508', 'STANCA', 'WCAG1-A', 'WCAG1-AA', 'WCAG1-AAA', 'WCAG2-A', 'WCAG2-AA', 'WCAG2-AAA'. For multiple guidelines separate with comma.

    offset The line offset to begin validation on the html output from URI.. Defaults to 0.

    (async () => {
      const validator = require('wcag-validator')
      const options = {
        uri : 'https://uri-to-validate.com',
        id : 'your-webservice-id-from-achecker'
      }
     
      try {
        const result = await validator(options)
        console.log(result)
      } catch (error) {
        console.error(error)
      }
    })()

    Usage - CLI app

    $ wcag-validator <uri to validate> --id=<achecker id>

    Optional

    $ wcag-validator <uri to validate> --id=<achecker id> --output=<output> --guide=<guide> --offset=<offset>

    Usage - npx

    $ npx wcag-validator <uri to validate> --id=<achecker id>

    Optional

    $ npx wcag-validator <uri to validate> --id=<achecker id> --output=<output> --guide=<guide> --offset=<offset>

    Local development

    achecker needs access to your site to be able to perform the tests.

    If you are doing local development you can use ngrok, localtunnel or similar solutions.

    License

    MIT

    Install

    npm i wcag-validator

    DownloadsWeekly Downloads

    19

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    8.63 kB

    Total Files

    9

    Last publish

    Collaborators

    • avatar