https://github.com/musienkoyuriy/enabler

✋ Accessibility analyzer for your frontend.
https://github.com/musienkoyuriy/enabler

a11y accessibility angular aria ngx-a11y screen-reader vue-a11y vuejs wcag

Last synced: 5 days ago
JSON representation

✋ Accessibility analyzer for your frontend.

• Host: GitHub
• URL: https://github.com/musienkoyuriy/enabler
• Owner: musienkoyuriy
• License: mit
• Created: 2018-01-30T18:37:47.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-03-13T17:13:13.000Z (over 3 years ago)
• Last Synced: 2024-09-20T09:39:53.577Z (about 2 months ago)
• Topics: a11y, accessibility, angular, aria, ngx-a11y, screen-reader, vue-a11y, vuejs, wcag
• Language: TypeScript
• Homepage:
• Size: 1.42 MB
• Stars: 18
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Enabler Logo](https://i.imgur.com/9iNnawV.jpg)

 ✋ *Accessibility analyzer for your frontend.*

[](https://badge.fury.io/js/enabler)

[]("https://npmjs.org/enabler)

[![Dependency Status](https://david-dm.org/palantir/tslint.svg)](https://david-dm.org/musienkoyuriy/enabler)

[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg)](https://opensource.org/licenses/mit-license.php)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

> It's just a node.js util which analyzes your templates all over the project and warns you about potential accessibility problems.

`Enabler`’s aim is to give developer ability to increase accessibility in development stage, but not after publishing site/application to production.

Frameworks support: Angular, Vue.

## Up & Running:

```

> npm i --save-dev enabler

```

*or*

```

> yarn add enabler --dev

```

package.json

```

...

scripts: {

  "a11y": 'enabler --path ./templates-root-folder'

}

...

```

```

> npm run a11y

```

*or*

```

> yarn run a11y

```

## Options:

```

    -v, --version    output the version number

    -p, --path    Path for your root components folder

    --ng, --angular  Detect angular abstractions

    --vue            Support .vue files

    -h, --help       output usage information

 ```

 ## Built with:

- [cheerio](https://github.com/cheeriojs/cheerio) - Fast, flexible, and lean implementation of core jQuery designed specifically for the server.

- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right

## Questions?

If you have any questions/suggestions/ideas to enhancements - feel free to create a [Github issue](https://github.com/musienkoyuriy/enabler/issues/new). Let's affect accessibility together

## LICENSE

**The software is license under "MIT"**

> Copyright (c) 2018 - 2019 Musienko Yuriy

>

> Permission is hereby granted, free of charge, to any person obtaining a copy

> of this software and associated documentation files (the "Software"), to deal

> in the Software without restriction, including without limitation the rights

> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

> copies of the Software, and to permit persons to whom the Software is

> furnished to do so, subject to the following conditions:

>

> The above copyright notice and this permission notice shall be included in

> all copies or substantial portions of the Software.

>

> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

> THE SOFTWARE.