# gulp-accessibility-ext

> Grade your sites accessibility and generate a report from different WCAG levels

Latest version **4.0.0** (published 2018-02-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install gulp-accessibility-ext
pnpm add gulp-accessibility-ext
yarn add gulp-accessibility-ext
bun add gulp-accessibility-ext
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2018-02-20 |
| First published | 2018-02-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 4 |
| Unpacked size | 319.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Steven John Miller |
| Maintainers | prantlf |
| Keywords | gulpplugin, accessibility, a11y, analysis, report, WCAG |

## Links

- npm: https://www.npmjs.com/package/gulp-accessibility-ext
- Repository: https://github.com/prantlf/gulp-accessibility
- Issues: https://github.com/prantlf/gulp-accessibility/issues
- npm.io page: https://npm.io/package/gulp-accessibility-ext

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) ^4.3.0
- [through2](https://npm.io/package/through2.md) ^0.6.5
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7
- [access-sniff-ext](https://npm.io/package/access-sniff-ext.md) ^4.0.0

## Recent versions

- 4.0.0 (latest) — 2018-02-20

## README

# Gulp Accessibility Extended
[![Build Status](https://travis-ci.org/prantlf/gulp-accessibility.svg?branch=master)](https://travis-ci.org/prantlf/gulp-accessibility)
[![Build status](https://ci.appveyor.com/api/projects/status/3fa7pmnavulmugj9?svg=true)](https://ci.appveyor.com/project/prantlf/gulp-accessibility)

Uses [AccessSniff](https://github.com/prantlf/AccessSniff) and [HTML Codesniffer](http://github.com/squizlabs/HTML_CodeSniffer) to grade your sites accessibility using different levels of the WCAG guidelines

This fork writes the report, even if errors are detected in input files.

![Gulp Accessibility example](/img/example.png)

## Getting Started
Install this gulp plugin next to your project's gulpfile with: `npm install gulp-accessibility-ext --save-dev`

Then add this line to your project's `gulpfile.js` gulpfile:

```javascript
var access = require('gulp-accessibility-ext');
```

## Documentation
Place this in your gulp file.

```javascript
gulp.task('test', function() {
  return gulp.src('./example/**/*.html')
    .pipe(access({
      force: true
    }))
    .on('error', console.log)
    .pipe(access.report({reportType: 'txt'}))
    .pipe(rename({
      extname: '.txt'
    }))
    .pipe(gulp.dest('reports/txt'));
});

```

## Report Generation
You can link to the files you wish to lint using the gulp api

You'll need to add the below to convert into other formats
```
.pipe(access.report({reportType: 'txt'}))
```

## Options
View [AccessSniff](https://github.com/prantlf/AccessSniff) options for all available options.  

## License
Copyright (c) 2015 Steven Miller
Licensed under the MIT license.

---
_Source: https://npm.io/package/gulp-accessibility-ext · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._