Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@andzh777/swear-filter

aNereds10ISC1.1.0TypeScript support: included

Bad word filter.

bad, word, words, profanity, filter, blacklist, black, list, swear, english, мат, фильтр, filtrs, lamuvārdi, vārdi

readme

automod-filter

A javascript filter for badwords

Npm version

Installation

npm i @andzh777/swear-filter

Usage

const { Automod } = require('automod-filter');

console.log(Automod.filter("What the fuck is going on here? Whore" })); // What the ████ is going on here? █████

Options

const { Automod, Lang, Method } = require('./lib/index.js');

console.log(Automod.filter("d@mn а я fuck не понял 6ля что вы shit делаете whore в холодильнике cуk@", { langs: [ Lang.ENGLISH ], method: Method.CLASSIC } ));
// {
//     input: 'd@mn а я fuck не понял 6ля что вы shit делаете whore в холодильнике cуk@',      
//     output: 'd@mn а я ████ не понял 6ля что вы ████ делаете █████ в холодильнике cуk@'
//     matches: [ 'fuck', 'Whore' ]
// }

console.log(Automod.filter("d@mn а я fuck не понял 6ля что вы shit делаете whore в холодильнике cуk@", { langs: [ Lang.ENGLISH, Lang.RUSSIAN ], method: Method.STRICT, replacer: "*" }));
// {
//     input: 'd@mn а я fuck не понял 6ля что вы shit делаете whore в холодильнике cуk@',      
//     output: '**** я **** не понял *** что вы **** делаете ***** в холодильнике ****',     
//     matches: [ 'd@mn', 'fuck', '6ля', 'shit', 'whore', 'cуk@' ]
// }

TODO

  • Regex search
  • Fill English replacers
  • URL parser