# badwords

> A highly consumable list of bad (profanity) english words

Latest version **1.0.0** (published 2016-03-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install badwords
pnpm add badwords
yarn add badwords
bun add badwords
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-03-15 |
| First published | 2013-01-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/badwords) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Maurice Butler |
| Maintainers | mauricebutler |
| Keywords | bad, word, words, profanity, filter, blacklist, black, list, swear |

## Links

- npm: https://www.npmjs.com/package/badwords
- Repository: https://github.com/MauriceButler/badwords
- Homepage: https://github.com/MauriceButler/badwords#readme
- Issues: https://github.com/MauriceButler/badwords/issues
- npm.io page: https://npm.io/package/badwords

## Recent versions

- 1.0.0 (latest) — 2016-03-15
- 0.0.3 — 2013-10-11
- 0.0.2 — 2013-10-11
- 0.0.1 — 2013-01-03

## README

# badwords

A highly consumable list of bad (profanity) English words based on the nice short and simple list found in [Google's "what do you love" project](http://www.wdyl.com/) made accessible by [Jamie Wilkinson](https://gist.github.com/jamiew) [here](https://gist.github.com/jamiew/1112488)


This data has been exposed as
- an array
- an object
- a regular expression

depending on what is required for your purposes.


# Install

    npm install badwords

# Usage

``` javascript
var badwordsArray = require('badwords/array');

var badwordsObject = require('badwords/object');

var badwordsRegExp = require('badwords/regexp');
```

#### Note

"Bad words" implementations are frequently prone to the [Scunthorpe problem](https://en.wikipedia.org/wiki/Scunthorpe_problem)

These kind of lists can be used for flagging things, but being used as a basis for outright blocking can cause issues.

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