Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
censor-sensor
Advanced tools
Readme
A better profanity filter.
Every other profanity filter just seems to be an array of words, checked against every word in a phrase. This is ridiculous - it's an O(N^2) check when it only needs to be O(N). Of course, this library, by default, only requires an O(N) check (and that's against your phrase; not my words). You can opt in to a "like" check which will check every word and try to match it to a substring.
Every other profanity filter also seems to neglect "tiers" of words. You might want to filter out slurs, but not common profanity. You can do that here.
If you want, you can pass a function that lets you censor words how you want. By default, it will be replaced with the *
character in quantity based on the word (so "fuck" translates to "****").
That said, this library only has a list for english (en
), but could be extended to add more fairly easily.
You can remove or add words at run time. By default, they'll be assigned the lowest tier (5).
Words are shamelessly based on profanity-cleanser, because I'm not creative enough to think of some of these.
npm i censor-sensor
import { CensorSensor } from 'censor-sensor';
const censor = new CensorSensor();
// check for profanity (using equality)
censor.isProfane('bollocks'); // true
censor.isProfane('hello'); // false
// check for profanity (using string.includes)
censor.isProfaneIsh('bollockshead') // true
censor.isProfaneIsh('hello') // true
// get the words that are profane from a phrase
censor.profaneIshWords('hello') // ['hell']
// clean profanity (using equality)
censor.cleanProfanity('bollocks') // '****' (by default)
censor.cleanProfanityIsh('hello') // '****o' (by default)
// add a custom cleanup function
censor.setCleanFunction((str) => Array.from(str, x => '%').join('')); // replace all bad characters with '%'
censor.cleanProfanity('bollocks') // '%%%%%%%%' (by default)
// reset the cleanup function
censor.resetCleanFunction()
// modify the banned words list
censor.isProfane('asdf') // false
censor.addWord('asdf')
censor.isProfane('asdf') // true
censor.removeWord('asdf')
censor.isProfane('asdf') // false
// modify the banned "tier"
censor.isProfane('bollocks') // true
censor.disableTier(4)
censor.isProfane('bollocks') // false
censor.enableTier(4);
censor.isProfane('bollocks') // true
// add a custom locale (dict) and use it
censor.isProfane('uwotm8') // false
censor.addLocale('custom', { uwotm8: 1 }) // the highest form of insult
censor.setLocale('custom')
censor.isProfane('uwotm8') // true
censor.setLocale('en')
censor.isProfane('uwotm8') // false
As stated before, every word has a tier associated with it. Here is what each tier number means:
Feel free to contribute words, locales, or features.
FAQs
a better profanity filter
The npm package censor-sensor receives a total of 888 weekly downloads. As such, censor-sensor popularity was classified as not popular.
We found that censor-sensor demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.