# @cityssm/unleet

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

Latest version **2.4.0** (published 2022-05-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cityssm/unleet
pnpm add @cityssm/unleet
yarn add @cityssm/unleet
bun add @cityssm/unleet
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.4.0 |
| Published | 2022-05-18 |
| First published | 2020-07-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 |
| Dependencies | 1 |
| Unpacked size | 32.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | The Corporation of the City of Sault Ste. Marie |
| Maintainers | dgowans |
| Keywords | bad-words, decode, deleet, leet-speak, leet, sanitize |

## Links

- npm: https://www.npmjs.com/package/@cityssm/unleet
- Repository: https://github.com/cityssm/unleet
- Homepage: https://github.com/cityssm/unleet#readme
- Issues: https://github.com/cityssm/unleet/issues
- npm.io page: https://npm.io/package/@cityssm/unleet

## Dependencies (1)

- [remove-accents](https://npm.io/package/remove-accents.md) ^0.4.2

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 2.4.0 (latest) — 2022-05-18
- 2.3.2 — 2022-02-07
- 2.3.1 — 2021-07-16
- 2.3.0 — 2021-07-16
- 2.2.0 — 2021-07-06
- 2.1.0 — 2021-05-14
- 2.0.0 — 2021-04-19
- 1.0.3 — 2021-02-18
- 1.0.2 — 2021-01-11
- 1.0.1 — 2020-10-30
- 1.0.0 — 2020-10-22
- 0.11.3 — 2020-10-02
- 0.11.2 — 2020-09-09
- 0.11.1 — 2020-08-27
- 0.11.0 — 2020-08-18
- … 9 more at https://npm.io/package/@cityssm/unleet/versions

## README

# unleet

[![npm](https://img.shields.io/npm/v/@cityssm/unleet)](https://www.npmjs.com/package/@cityssm/unleet)
[![Codacy Badge](https://img.shields.io/codacy/grade/fd8f113908c04c54800c9454d50f2e2a)](https://app.codacy.com/gh/cityssm/unleet)
[![Maintainability](https://img.shields.io/codeclimate/maintainability/cityssm/unleet)](https://codeclimate.com/github/cityssm/unleet/maintainability)
[![Test Coverage](https://img.shields.io/codeclimate/coverage/cityssm/unleet)](https://codeclimate.com/github/cityssm/unleet/test_coverage)
[![AppVeyor](https://img.shields.io/appveyor/build/dangowans/unleet)](https://ci.appveyor.com/project/dangowans/unleet)
[![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/cityssm/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!

---
_Source: https://npm.io/package/@cityssm/unleet · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._