darwintantuco / eslint-plugin-detect-bad-words

Detect bad/profanity words in code

eslint-plugin-detect-bad-words

Detect bad/profanity words in code

Uses badwords under the hood

Installation

You'll first need to install ESLint:

Next, install eslint-plugin-detect-bad-words:

npm

$ npm install eslint-plugin-detect-bad-words --save-dev

yarn

$ yarn add eslint-plugin-detect-bad-words --dev

Usage

Add detect-bad-words to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["detect-bad-words"]
}

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

{
  "rules": {
    "detect-bad-words/in-code": "error",
    "detect-bad-words/in-comment": "error"
  }
}

Optional

You can define custom bad words under settings section.

{
  "settings": {
    "customBadWords": ["wtf", "fck", "sht"]
  }
}

License

MIT

eslint-plugin-detect-bad-words's Issues

Detect bad words from other languages

maybe use https://github.com/thisandagain/washyourmouthoutwithsoap instead of https://github.com/MauriceButler/badwords

Detect unwanted words in comments

Update bad-words depenency

thank you for providing this ESlint plugin but are there plans to update/release a new version with an updated bad-words dependency? At the moment you can find version 3.0.4 already.

Thank you so much!

Detect bad/profanity words

• should be configurable
• checkout:
  • https://github.com/MauriceButler/badwords
  • https://github.com/thisandagain/washyourmouthoutwithsoap

might be also nice to rename the project, maybe:

• eslint-plugin-detect-profanity-words
• eslint-plugin-detect-offensive-words