# Pa11y CLI Reporter

## This repository is now deprecated.

The reporter has been merged into [pa11y/reporters](https://github.com/pa11y/pa11y/tree/master/lib/reporters).

The default command-line reporter for [Pa11y 5.0](https://github.com/pa11y/pa11y).

**:warning: this reporter is built into Pa11y, there's no need to install separately :warning:**

[![NPM version][shield-npm]][info-npm]
[![Build status][shield-build]][info-build]
[![LGPL-3.0 licensed][shield-license]][info-license]

## Table of contents

* [Table of contents](#table-of-contents)
* [Requirements](#requirements)
  * [Compatibility chart](#compatibility-chart)
* [Usage](#usage)
  * [Command-Line](#command-line)
  * [JavaScript](#javascript)
* [Contributing](#contributing)
* [License](#license)

## Requirements

Pa11y CLI Reporter is compatible with Pa11y 5 and later versions. It will not work with older versions of Pa11y.

### Compatibility chart

| Pa11y version | Pa11y CLI reporter version |
|---------------|----------------------------|
| 1.x - 4.x     | Unsupported                |
| 5.x           | 1.x                        |
| 6.x           | 2.x                        |

## Usage

### Command-Line

Install Pa11y and Pa11y CLI Reporter with [npm](https://www.npmjs.com/) (locally or globally is fine):

```sh
npm install -g pa11y pa11y-reporter-cli
```

Run Pa11y using the CLI reporter:

```sh
pa11y --reporter cli http://example.com
```

### JavaScript

Assuming you've installed both Pa11y and Pa11y CLI Reporter:

```js
const cli = require('pa11y-reporter-cli');
const pa11y = require('pa11y');

pa11y('http://example.com').then(results => {
    // Returns a string with the results formatted to be human-readable
    const cliResults = cli.results(results);
    console.log(cliResults);
});
```

## Contributing

There are many ways to contribute to Pa11y CLI Reporter, we cover these in the [contributing guide](CONTRIBUTING.md) 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:

```sh
make ci
```

You can also run verifications and tests individually:

```sh
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

Pa11y CLI Reporter is licensed under the [Lesser General Public License (LGPL-3.0)][info-license].  
Copyright © 2017, Team Pa11y

[info-license]: LICENSE
[info-npm]: https://www.npmjs.com/package/pa11y
[info-build]: https://github.com/pa11y/pa11y-reporter-cli/actions/workflows/tests.yml
[shield-license]: https://img.shields.io/badge/license-LGPL%203.0-blue.svg
[shield-npm]: https://img.shields.io/npm/v/pa11y-reporter-cli.svg
[shield-build]: https://github.com/pa11y/pa11y-reporter-cli/actions/workflows/tests.yml/badge.svg