bad-words-plus/README.md

A javascript filter for bad words with display options

# bad-words-plus

bad-words-plus adds the ability to display the first and/or last letter of of the profane word to the original badwords profanity filtration project. For instance, if "nerd" is added to the blocklist, then "n\*\*\*" or "n\*\*d" can be optionally displayed instead of the default "\*\*\*\*". If you don't need that functionality, you may want to chose the original badwords.

[![Build Status](https://travis-ci.org/ryan-berdel/bad-words-plus.svg?branch=master)](https://travis-ci.org/ryan-berdel/bad-words-plus)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

## Requirements

Requires Node 12, an environment that understands ES2016 or a transpiler like Babel.

## Installation

    npm install bad-words-plus --save

## Usage

```js
var Filter = require('bad-words-plus'),
    filter = new Filter();

console.log(filter.clean("Don't be an ash0le")); //Don't be an ******
```

```js
var Filter = require('bad-words-plus'),
    filter = new Filter({firstLetter: true});

console.log(filter.clean("Don't be an ash0le")); //Don't be an a*****
```

```js
var Filter = require('bad-words-plus'),
    filter = new Filter({firstLetter: true, lastLetter: true});

console.log(filter.clean("Don't be an ash0le")); //Don't be an a****e
```

### Placeholder Overrides

```js
var Filter = require('bad-words-plus');
var customFilter = new Filter({ placeHolder: 'x'});

customFilter.clean("Don't be an ash0le"); //Don't be an xxxxxx
```

### Regex Overrides

```js
var filter = new Filter({ regex: /\*|\.|$/gi });

var filter = new Filter({ replaceRegex:  /[A-Za-z0-9가-힣_]/g }); 
//multilingual support for word filtering
```

### Add words to the blocklist

```js
var filter = new Filter(); 

filter.addWords('some', 'bad', 'word');

filter.clean("some bad word!") //**** *** ****!

//or use an array using the spread operator

var newBadWords = ['some', 'bad', 'word'];

filter.addWords(...newBadWords);

filter.clean("some bad word!") //**** *** ****!

//or

var filter = new Filter({ list: ['some', 'bad', 'word'] }); 

filter.clean("some bad word!") //**** *** ****!
```

### Instantiate with an empty list

```js
var filter = new Filter({ emptyList: true }); 
filter.clean('hell this wont clean anything'); //hell this wont clean anything
```

### Remove words from the blocklist

```js
let filter = new Filter(); 

filter.removeWords('hells', 'sadist');

filter.clean("some hells word!"); //some hells word!

//or use an array using the spread operator

let removeWords = ['hells', 'sadist'];

filter.removeWords(...removeWords);

filter.clean("some sadist hells word!"); //some sadist hells word!
```

### API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

##### Table of Contents

-   [constructor](#constructor)
    -   [Parameters](#parameters)
-   [isProfane](#isprofane)
    -   [Parameters](#parameters-1)
-   [replaceWord](#replaceword)
    -   [Parameters](#parameters-2)
-   [clean](#clean)
    -   [Parameters](#parameters-3)
-   [addWords](#addwords)
    -   [Parameters](#parameters-4)
-   [removeWords](#removewords)
    -   [Parameters](#parameters-5)

#### constructor

Filter constructor.

##### Parameters

-   `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Filter instance options (optional, default `{}`)
    -   `options.emptyList` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Instantiate filter with no blocklist
    -   `options.firstLetter` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Display first letter of word.
    -   `options.lastLetter` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Display last letter of word, depends on firstLetter being true.
    -   `options.list` **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** Instantiate filter with custom list
    -   `options.placeHolder` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Character used to replace profane words.
    -   `options.regex` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Regular expression used to sanitize words before comparing them to blocklist.
    -   `options.replaceRegex` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Regular expression used to replace profane words with placeHolder.
    -   `options.splitRegex` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Regular expression used to split a string into words.

#### isProfane

Determine if a string contains profane language.

##### Parameters

-   `string` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** String to evaluate for profanity.

#### replaceWord

Replace a word with placeHolder characters;

##### Parameters

-   `string` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** String to replace.

#### clean

Evaluate a string for profanity and return an edited version.

##### Parameters

-   `string` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Sentence to filter.

#### addWords

Add word(s) to blocklist filter / remove words from allowlist filter

##### Parameters

-   `word` **...[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Word(s) to add to blocklist

#### removeWords

Add words to allowlist filter

##### Parameters

-   `word` **...[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Word(s) to add to allowlist.

## Testing

    npm test

## License

The MIT License (MIT)

Copyright (c) 2013-2020 Michael Price, Ryan Berdel

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.