netlify-plugin-axe v0.0.4
Notes
may need the project to locally install axe-core, the resolution is
a little weird
this may be a duplicate of https://github.com/netlify/build/pull/294
netlify-plugin-fetch-feeds
Run axe-cli and fail build if accessibility failures are found.
NOTICE: This is an experimental feature. Subject to lots of change.
Overview
Run axe-cli and fail build if accessibility failures are found.
Demonstration
See this plugin being used in this simplified demo site:
Usage
Prerequisites
- npm and node
- @Netlify/build (later this will be included in the Netlify CLI)
- A free Netlify account
- Opt-in to Netlify Build Plugin feature support (Not yet publicly available, sorry)
Including this plugin in a project
This plugin can be included via npm. Install it as a dependency for your project like so:
npm install --save netlify-plugin-axeConfiguration
This plugin will fetch the specified feeds and stash their data prior to the execution of the build command you have specified in your Netlify configuration. The desired feeds can be specified in the netlify.toml config file. For simpler configuration syntax, I recommend using yaml rather than toml by instead including a netlify.yml file.
To use plugins, a plugins array should be specified in your netlify.yml. Each plugin can then be specified with its parameters like so:
plugins:
- netlify-plugin-axe:
# type: ./path-to-plugin-file | npm-module-name
type: netlify-plugin-fetch-feeds
config:
site: mycoolsite.netlify.com # your Netlify site url
# https://github.com/dequelabs/axe-cli#running-specific-rules
axeFlags: --tags wcag2aExecution in Netlify
Once installed and configured, the plugin will automatically run in the Netlify CI during its specified Netlify Build lifecycle event.
Executing locally
To test the execution of the Netlify Build lifecycle locally, first ensure that netlify-build is installed:
# Ensure that you have the netlify build command available
# (in future this will be provided via the CLI)
npm install @netlify/build -g
# In the project working directory, run the build as netlify would with the build bot
netlify-build