npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@modus/gimbal-plugin-axe

v1.2.6

Published

Plugin to add axe audits to Gimbal

Downloads

64

Readme

Gimbal axe Plugin

npm (scoped) npm CircleCI PRs Welcome MIT Licensed Powered by Modus_Create

The axe plugin adds axe auditing to Gimbal. This plugin will check for violations reported by axe and check the impact of the violations against the configured thresholds.

Installation

First, you need to install the plugin to your project:

# with npm
npm install --save-dev @modus/gimbal-plugin-axe

# or with yarn
yarn add --dev @modus/gimbal-plugin-axe

Next, you need to add the plugin to your Gimbal configuration file:

YAML

plugins:
  - '@modus/gimbal-plugin-axe'

JSON

{
  "plugins": ["@modus/gimbal-plugin-axe"]
}

JavaScript

modules.exports = {
  plugins: ['@modus/gimbal-plugin-axe'],
};

Configuration

There are three configs that you can change:

  • disabledRules - An optional string or array of strings that will disable certain rules. For more, see here.
  • exclude - An optional string or array of strings that will allow certain CSS selectors to be excluded from the axe analysis. For more, see here.
  • include - An optional string or array of strings that will only allow certain CSS selectors to be included in the axe analysis. For more, see here.
  • rules - An optional string or array of strings that will only allow certain axe rules to be run in the axe analysis. For more, see here.
  • showSuccesses - If set to false, the output of the final report will now show the successful rules.
  • tags - An optional string or array of strings that will allow only the specified rule IDs in the axe analysis. For more, see here.
  • threshold - This is the object of thresholds. Each rule can have it's own threshold.

Threshold

By default, there is a single threshold that is set to minor meaning only minor violations will be allowed. Each rule can have it's own threshold defined:

plugins:
  - plugin: '@modus/gimbal-plugin-axe'
    thresholds:
      bypass: serious

The acceptable levels in order from least to greater impact are: none, minor, moderate, serious, critical.

Default Configuration

plugins:
  - plugin: '@modus/gimbal-plugin-axe'
    showSuccesses: true
    thresholds:
      impact: none