# eslint-plugin-no-shit

> Disallow ⚠️ use of offensive 💪 language 💯

Latest version **0.0.2** (published 2017-09-18) · 0 weekly downloads

## Install

```sh
npm install eslint-plugin-no-shit
pnpm add eslint-plugin-no-shit
yarn add eslint-plugin-no-shit
bun add eslint-plugin-no-shit
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2017-09-18 |
| First published | 2017-09-18 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Jakub Sadura |
| Maintainers | jakubsadura |
| Keywords | eslint, eslintplugin, eslint-plugin, offensive, swear, swearing, shit, fuck |

## Links

- npm: https://www.npmjs.com/package/eslint-plugin-no-shit
- Repository: https://github.com/jakubsadura/eslint-plugin-no-shit
- Homepage: https://github.com/jakubsadura/eslint-plugin-no-shit#readme
- Issues: https://github.com/jakubsadura/eslint-plugin-no-shit/issues
- npm.io page: https://npm.io/package/eslint-plugin-no-shit

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2017-09-18
- 0.0.1 — 2017-09-18
- 0.0.0 — 2017-09-18

## README

![1_primary_logo_on_transparent_295x65](https://user-images.githubusercontent.com/802781/30567713-ecf55048-9cd1-11e7-9737-ff13b1c35406.png)

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

<img width="670" alt="screen shot 2017-09-19 at 00 24 42" src="https://user-images.githubusercontent.com/802781/30567719-f2a96060-9cd1-11e7-8b1b-f9a051166ba9.png">

Let's assume you are already using [ESLint](http://eslint.org).

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

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

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

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

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

```json
{
    "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

---
_Source: https://npm.io/package/eslint-plugin-no-shit · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._