npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jsaway

v1.2.1

Published

A simple JavaScript swear filter, inspired by GoAway by TwiN.

Downloads

17

Readme

JSAway

npm npm NPM GitHub Repo stars

JS Away is a simple swear filter that was inspired by GoAway by TwiN.

Bad words are sourced from chucknorris-io/swear-words

Installation

Go into your terminal and type:

npm install --save jsaway

Usage

First, import the ProfanityDetector class.

import ProfanityDetector from 'jsaway'

Then, make a variable using the class.

const profDetector = new ProfanityDetector()

From here, you can use simple functions to find and detect profanity in text.

profDetector.has('fuck') // true
profDetector.extract('fuck you.') // 'fuck'
profDetector.extractAll('fuck you ass piece of shit') // ['fuck', 'ass', 'shit ']

JSAway also supports basic leetspeak detection (for example, "t3st" will still be detected).

profDetector.has('$h1+') // true
profDetector.extract('i love eating $h1+') // '$h1+'

You can also use the .bounds() function to find the slice that contains the profanity.

const profanityBounds = profDetector.bounds('piece of shit') // [9, 13]
'piece of shit'.slice(...profanityBounds) // 'shit'

JSAway can also censor your strings, using the .censor() method.

The second argument is the censorCharacter, or the character you want to censor with.

The third argument is includeFirstLetter, which includes the first letter of the profanity.

The fourth argument is includeLastLetter, which is like includeFirstLetter, but for the last letter of the profanity.

profDetector.censor('Fuck you. Fuck this shit.') // **** you. **** this ****.
profDetector.censor('Fuck you. Fuck this shit.', '-', true) // F--- you. F--- this s---.
profDetector.censor('Fuck you. Fuck this shit.', '•', true, true) // F••k you. F••k this s••t.

Customization

JSAway can be customized to only block certain profanities. You can do this buy either editing the list of default profanities, or by creating your own.

To add and remove profanities from the default profanities (see profanities.json for the full list), you can use the ProfanityDetector.addProfanity and ProfanityDetector.removeProfanity functions.

profDetector.addProfanity('test')
profDetector.has('test') // test
profDetector.extract('t3s+') // 't3s+'

profDetector.removeProfanity('test')
profDetector.extract('test') // null

You can also make your entire own list of profanities by simply editing the ProfanityDetector.profanities array.

profDetector.profanities = ['test', 'words']
profDetector.has('test') // true
profDetector.extract('t3s+') // 't3s+'

Example Usage

Message contains blocked words

import ProfanityDetector from 'jsaway'

const profDetector = new ProfanityDetector()

let message = 'Hello there!'
if (!profDetector.has(message)) {
    console.log(message)
} else {
    console.log(`Your message contains blocked words: 
    ${profDetector.extractAll(message).join(', ').slice(0, -2)}`)
}