pure-flow-ai 🚫✨

Efficient profanity filter for JavaScript/TypeScript applications with flexible configuration and simple API 🛡️

Table of Contents

1. 🔍 Description
2. ⚡ Features
3. 💻 Installation
4. 🚀 Usage
5. 🤝 Contributing
6. 📄 License

🔍 Description

pure-flow-ai is a powerful and flexible profanity filter for JavaScript and TypeScript applications. It provides a simple yet comprehensive API for detecting, masking, and cleaning text from inappropriate language. Perfect for chat applications, comment systems, or any text-processing functionality requiring content moderation.

⚡ Features

• 🔍 Smart Detection: Efficiently identifies profane words in text
• 🎭 Flexible Masking: Customizable placeholder characters for censoring
• 🧹 Text Cleaning: Complete removal of inappropriate content
• 📝 Customizable Lists: Add your own words to block or allow
• 💪 TypeScript Support: Full type definitions included
• 🔄 Case Insensitive: Works regardless of letter casing
• 🎯 Zero Dependencies: Lightweight and efficient
• 🌍 Unicode Support: Works with special characters and different alphabets

💻 Installation

Using npm:

npm install pure-flow-ai

Using yarn:

yarn install pure-flow-ai

Using pnpm:

pnpm install pure-flow-ai

Advanced Example

import BadWordFilter from 'pure-flow-ai';

// Initialize with default options.
const { hasProfaneWords, maskProfanity, cleanString } = BadWordFilter({
  additionalBlockWords: ['bad', 'word,'],
  excludedWords: ['trash'],
  placeholder: '*',
  overrideBlockWords: true
});

// Check if text contains profanity.
const hasBadWords = hasProfaneWords('your text here');

// Mask profane words with asterisks
const masked = maskProfanity('your text here');

// Clean text by removing profane words.
const clean = cleanString('your text here');

🤝 Contributing

We'd love for you to contribute to pure-flow-ai! Whether it's reporting bugs, suggesting features, or submitting pull requests, your help is always appreciated.

How to contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Make your changes.
4. Commit your changes (git commit -am 'Add new feature').
5. Push to the branch (git push origin feature/your-feature).
6. Open a pull request.

📜 Code of Conduct

Please follow our Code of Conduct when participating in this project to ensure a welcoming and productive atmosphere.

🔒 Security Policy

Security is our priority. If you encounter any issues, please read our full Security Policy to report vulnerabilities safely and responsibly.

👥 Team

These folks keep the project moving and are resources for help.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🛡️ Make your application safer with pure-flow-ai!

Support

If you found this project useful, please consider giving it a ⭐️ on Github and sharing it with your friends!