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

swearfilter

v2.0.4

Published

Detect swear words, and handle strings containing them. Smart Detection helps to detect words using leetspeak, or any other word circumvention methods.

Downloads

83

Readme

Swear Filter is designed to detect swear words, and handle strings containing them.

NPM

Downloads Discord Server

Features

  • 🧠 Smart Detection | Detects words using leetspeak, or any other filter loopholes. It can also fix the Scunthorpe Problem, meaning words like "grass" won't get flagged.

  • 💬 Base Filter | This package contains a base filter, and when chosen to be activated, will allow you to detect approximately 2,000 swear words.

  • 📝 Very Customizable | You can easily add or remove words from the filter.

  • 📦 Quick and Easy Setup | Setting up a filter takes only a few seconds.

  • 🚫 No Dependencies | This package does not rely on any other packages to provide its functionality, making installation fast and the package size small.

Install Package

To install this powerful word-filtering tool, open your project's terminal and type:

npm i swearfilter --save

Creating a Filter

Creating a new filter is really quick and easy. Simply create a new instance of the Filter class!

const Filter = require("swearfilter");

const filter = new Filter({
    swearWords: ["bad", "words", "here"], // Add your own custom words here.
    smartDetect: true, // Enable smart detection. (Defaults to true)
    baseFilter: {
        useBaseFilter: true, // Disable the base filter. (Defaults to false)
        uncensoredWords: ["words", "to", "ignore"] // Specify words to ignore here.
   }
});

Filter Methods

  • Filter#test(string)

    The test() method will test a string to see if it contains any bad words.

    Any bad words that were found will be returned in an array of FilterResponse objects, which also contain the type of filter that picked them up.

    const Filter = require("swearfilter");
    
    const filter = new Filter({
        swearWords: ["bad", "words", "here"],
        smartDetect: true,
        baseFilter: {
            useBaseFilter: true,
            uncensoredWords: ["words", "to", "ignore"]
       }
    });
    
    filter.test("thisisbad");
    // => [ { word: 'bad', filter: 'custom' } ]
    
    filter.test("b @ d");
    // => [ { word: 'bad', filter: 'custom' } ]
    
    filter.test("b;a,..;a;.,;,d;,a.;,d;,B,;a,;D;;;g;h:f;;;d,;d");
    // => [ { word: 'bad', filter: 'custom' } ]
  • Filter#censor(string, options)

    The censor() method will replace any bad words found in a string with masks.

    You can specify the string to use when masking a bad word, and the type of masking to use.

    const Filter = require("swearfilter");
    
    const filter = new Filter({
        swearWords: ["frick", "beach", "bad"],
        smartDetect: true,
        baseFilter: {
            useBaseFilter: true,
            uncensoredWords: ["words", "to", "ignore"]
       }
    });
    
    filter.censor("Hey, frick you beach, you are bad", { mask: "*", type: "character" }); // Censors all characters in bad words with "*".
    // => "Hey, ***** you *****, you are ***"
    
    filter.censor("Hey, frick you beach, you are bad", { mask: "[bleep]", type: "word" }); // Censors all words in bad words with "[bleep]".
    // => "Hey, [bleep] you [bleep], you are [bleep]"

Contact Us