Code Monkey home page Code Monkey logo

accessibility-linter's Introduction

accessibility-linter

Build Version Downloads

About this plugin

Assistant for writing inclusive code. Based on dequelabs/axe-core.

Features:

  • real-time code analysis
  • annotations for improvements
  • configuration file support to enable and disable rules
  • currently supported file types: html, htm, hbs, handlebars and vue

Configuration File:

At the root directory of your project you can place a file called axe-linter.yml. With the rules property you can enable or disable rules and with the tags property you can enable only rules with the specific tags. All other rules will be disabled, even when they are enabled through the rules property.

List of all available rules including their tags

Example:

rules:
  html-has-lang: false # disables the rule
tags: # excludes all rules that don't have one of these tags
  - wcag2a
  - wcag21a

Installation

  • Using IDE built-in plugin system:

    Settings/Preferences > Plugins > Marketplace > Search for "accessibility-linter" > Install Plugin

  • Manually:

    Download the latest release and install it manually using Settings/Preferences > Plugins > โš™๏ธ > Install plugin from disk...

Development

Additional Steps

  1. navigate to src/main/javascript
  2. run npm install

To apply JavaScript changes for local debugging, run the build > clean gradle task. Then run the Run Plugin task from the run configurations like normal.

Deployment

Semi-Automatic

  1. set the new version number in gradle.properties
  2. update changelog
  3. commit and push
  4. wait for the GitHub Actions successfully finish running, if they fail: fix the errors and start over (depending on what went wrong)
  5. Locate the draft release on GitHub
  6. Turn into a pre-release (This will upload the plugin to the marketplace and to this pre-release; and create a pull request for the changelog)

once the plugin version was approved by JetBrains...

  1. Merge the generated pull request
  2. Turn the pre-release into a full release

Manual

  1. navigate to src/main/javascript
  2. run npm install --omit=dev
  3. set the new version number in gradle.properties
  4. commit and push
  5. run the build > clean gradle task
  6. run the build > build gradle task
  7. locate the plugin in build/distributions
  8. wait for the GitHub Actions successfully finish running, if they fail: fix the errors and start over (depending on what went wrong)
  9. upload the plugin to the marketplace as an update with Upload Update (login needed)
  10. upload the plugin to the generated GitHub draft from the releases list and publish the release
  11. locally run the changelog > patchChangelog gradle task to update the changelog, afterwards push + commit

Plugin based on the IntelliJ Platform Plugin Template.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.