https://github.com/amwmedia/eslint-plugin-woke

https://github.com/amwmedia/eslint-plugin-woke

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/amwmedia/eslint-plugin-woke
• Owner: amwmedia
• License: mit
• Created: 2019-02-14T15:47:24.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-10-16T19:49:31.000Z (3 months ago)
• Last Synced: 2024-12-24T05:07:17.792Z (13 days ago)
• Language: JavaScript
• Size: 32.2 KB
• Stars: 34
• Watchers: 3
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-eslint - Woke - Helps catch insensitive words, promoting an inclusive codebase. (Plugins / Misc)

README

        
# eslint-plugin-woke

ESLint plugin to promote diversity and inclusion in codebases.

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ npm i eslint --save-dev

```

Next, install `eslint-plugin-woke`:

```

$ npm install eslint-plugin-woke --save-dev

```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-woke` globally.

## Usage

Add `woke` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json

{

    "plugins": [

        "woke"

    ]

}

```

Then configure the rules you want to use under the rules section.

```json

{

    "rules": {

        "woke/all": 2

    }

}

```

## Supported Rules

* all

* racism

* profanity

* gender

* LGBTQ

## Contributions Welcome

While this plugin attemts to call attention to as many offensive terms as possible, the work of inclusivity is never complete. Please help to expand the categories and offensive words list so that we can all benefit from our collective lived experiences.