/Clensify

Clensify - Cleans your platform from profanity/obscenity, a npm package

Primary LanguageTypeScript

Clensify

Extensive and efficient detection of profanity/bad-words/terms (and their coded versions)

license last-commit repo-top-language repo-language-count


It supports detection for modified spellings : Pr0Fan17y, 🅿ro𝔉aNίt¥, p̴̛͇͕̀̔̓̾̔̎͊̾̎͌̂̆̕͘͜r̴̖̱̅̄̈́͜ơ̴̱͕̣̦͓̿̂̆̈́̿̓̒̌̊̓̚f̶̢̘͙͖͎̪̱̳͇͇͙͔̜̈́̈́̐̊̇̌̾̄͠ͅa̸̢͙̥̔̀̀ͅn̸͔͇̬̬̥̦͈̏̀i̶̧̡̡̛̹̖̙̱̼͓̳̬͎̣̎͒̈̃̉̅͊͑̓̀͘͜t̷̡̘̟̘̠͔̼̬͈̮͖̘̰̿́̇̈͆̇̈͊̊͜ý̶̢̠͙̪̜͖̭̣͖͈̱̩̃͆̓̉́̽͌̇͑͂̚̕̚͠ etc. (You know it works when you cant even read the last one :)


Quick Links


Overview

The package intends to help developers introduce text-based moderation in their web platform by flagging text content which contains profanity/obscene words and phrases.


Features

Clensify does extensive pre-processing to help detect text formats which intend to bypass conventional bad-word filters (zalgo, bubble-text, leetspeak etc.).

Various detection strategies are used, inlcuding bloom-filtering, others currently in development...


Getting Started

Placeholders as of now, will be updated soon...

Installation

  1. Clone the Clensify repository:
git clone https://github.com/ag-wnl/Clensify
  1. Change to the project directory:
cd Clensify
  1. Install the dependencies:
npm install

Contributing

This section is currently a placeholder, will be updated soon... Contributions are welcome! Here are several ways you can contribute:

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your GitHub account.
  2. Clone Locally: Clone the forked repository to your local machine using a Git client.
    git clone https://github.com/ag-wnl/Clensify
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates.
    git commit -m 'Implemented new feature x.'
  6. Push to GitHub: Push the changes to your forked repository.
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.


Author

Clensify, under MIT license. Authored and maintained by Agnideep.