# leetspeak

[![leetspeak crate](https://img.shields.io/crates/v/leetspeak.svg)](https://crates.io/crates/leetspeak)
[![leetspeak documentation](https://docs.rs/leetspeak/badge.svg)](https://docs.rs/leetspeak)
[![build status](https://github.com/EthanC2/leetspeak/workflows/Rust/badge.svg)](https://github.com/EthanC2/leetspeak/actions)
![minimum rustc 1.64.0](https://img.shields.io/badge/rustc-1.64.0+-red.svg)

*leetspeak* is a english-to-[leetspeak](https://www.howtogeek.com/443390/what-is-leet-speak-and-how-do-you-use-it/) translation library with support for random, non-random, 
and custom leetspeak translation. Translations are based on [wikipedia/leet#orthography](https://en.wikipedia.org/wiki/Leet#Orthography).
Using this library is as simple as:

```rust
use leetspeak::Level;

let text = "sphinx of black quartz, judge my vow";

// Random leetspeak translation
let random_translation = leetspeak::translate(text);

// Non-random leetspeak translation, levels 1-3
let nonrandom_translation = leetspeak::translate_with_level(text, &Level::One);
assert_eq!(nonrandom_translation, r#"5ph1nx 0f 814ck qu427z, jud93 my v0w"#);

//Custom leetspeak translation (case-insensitive). Characters not in the hashmap are not changed.
let mapping = std::collections::HashMap::from([
    ('a', String::from("4")),
    ('c', String::from("<")),
    ('e', String::from("€")),
    ('m', String::from(r#"/\/\"#)),
    ('p', String::from("|*")),
    ('s', String::from("ehs")),
    ('w', String::from("vv")),
    ('z', String::from("7_")),
]);

let custom_translation = leetspeak::translate_custom(text, mapping, &false);
assert_eq!(custom_translation, r#"ehs|*hinx of bl4<k qu4rt7_, judg€ /\/\y vovv"#);
```

# Contributing
This is an open-source project and contributors are welcome!
The repository is at [github.com: leetspeak](https://github.com/EthanC2/leetspeak) 
and development plans/progress are documented at [github.com: leetspeak/projects](https://github.com/users/EthanC2/projects/5/views/1). If this library is missing a feature you would like, feel free to [start a discussion](https://github.com/EthanC2/leetspeak/discussions) or develop a feature and [create a pull request](https://github.com/EthanC2/leetspeak/pulls).