wcagspider

Version, currently master branch1 version
  • master branchlatestSep 9, 2020

github.com/joshsoftware/wcagspider

No description declared in shard.yml.

1 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  wcagspider:
    github: joshsoftware/wcagspider
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
0.35.1
License
MIT
Author
Kirk Haines
Target
  • wcagspider from src/wcagspider.cr

Dependencies

Runtime Dependencies

  • arachnid*github: watzon/arachnid, branch: master

README

wcagspider

This is a very simple spider that will walk a provided site, finding all of the pages on the site. It will then either output the page URLs to STDOUT, or call a command on them.

This can be used with another tool like pa11y to do additional operations, such as WCAG analysis.

Usage

The command line processing is extremely simple. If there is one argument, it is the URL of the site.

If there is a second argument, it is the specific command to invoke with the URL of the page to further analyze.

Pa11y

This is an open source tool for doing WCAG analysis on URLs. Given a working nodejs installation, it can be installed with:

npm install -g pa11y

It does require a working chromium installation that is sandbox capable, so it will break on Windows10/WSL1.

By default both pa11y and this spider's invocation of it utilize the HTML CodeSniffer, aka htmlcs, engine to analyze a site.

pa11y can also be told to use the axe-common tool, via the --runner axe command line flag to it. See the pa11y documentation for more specific information.

Todo

  • Real command line processing.
  • Automatic deduplication of urls -- the spider library should do this, but it seems like sometimes we still get duplicates.
  • Eliminate the middleman, and make this tool itself directly use HTMLCS and/or AXE-COMMON without depending on pa11y which in turn depends on them.

Contributors