KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #ai-agents #dsh-plugin #codex #developer-tools #claude-code #windows #cli #desktop-app #typescript #rust #ai-agent

node-wcag

★ 33 Open GitHub ↗

WCAG and Section 508 accessibility audits from the command line.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# node-wcag [![Build Status](https://secure.travis-ci.org/cfpb/node-wcag.png?branch=master)](http://travis-ci.org/cfpb/node-wcag) [![Coverage Status](https://coveralls.io/repos/cfpb/node-wcag/badge.svg)](https://coveralls.io/r/cfpb/node-wcag)

WCAG and Section 508 accessibility audits from the command line or as a traditional node module.

![WCAG Screenshot](https://raw.githubusercontent.com/cfpb/node-wcag/master/screenshot.png)

## CLI installation

```sh
$ npm install wcag --global
```

## CLI usage

First, get a free [AChecker API ID](http://achecker.ca/register.php). Then:

```sh
$ wcag wikipedia.org --id=<achecker id>
```

Also works against localhost:

```sh
$ wcag localhost:8000 --id=<achecker id>
```

### Options

#### id

Type: `string`

Your free [AChecker API ID](http://achecker.ca).

```sh
$ wcag wikipedia.org --id=845cc0a8435cb0a766396a8c56399a43df0c843
```

If an `id` is not passed on the command line,
the tool will check for an `ACHECKER_ID` environment variable.

#### guide

Type: `string`  
Choices: `508`, `WCAG1-A`, `WCAG1-AA`, `WCAG1-AAA`, `WCAG2-A`, `WCAG2-AA`, `WCAG2-AAA`, `BITV1`, `STANCA`
Default: `WCAG2-AA`

The accessbility guideline to validate against.

```sh
$ wcag wikipedia.org --id=<achecker id> --guide=508
$ wcag wikipedia.org --id=<achecker id> --guide=BITV1
```

## Module installation

```sh
$ npm install wcag
```

## Module usage

```javascript

var wcag = require('wcag');
var options = {
  id: '69f6ea6a9e30b37c3d341d3b716df218f8942c0e',
  uri: 'http://contolini.github.io/node-wcag/test/fixtures/whitehouse.html',
  guide: 'WCAG2-AA'
};

wcag(options, function (error, data) {
  if (error) {
    console.error(error);
  } else {
    console.log(data);
  }
});
```

The example will return [this output](data/output.json)

### Options

#### id

Type: `string`  
Required: true
Your free [AChecker API ID](http://achecker.ca).

#### uri

Type: `string`
Required: true
URL for the page you want to validate

#### guide

Type: `string`
Required: false
Choices: `508`, `WCAG1-A`, `WCAG1-AA`, `WCAG1-AAA`, `WCAG2-A`, `WCAG2-AA`, `WCAG2-AAA`, `BITV1`, `STANCA`
Default: `WCAG2-AA`

The accessbility guideline to validate against.

## Contributing

Please read the [Contributing guidelines](CONTRIBUTING.md).

### Running node-wcag locally

To contribute code, fork this repo, clone it down to your machine and use npm link:

```sh
$ npm uninstall -g wcag
$ cd node-wcag
$ npm link
$ wcag whatever.com
```

### Running tests

We are using [nodeunit](https://github.com/caolan/nodeunit) to test.
To run tests, first install nodeunit and any dependencies via npm:

```sh
npm install
```

Run tests with:

```sh
npm test
```

## License

The project is in the public domain within the United States, and
copyright and related rights in the work worldwide are waived through
the [CC0 1.0 Universal public domain dedication](http://creativecommons.org/publicdomain/zero/1.0/).

All contributions to this project will be released under the CC0
dedication. By submitting a pull request, you are agreeing to comply
with this waiver of copyright interest.

Software source code previously released under an open source license and then modified by CFPB staff is considered a "joint work" (see 17 USC § 101); it is partially copyrighted, partially public domain, and as a whole is protected by the copyrights of the non-government authors and must be released according to the terms of the original open-source license.

For further details, please see: http://www.consumerfinance.gov/developers/sourcecodepolicy/

node-wcag

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README