bad-words-next
Version:
JavaScript/TypeScript filter and checker for bad words aka profanity
140 lines (107 loc) • 4.2 kB
Markdown
# bad-words-next
JavaScript/TypeScript filter and checker for bad words aka profanity.
API documentation in [GitHub Wiki](https://github.com/voidresort/bad-words-next/wiki/BadWordsNext).
*NOTE: we don't supply with raw json data files in version >= 3.0.0. See the example below to update paths in your import or require statements.*
## Install
```sh
yarn add bad-words-next
```
or
```sh
npm install bad-words-next
```
## Basic usage
```js
const BadWordsNext = require('bad-words-next')
const en = require('bad-words-next/lib/en')
const badwords = new BadWordsNext({ data: en })
// Returns true when passed string contains a bad word
console.log(badwords.check('S0me sh!++ is here'))
// will print `true`
// Returns filtered string with masked bad words
console.log(badwords.filter('S0me sh!++ is here'))
// will print `S0me *** is here`
// Returns filtered string and catches bad words
badwords.filter('S0me sh!++ is here', badword => {
console.log(badword)
})
// will print `sh!++`
// Use exclusions
const badwords = new BadWordsNext({ data: en, exclusions: ['sh+it+' /*works with lookalikes or the actual words*/] })
console.log(badwords.filter('S0me sh!++ is here'))
// will keep the `sh!++` word
```
## Add more dictionaries
```js
const BadWordsNext = require('bad-words-next')
const en = require('bad-words-next/lib/en')
const es = require('bad-words-next/lib/es')
const fr = require('bad-words-next/lib/fr')
const de = require('bad-words-next/lib/de')
const ru = require('bad-words-next/lib/ru')
const rl = require('bad-words-next/lib/ru_lat')
const ua = require('bad-words-next/lib/ua')
const pl = require('bad-words-next/lib/pl')
const ch = require('bad-words-next/lib/ch')
const badwords = new BadWordsNext()
badwords.add(en)
badwords.add(es)
badwords.add(fr)
badwords.add(de)
badwords.add(ru)
badwords.add(rl)
badwords.add(ua)
badwords.add(pl)
badwords.add(ch)
```
## Dictionary data format
```ts
interface Data {
id: string // Unique dictionary ID
words: string[] // Words list
lookalike: Lookalike // Lookalike homoglyphs map
}
type Lookalike = Record<string | number, string> // Simple key-value object
```
You can use the following pattern characters in a word string:
- `*` indicates any characters, use it only on start and/or end of a word
- `+` indicates one or more repeating characters
- `_` indicates special characters
Here is an example of a typical data object:
```js
{
"id": "en",
"words": [
"any", // just a word
"ba+d*", // word `bad` with repeating `a` and anything after `d`
"*words*", // word `words` with anything at start and end of it
"are_here" // word `are_here` with pseudo space chars between `r` and `h`
],
"lookalike": {
"@": "a",
"1": "i"
}
}
```
## Options
```ts
interface Options {
data?: Data // Dictionary data
placeholder?: string // Filter placeholder - default '***'
placeholderMode?: 'repeat' | 'replace' // Placeholder mode to either replace with or repeat the placeholder - default 'replace'
specialChars?: RegExp // Special chars to allow on start and/or end of a word - default /\d|[!@#$%^&*()[\];:'",.?\-_=+~`|]|a|(?:the)|(?:el)|(?:la)/
spaceChars?: string[] // Pseudo space chars, a list of values for `_` symbol in a dictionary word string - default ['', '.', '-', ';', '|']
confusables?: string[] // List of ids to apply transformations from `confusables` npm package - default ['en', 'es', 'de', 'ru_lat']
maxCacheSize?: number // Max items to store in cache - default 100
exclusions?: string[] // The list of exclusions
}
```
See [Options API](https://github.com/voidresort/bad-words-next/wiki/Options) for more details.
## Notes
- Dictionary words with spaces won't work b/c they do not represent a single word
- Dictionaries have to be improved over time