cityssm/unleet

Removes symbols and character combinations from a text string, and replaces them with the letters they commonly represent.

unleet

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

npm install @cityssm/unleet

Usage

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!

unleet's Issues

Unleet won't work at all

I get this error whenever I use the package. Is there anything I can do, or is this a bug?

Heap out of memory error

Sometimes when using this package, a heap out of memory error occurs. This usually happens with longer strings.

Version: 1.0.3
Node Version: 16.6

Can't resolve 'fs' and 'fileURLToPath' was not found in 'url'

Since upgrading @cityssm/simple-password-generator from version 2.0.2 to 2.1.1 getting the follwing errors:
ERROR in ./node_modules/@cityssm/unleet/translations.js 1:0-25
Module not found: Error: Can't resolve 'fs' in '/node_modules/@cityssm/unleet'

ERROR in ./node_modules/@cityssm/unleet/translations.js 3:25-38
export 'fileURLToPath' (imported as 'fileURLToPath') was not found in 'url' (possible exports: Url, format, parse, resolve, resolveObject)

Looks to be changes from this commit.
e22e5a4

I'm using Laravel Mix with webpack for building js.

I've tried adding this which seems to fix the first issue but the second is still present:

mix.webpackConfig({
    resolve: {
        fallback: {
            "fs": false,
            "path": false,
            "os": false,
        }
    }
});

Error [ERR_REQUIRE_ESM]: require() of ES Module not supported

// test.ts
import unleet from '@cityssm/unleet'

unleet('b@d w0rd')

If I run either yarn ts-node test.ts or yarn tsc test.ts && node test.js I get the following error:

var unleet_1 = require("@cityssm/unleet");
               ^

Error [ERR_REQUIRE_ESM]: require() of ES Module /home/eodeluga/src/test/node_modules/@cityssm/unleet/index.js from /home/eodeluga/test/test.js not supported.
Instead change the require of index.js in /home/eodeluga/src/test/test.js to a dynamic import() which is available in all CommonJS modules.
    at Object.<anonymous> (/home/eodeluga/src/test/test.js:3:16) {
  code: 'ERR_REQUIRE_ESM'
}

Node.js v18.18.0