Skip to content

Webperf-se/plugin-accessibility-statement

Repository files navigation

plugin-accessibility-statement

Accessibility statement plugin for sitespeed.io

Overview

The plugin-accessibility-statement is a plugin for sitespeed.io that helps identify and log accessibility statement errors during web testing. It integrates with sitespeed.io to provide detailed information about accessibility statement errors.

Features

Installation

To install the plugin, run the following command:

npm install plugin-accessibility-statement

Usage

To use the plugin with sitespeed.io, add it to your sitespeed.io configuration file or command line options.

Configuration

Add the plugin to your sitespeed.io configuration file:

{
  "plugins": {
    "plugin-accessibility-statement": {
      "enabled": true
    }
  }
}

Command Line

You can also enable the plugin via the command line:

sitespeed.io --plugins.add plugin-accessibility-statement

Example

Here is an example of how to use the plugin with sitespeed.io:

sitespeed.io https://www.example.com --plugins.add plugin-accessibility-statement

Development

Running Tests

To run the tests, use the following command:

npm test

Linting

To lint the code, use the following command:

npm run lint

To automatically fix linting issues, use the following command:

npm run lint:fix

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

Author

Acknowledgements