coleww / this-is-probably-ok-to-say

a text filter
6 stars 0 forks source link

this-is-probably-ok-to-say

AKA tipots

a stern reproachful glare

TW: this module is meant to filter out problematic language, as such there may be triggering content in the source code and/or dependencies.

INSTALL

npm install this-is-probably-ok-to-say --save

USE

var tipots = require('this-is-probably-ok-to-say')
tipots('oh wow hi this is how you use the tipots module')
=> true // this string does not seem to contain problematic language!

INFO

this module is a wrapper around iscool which is itself a wrapper around wordfilter so in turn I hope that you will write a wrapper around tipots.

in addition to running iscool/worfilter on a string, tipots also has an expanded filter list of words to avoid, as well as word sequences that might be ok when broken up but are not cool together (i.e, "electric chair"), while also running sentiment analysis and rejecting any strings that have a very negative score and also mention a sensitive word such as a religion or ethnicity.

CONTRIBUTING

If in the course of using tipots you find that it lets through a word or string that is not cool, please open an issue or make a PR so we can change that! This is the file of bad sequences of words and this is the file of just bad words though :warning: both of these files are obviously full of problematic language :< Words that are usually ok to tweet about but that might be innapropriate in a very negatively charged tweet can go in sensitive words

NPM