Profanity Filter

version 1.2.1

This project is a profanity filter that detects and filters out offensive words and phrases from text. It supports multiple languages and includes leetspeak normalization.

Features

• Detects offensive words and phrases in text
• Supports multiple languages
• Normalizes leetspeak
• Customizable profanity word list

Installation

1. Install the package:

   npm install @tenapato/profanity-filter

Usage

Basic Usage

import  ProfanityFilter  from 'profanity-filter'

const filter = new ProfanityFilter();
const word = "Your word here";
const isProfane = filter.isProfane(word);

console.log(`Is the word profane? ${isProfane}`);

Custom Options

You can customize the filter by passing options to the constructor:

const filter = new ProfanityFilter({
    langs: ['eng', 'spanish'], // languages
    threshold: 2, // Levenshtein distance threshold
    debug: true // Enable debug logging
});

Supported Languages

• English
• Spanish

Adding Custom Profane Words

You can add custom profane words to the filter:

filter.addProfaneWord('customword');