Giter Club home page Giter Club logo

applause-a11y-fixer's Introduction

applause-a11y-fixer

This command line application runs axe-core accessibility checks against html files or urls. It can return a report of accessibility problems or write the fixed html to a new or existing local file.

(if you are looking for the curated version of the plug-in please click here)

Prerequisites

Quickstart

Setup the application:

npm run setup

Run the linter(s):

npm run lint

Usage

Report violation(s) for the example-file:

node src/cli.js report example.html

Fix violation(s) for the example-file:

node src/cli.js fix example.html example-fixed.html

Options

Review the help to see various options

$ node src/cli.js -h
$ node src/cli.js fix -h
$ node src/cli.js report -h

Flags:

  • Global
    • -r, --rules <rules> Only run checks or fixes against this list of comma separated rule id's. Example: -r "button-name, valid-lang"
  • fix
    • -p, --preview Print the fixed html to the console. When using this rule a target file does not need to be specified.
  • report
    • -j, --json Print the raw Axe violation json data instead of the human readable version.

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.