bad-words

A javascript filter for badwords

Requirements

As of version 2, requires you either have an environment that understands ES2016 and beyond or a transpiler like Babel.

Installation

npm install bad-words --save

Usage

varFilter=require('bad-words'),filter=newFilter();console.log(filter.clean("Don't be an ash0le"));//Don't be an ******

Placeholder Overrides

varFilter=require('bad-words');varcustomFilter=newFilter({placeHolder: 'x'});customFilter.clean("Don't be an ash0le");//Don't be an xxxxxx

Regex Overrides

varfilter=newFilter({regex: /\*|\.|$/gi});varfilter=newFilter({replaceRegex: /[A-Za-z0-9가-힣_]/g});//multilingual support for word filtering

Add words to the blacklist

varfilter=newFilter();filter.addWords('some','bad','word');filter.clean("some bad word!")//**** *** ****!//or use an array using the spread operatorvarnewBadWords=['some','bad','word'];filter.addWords(...newBadWords);filter.clean("some bad word!")//**** *** ****!//orvarfilter=newFilter({list: ['some','bad','word']});filter.clean("some bad word!")//**** *** ****!

Instantiate with an empty list

varfilter=newFilter({emptyList: true});filter.clean('hell this wont clean anything');//hell this wont clean anything

Remove words from the blacklist

letfilter=newFilter();filter.removeWords('hells','sadist');filter.clean("some hells word!");//some hells word!//or use an array using the spread operatorletremoveWords=['hells','sadist'];filter.removeWords(...removeWords);filter.clean("some sadist hells word!");//some sadist hells word!

API

constructor

Filter constructor.

Parameters

• optionsobject Filter instance options (optional, default {})
  • options.emptyListboolean Instantiate filter with no blacklist
  • options.listarray Instantiate filter with custom list
  • options.placeHolderstring Character used to replace profane words.
  • options.regexstring Regular expression used to sanitize words before comparing them to blacklist.
  • options.replaceRegexstring Regular expression used to replace profane words with placeHolder.

isProfane

Determine if a string contains profane language.

Parameters

• stringstring String to evaluate for profanity.

replaceWord

Replace a word with placeHolder characters;

Parameters

• stringstring String to replace.

clean

Evaluate a string for profanity and return an edited version.

Parameters

• stringstring 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)

Copyright (c) 2013 Michael Price

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.