# rudeboy

> A simple, syncronous profanity filter for bad language validation.

Latest version **0.5.3** (published 2017-05-26) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.3 |
| Published | 2017-05-26 |
| First published | 2017-05-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Pat Ho |
| Maintainers | pjho |

## Links

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

## Dependencies (1)

- [diacritics](https://npm.io/package/diacritics.md) ^1.3.0

## Recent versions

- 0.5.3 (latest) — 2017-05-26
- 0.1.2 (beta) — 2017-05-09
- 0.5.2 — 2017-05-19
- 0.5.1 — 2017-05-16
- 0.5.0 — 2017-05-16
- 0.4.1 — 2017-05-14
- 0.4.0 — 2017-05-13
- 0.3.0 — 2017-05-13
- 0.2.6 — 2017-05-12
- 0.2.5 — 2017-05-10
- 0.2.4 — 2017-05-10
- 0.2.3 — 2017-05-09
- 0.2.0 — 2017-05-09
- 0.1.1 — 2017-05-09
- 0.1.0 — 2017-05-09

## README

Simple, syncronous bad language identifier for profanity invalidation.

`> npm install rudeboy`

``` javascript

var rude = require('rudeboy');
rude('f**k') // true


// If you want to know what was matched you can have that info returned.
var returnObject = true
rude('f**k', returnObject) // {rude: true, words: { input: ['f**k'], list: ['f**k']}

```
See test.js for more examples


TODO:
- Add non english match words
- improve tests for each specific use cases and matches
- allow consumer to add their own word lists

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