Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/acot-a11y/acot
:gem: Accessibility Testing Framework. More accessible web, all over the world.
https://github.com/acot-a11y/acot
a11y accessibility acot audit puppeteer testing-framework testing-tools
Last synced: about 1 month ago
JSON representation
:gem: Accessibility Testing Framework. More accessible web, all over the world.
- Host: GitHub
- URL: https://github.com/acot-a11y/acot
- Owner: acot-a11y
- License: mit
- Created: 2020-10-30T15:45:54.000Z (about 4 years ago)
- Default Branch: canary
- Last Pushed: 2024-09-19T19:28:28.000Z (about 2 months ago)
- Last Synced: 2024-10-08T11:41:24.941Z (about 1 month ago)
- Topics: a11y, accessibility, acot, audit, puppeteer, testing-framework, testing-tools
- Language: TypeScript
- Homepage:
- Size: 5.95 MB
- Stars: 188
- Watchers: 6
- Forks: 8
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-list - acot - a11y | 143 | (TypeScript)
README
Accessibility Testing Framework
---
!! THE ACOT IS STILL IN ALPHA STATUS AND MAY BE BROKEN BY THE UPGRADE !!
---
## Overview
> More accessible web, all over the world.
acot is an open-source Accessibility Testing Framework that uses headless Chrome ([puppeteer](https://github.com/puppeteer/puppeteer)) to provide means of testing any website or web app. It supports for making the Web accessible with a flexible, highly reliable rule set that leverages browser-native APIs such as the AOM and DOM.
### Reliability
- By using the results rendered by the browser, a highly reliable audit is possible.
- acot provides original rules. In addition, it offers rules based on the proven [axe](https://github.com/dequelabs/axe-core).
### Extensibility
- You can use the rules published in the [ESLint](https://eslint.org/) like plugin system.
- It's easy to implement and publish the rule sets you need for your team.
- The divided packages allow you to assemble a custom workflow that works best for your team.
### Portability
- You can create and publish your own configuration with Sharable Config.
- Provides Custom Runner for integration with Storybook.
## Getting Started
Install via npm:
```bash
$ npm install --save-dev @acot/cli
# or
$ npm install --save-dev @acot/cli puppeteer
```
You can build the configuration file and install the dependent packages with the following commands:
```bash
$ npx acot init
```
And then, the `run` subcommand performs an audit based on the configuration file.
```bash
$ npx acot run
```
See the [CLI documentation](./packages/cli) for details.
## Configuration
If you use acot as the CLI, you can configure the audit via configuration file.
Usually, when you create a configuration file called `acot.config.js`, acot will automatically use that configuration file.
**The simple configuration is as follows (`acot.config.js`):**
```javascript
module.exports = {
presets: ['@acot/wcag'],
extends: ['preset:@acot/wcag/recommended'],
origin: 'http://localhost:8000',
connection: {
command: 'npm run serve',
},
paths: ['/', '/path', '/path/to', '/path/to/dir'],
rules: {
'@acot/wcag/interactive-has-enough-size': 'warn',
'@acot/wcag/page-has-valid-lang': 'off',
'@example/foo/bar': [
'error',
{
/* options */
},
],
},
};
```
See the [Configuration](./docs/configuration.md) for details.
## Requirements
- Node.js 12.10.0+ (require [Promise.allSettled](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/allSettled))
- Puppeteer 5.4.0+ (require [aria handler](https://github.com/puppeteer/puppeteer/releases/tag/v5.4.0))
## Documentation
- [Configuration](./docs/configuration.md)
- [Command Line Interface](./packages/cli)
- [Core API](./packages/core)
- [Develoepr Guide](./docs/developer-guide/)
## Packages
acot has a feature which is divided into several packages.
### Foundations
| Package | Description |
| :--------------------------------- | :-------------------------------------- |
| [@acot/core](./packages/core/) | acot core API. |
| [@acot/cli](./packages/cli/) | acot command line tool. |
| [@acot/config](./packages/config/) | A module to manipulate configs of acot. |
### Configs / Presets
| Package | Description |
| :----------------------------------------------------- | :------------------------------ |
| [@acot/acot-config](./packages/acot-config/) | A basic acot rule set. |
| [@acot/acot-preset-wcag](./packages/acot-preset-wcag/) | A WCAG-based rule set for acot. |
| [@acot/acot-preset-axe](./packages/acot-preset-axe/) | An axe rule set for acot. |
### Runners
| Package | Description |
| :--------------------------------------------------------------- | :------------------------------------------------------------------------------- |
| [@acot/acot-runner-sitemap](./packages/acot-runner-sitemap/) | An acot custom runner reading audit pages from sitemap. |
| [@acot/acot-runner-storybook](./packages/acot-runner-storybook/) | An acot custom runner for [Storybook](https://github.com/storybookjs/storybook). |
### Reporters
| Package | Description |
| :------------------------------------------------------------- | :------------------------------------------------ |
| [@acot/acot-reporter-pretty](./packages/acot-reporter-pretty/) | An acot default reporter. |
| [@acot/acot-reporter-dot](./packages/acot-reporter-dot/) | A dot reporter for [@acot/cli](./packages/cli/). |
| [@acot/acot-reporter-github](./packages/acot-reporter-github/) | GitHub reporter for [@acot/cli](./packages/cli/). |
### Utilities
| Package | Description |
| :----------------------------------------------------- | :----------------------------------------------------------------------------------- |
| [@acot/find-chrome](./packages/find-chrome/) | Find Chrome available in your runtime environment. |
| [@acot/html-pickup](./packages/html-pickup/) | Use the CSS Selector to pick up the elements from the HTML string. |
| [@acot/schema-validator](./packages/schema-validator/) | A simple wrapper module for [schema-utils](https://github.com/webpack/schema-utils). |
## FAQ
_T.B.A_
## Contributing
We are always welcoming your contribution :clap:
See [CONTRIBUTING.md](./CONTRIBUTING.md).
## License
[MIT © wadackel](./LICENSE)