@ccatto/profanity

Multi-language profanity filter with Zod and NestJS support. Covers 12 languages (Arabic, Chinese, English, French, German, Hindi, Italian, Japanese, Korean, Portuguese, Russian, Spanish) with built-in false-positive whitelisting.

Install

npm install @ccatto/profanity
# or
yarn add @ccatto/profanity

Quick Start

// Core usage
import { isProfane, censorText } from '@ccatto/profanity';

isProfane('hello');       // false
isProfane('badword');     // true
censorText('some text');  // censors profane words with asterisks

// Zod integration
import { noProfanityCheck, noProfanityMessage } from '@ccatto/profanity/zod';
import { z } from 'zod';

const schema = z.object({
  name: z.string().min(2).refine(noProfanityCheck, noProfanityMessage('Name')),
});

// NestJS class-validator decorator
import { NoProfanity } from '@ccatto/profanity/nest';

class CreateUserDto {
  @NoProfanity()
  displayName: string;
}

Sub-exports

| Entry Point | Description | | --- | --- | | @ccatto/profanity | Core filter + Zod + NestJS (all-in-one) | | @ccatto/profanity/zod | Zod helpers only | | @ccatto/profanity/nest | NestJS decorator only |

Peer Dependencies

| Package | Version | Required | | --- | --- | --- | | class-validator | >=0.14.0 | No |

License

MIT