Pa11y HTML CodeSniffer Runner

⚠️ This package is now bundled with pa11y. You can find the latest version in the pa11y repo. ⚠️

A HTML_CodeSniffer runner for Pa11y.

Table of contents

• Table of contents
• Requirements
  • Compatibility chart
• Usage
• Contributing
• License

Requirements

The Pa11y HTML_CodeSniffer runner is compatible with Pa11y 5 and later versions. It will not work with older versions of Pa11y.

Compatibility chart

Usage

Install Pa11y and the Pa11y HTML_CodeSniffer runner with npm (locally or globally is fine):

npm install -g pa11y pa11y-runner-htmlcs

Run Pa11y using the HTML CodeSniffer runner:

pa11y --runner htmlcs http://example.com

Contributing

There are many ways to contribute to the Pa11y HTML_CodeSniffer runner, we cover these in the contributing guide for this repo.

If you're ready to contribute some code, clone this repo locally and commit your code on a new branch.

Please write unit tests for your code, and check that everything works by running the following before opening a Pull Request:

make ci

You can also run verifications and tests individually:

make verify              # Verify all of the code (ESLint)
make test                # Run all tests
make test-unit           # Run the unit tests
make test-unit-coverage  # Run the unit tests with coverage

License

The Pa11y HTML_CodeSniffer runner is licensed under the Lesser General Public License (LGPL-3.0).
Copyright © 2018, Team Pa11y

Changelog

2.0.1 (2022-03-31)

• Deprecate package

2.0.0 (2020-04-27)

• Drop support for Node.js versions older than 10.
• Whitelist the files to be published on npm. This reduces the size of the package.
• Update HTML_CodeSniffer from v2.4.0 to v2.5.1.
• Update devDependencies.
• Update test matrix to include Node 10, 12 and 14.

1.2.1 (2021-04-01)

• Lock HTML_Codesniffer to v2.4 in order to avoid pulling WCAG 2.1 rules inadvertently

1.2.0 (2019-09-30)

• Adds support for sites using AMD

1.1.0 (2019-07-22)

• Use NPM version of HTML CodeSniffer 2.4

1.0.1 (2018-10-23)

• Remove out-of-date note from README

1.0.0 (2018-10-23)

• Update to HTML CodeSniffer v2.2.0

0.2.0 (2018-05-24)

• Updates to match new Pa11y behaviour, returning element rather than selector and context

0.1.0 (2018-05-21)

• Initial release