Giter VIP home page Giter VIP logo

blt-pa11y's Introduction

Acquia BLT pa11y

This is an Acquia BLT plugin providing integration with the Pa11y test framework.

This plugin provides a set of commands in the tests namespace that use these frameworks to run automated tests on your Drupal site.

This plugin is community-supported.

Installation and usage

To use this plugin, you must already have a Drupal project using BLT 13 or higher.

Add the following to the repositories section of your project's composer.json:

"blt-pa11y": {
    "type": "vcs",
    "url": "https://github.com/nikunjkotecha/blt-pa11y.git",
    "no-api": true
}

or run:

composer config repositories.blt-pa11y '{"type": "vcs", "url": "https://github.com/nikunjkotecha/blt-pa11y.git", "no-api": true}'

In your project, require the plugin with Composer:

composer require --dev nikunjkotecha/blt-pa11y

Initialize Config

Run the recipe to initialize the necessary pa11y files / directories.

blt recipes:pa11y:init
blt tests:pa11y:init

Configuration

Update the configuration to specify all the urls to test. Make sure the site setup takes care of creating all required content.

Configurations file tests/pa11y/pa11y.yml in your repo.

To understand different possible values for configuration, please visit https://github.com/pa11y/pa11y

To disable Pa11y validation, please add following to your blt.yml

pa11y:
  validate: false

Example implementation can be found in the repo github-actions-behat

Run Tests

Run the tests:

 blt tests:pa11y

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

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.