https://github.com/cityssm/unleet
Removes symbols and character combinations from a text string, and replaces them with the letters they commonly represent.
https://github.com/cityssm/unleet
bad-words decode deleet filter hacktoberfest leet leet-converter sanitize unleet
Last synced: 11 months ago
JSON representation
Removes symbols and character combinations from a text string, and replaces them with the letters they commonly represent.
- Host: GitHub
- URL: https://github.com/cityssm/unleet
- Owner: cityssm
- License: mit
- Created: 2020-07-30T14:03:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T23:57:23.000Z (over 3 years ago)
- Last Synced: 2025-08-22T21:28:40.522Z (11 months ago)
- Topics: bad-words, decode, deleet, filter, hacktoberfest, leet, leet-converter, sanitize, unleet
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@cityssm/unleet
- Size: 663 KB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# unleet
[](https://www.npmjs.com/package/@cityssm/unleet)
[](https://app.codacy.com/gh/cityssm/unleet)
[](https://codeclimate.com/github/cityssm/unleet/maintainability)
[](https://codeclimate.com/github/cityssm/unleet/test_coverage)
[](https://ci.appveyor.com/project/dangowans/unleet)
[](https://app.snyk.io/org/cityssm/project/74b981cc-b59e-4338-b290-e161741c418a)
**Worry less about maintaining a list of every possible spelling
of every bad word.**
Ensuring that text entered by a user is _polite_ can be difficult.
Generating memorable passwords automatically using letters and numbers,
without creating an offensive combination is challenging as well.
This project attempts to help by taking a piece of text,
and replacing symbols that are commonly used to hide bad words with the letters
they may represent. The result can be scanned against a far simpler
bad words file.
## Installation
```bash
npm install @cityssm/unleet
```
## Usage
```javascript
import unleet from "@cityssm/unleet";
unleet("b@d w0rd");
// => [ "bad word" ]
unleet("1337 $P33K");
// => [ 'ieet zpeek', 'ieet speek', 'leet zpeek', 'leet speek' ]
unleet("0rg@ni℠");
// => [ 'organizm', 'organism' ]
```
## Contributing
Found some text that doesn't _unleet_ properly? Open an issue.
Pull requests with more bizarre Unicode-to-letter mappings
are more than welcome!