Code Monkey home page Code Monkey logo

pa11y-tool's Introduction

pa11y-tool

A tool for running Pa11y against URLs in bulk

Install and run

  • Run npm i
  • Run npm start (bulk)
  • Run npm run pa11y (single url)

Running

Bulk

  • Add the list of urls you want to test to the array in data/input.json
  • The output should be in the data/output.json file

Single

  • Add the url you want to test in the pa11y script command in the package file (after the URL= parameter)
  • The output should be shown in the terminal

Example output:

{
    "Here is an issue": [
        "url that breaks this issue"
    ],
    "Duplicate id attribute value \"google\" found on the web page.": [
        "https://www.google.com",
        "https://www.example.com"
    ]
}

TODO

  • Show warnings by default and get this working
  • Display the results nicely
  • Ability to ignore certian rules
  • Add element reference the issue was discovered on
  • Add reference to related WCAG criteria
  • Add ability to pass the url into the single task command

Credit

Adapted from - https://github.com/mmacartney10/pa11y-child-processes-super-quick by Matt Macartney.

pa11y-tool's People

Contributors

jimbateson avatar

Watchers

 avatar

pa11y-tool's Issues

Showing warnings breaks bulk output

When setting the Pa11y warnings option to true, running the bulk URL task results in an empty object being added to the output.json file.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.