Futility is a library for the client or server that can help you detect naughty words in strings. Users can usually find a way around word blacklists and censorship is an almost impossilbe task, but if you have to do it, Futility can help (maybe). By providing a word list and an object that represents alternatives to letters in those words, Futility will build a RegExp object that you can use to test your user's input.
npm install futility
import Futility from 'futility';
const Futility = require('futility').default;
// Create a futility object with the default provided words and listslet futility = new Futility(/* customWordList, customLetterList */);futility.test('Kiss my @$5') // returns truefutility.replace('Kiss my @$5', 'face') // returns 'Kiss my face'futility.censor('Kiss my @$5' /*, customSymbols */) // returns 'Kiss my *!#'// Create a futility object with a custom word listlet futility = new Futility(['boat','car','train']);futility.test('I drive a car') // returns true
new Futility(/* customWordList, customLetterList */)
Creates a new instance of Futility with a custom word list and/or a custom letter list. If you do not provided your own lists the defaults will be used. You can take a look at the default word list and the default letter list to see how those are formatted.
Returns true if a naughty word is found in string
s and false if the string is clean.
.replace(String s, (String replacement|Function replacement))
Replaces naughty words in string
s with string
replacement or applys the
replacement function to the matched string (same as
.censor(String s /*, String [customSymbols='#$@&%*!'] */)
Will replace naughty words in string
s with random characters, comic book style, from the default customSymbols or provided string of custom symbols.
Tests are written with mocha.