# badwords-list

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

Latest version **2.0.1-4** (published 2024-08-18) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1-4 |
| Published | 2024-08-18 |
| First published | 2014-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 40 |
| Author | Michael Price |
| Maintainers | webmech |
| Keywords | bad, word, words, profanity, filter, blacklist, black, list, swear |

## Links

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

## Recent versions

- 2.0.1-4 (latest) — 2024-08-18
- 2.0.1-3 — 2024-08-11
- 2.0.1-2 — 2024-08-11
- 2.0.1-0 — 2024-08-10
- 1.0.0 — 2014-07-31

## README

badwords-list v1.0.0
========

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 accessable by [Jamie Wilkinson](https://gist.github.com/jamiew) [here](https://gist.github.com/jamiew/1112488)

Inspired by [badwords](https://github.com/MauriceButler/badwords)

This data has been exposed as an object that contains

 - an array
 - an object
 - a regular expression

depending on what is required for your purposes.


Install
=======

    npm install badwords-list

Usage
=====

```
var list = require('badwords-list'),
	array = list.array,
	object = list.object,
	regex = list.regex;
```

Testing
=======

#### Requires
- Mocha
- better-assert


```
npm test
```

**or**

```
REPORTER=spec make
```

**or**

```
mocha
```

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