@p4r4d0x0/bad-words

A javascript filter for badwords

Note

The purpose of this repository is to keep the package up to date. The former owner has not spoken for more than a year with numerous pull requests

Installation

npm install @p4r4d0x0/bad-words --save

Usage

const Filter = require('bad-words'),
    filter = new Filter();

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

Placeholder Overrides

const Filter = require('bad-words');
const customFilter = new Filter({ placeHolder: 'x'});

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

Regex Overrides

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

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

Add words to the blacklist

const filter = new Filter(); 

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

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

//or use an array using the spread operator

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

filter.addWords(...newBadWords);

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

//or

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

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

Instantiate with an empty list

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

Remove words from the blacklist

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

constructor

Filter constructor.

Parameters

options object Filter instance options (optional, default {})
- options.emptyList boolean Instantiate filter with no blacklist
- options.list array Instantiate filter with custom list
- options.placeHolder string Character used to replace profane words.
- options.regex string Regular expression used to sanitize words before comparing them to blacklist.
- options.replaceRegex string Regular expression used to replace profane words with placeHolder.

isProfane

Determine if a string contains profane language.

Parameters

string string String to evaluate for profanity.

replaceWord

Replace a word with placeHolder characters;

Parameters

string string String to replace.

clean

Evaluate a string for profanity and return an edited version.

Parameters

string string Sentence to filter.

addWords

Add word(s) to blacklist filter / remove words from whitelist filter

Parameters

word ...string Word(s) to add to blacklist

removeWords

Add words to whitelist filter

Parameters

word ...string Word(s) to add to whitelist.

Testing

npm test

License

The MIT License (MIT)

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.