eslint-plugin-no-shit

The plugin will warn you if it finds words like fuck and shit in your codebase (variable declarations, function declarations and even comments ). If you believe that clean code === code without swearing (even in comments!) you should give this plugin a try.

Usage

Let's assume you are already using ESLint.

1. Install eslint-plugin-no-shit into your dev dependencies:

$ npm install eslint-plugin-no-shit --save-dev

1. Add no-shit to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "no-shit"
    ]
}

1. Add 'be-polite' rule to the rules section. If you intend to use the plugin at work pass nsfw: true option in following way:

{
    "rules": {
        "no-shit/be-polite": ["warn", {"nsfw": true}]
    }
}

How

I created this plugin after watching great Frontend Masters "Abstract Syntax Trees" course by @kentcdodds - you can check it out at https://github.com/kentcdodds/asts-workshop/

LICENSE

MIT