@intouchgroup/image-accessibility-tester
CLI for batch testing website image accessibility
Last updated 3 months ago by codynova .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @intouchgroup/image-accessibility-tester 
SYNC missed versions from official npm registry.

@intouchgroup/image-accessibility-tester

Image Accessibility Tester is a tool to automatically scrape images and image accessibility data from websites, and write the findings to an Excel workbook or JSON report.

The tool makes multiple requests simultaneously, can handle HTTP or HTTPS domains, allows passing a prefix for a list of domains, and is capable of scraping sites which require Authentication.

Installation

You must have NodeJS version 12+ installed to use this module.

To check what version of NodeJS you have, launch Terminal on Mac or Powershell on Windows and type node -v.

Once you have NodeJS 12+, globally install the latest version of this module from Terminal or Powershell:

npm i -g @intouchgroup/image-accessibility-tester

You can now run the Image Accessibility Tester from any folder on your computer using Terminal or Powershell.

Usage

When you open Terminal or Powershell, you will see a file path listed in the prompt. This is the current location of your Terminal or Powershell.

You can change locations using the cd FILE_PATH command. cd stands for "change directory" (go to a different folder), and is how you navigate using Terminal or Powershell.

  1. Using Terminal or Powershell, navigate to the folder where you want to save the Image Accessibility Tester reports. For example: cd Desktop/Reports

  2. Now run the Image Accessibility Tester tool from Terminal or Powershell with whatever arguments you want. For example: image-accessibility-tester -s intouchsol.com

Arguments

Arguments are how we tell image-accessibility-tester what to do. Some arguments are required, while others are completely optional. Arguments can be passed in any order, but the value must come right after the argument text. For example:

image-accessibility-tester --argument "This is the value of the argument"

A full list of available arguments with examples is presented below.

Short name Long name What it does
-h --help Shows all available arguments
-s --sites Comma-separated list of URLs to scrape
-p --prefix Prefix text for all site URLs without a protocol
-r --protocol Protocol text for all site URLs without a protocol
-a --auth Username and password for site URLs that require auth
-n --concurrent Number of requests to make simultaneously (default: 5)
-j -json Generate JSON report
-x --xlsx Generate XLSX report
-f --filename Manually set the name of the generated report

Examples


1. Generate an Excel report for multiple sites:

image-accessibility-tester -s intouchsol.com,google.com -x

Tests ht​tps://intouchsol.com and ht​tps://google.com



2. Generate a JSON report for multiple staging sites:

image-accessibility-tester -s intouchsol.com,google.com -p "staging." -j

Tests ht​tps://staging.intouchsol.com and ht​tps://staging.google.com



3. Generate an Excel report for multiple staging sites with different protocols:

image-accessibility-tester -s intouchsol.com,https://google.com -p "staging." -r "http://" -x

Tests ht​tp://staging.intouchsol.com and ht​tps://google.com



4. Generate an Excel report named "MyBestReportYet":

image-accessibility-tester -s intouchsol.com -x -f "MyBestReportYet"

Tests ht​tps://intouchsol.com



5. Authentication login info must be in the format username:password:

image-accessibility-tester -s private.intouchsol.com -x -a "joe.smith:Password123!"

Tests ht​tps://private.intouchsol.com with authentication



6. Use short or long names for arguments. These commands are exactly equivalent:

image-accessibility-tester -s intouchsol.com -x -r "http://" -f "MyBestReportYet"

image-accessibility-tester --sites intouchsol.com --excel --protocol "http://" --filename "MyBestReportYet"

Current Tags

  • 3.0.1                                ...           latest (3 months ago)

3 Versions

  • 3.0.1                                ...           3 months ago
  • 3.0.0                                ...           4 months ago
  • 2.0.1                                ...           6 months ago
Downloads
Today 0
This Week 3
This Month 3
Last Day 3
Last Week 0
Last Month 1
Dependencies (4)
Dev Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |