slugrs 0.2.3

A fast, locale-aware slugify library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

## slugrs

[![docs.rs](https://img.shields.io/docsrs/slugrs)](https://docs.rs/slugrs)

Fast, flexible, locale-aware slugify library for Rust. Mirrors the behavior of Node.js’s `slugify` package.

### Installation

On crates.io (after publishing):

```toml
[dependencies]
slugrs = "0.1"
```

Local path (during development):

```toml
[dependencies]
slugrs = { path = "../slugrs" }
```

### Quick Start

Recommended: Fluent `Slugifier`

```rust
use slugrs::{Slugifier, Locale};

let slug = Slugifier::new()
  .separator("_")
  .locale(Some(Locale::Tr))
  .max_length(Some(24))
  .slugify("İstanbul'a hoş geldiniz!");
assert_eq!(slug, "istanbula_hos_geldiniz");
```

Alternatives:

```rust
use slugrs::slugify;

// Defaults: separator "-", lowercase, trim, apostrophe removal, emoji removal
assert_eq!(slugify("Hello, World!"), "hello-world");
```

```rust
use slugrs::{slugify_with_options, Options, Locale};

// Simple customization (Options builder)
let slug = slugify_with_options(
  "Füße lösen Ärger",
  &Options::default().separator("_").locale(Some(Locale::De))
);
assert_eq!(slug, "fuesse_loesen_aerger");

let tr = Options::default().locale(Some(Locale::Tr));
assert_eq!(slugify_with_options("İstanbul'a hoş geldiniz!", &tr), "istanbula-hos-geldiniz");
```

### API

- `slugify(input: &str) -> String`: Slugify with default options.
- `slugify_with_options(input: &str, options: &Options) -> String`: Full control.
- `Options`: Behavior configuration.
- `Locale`: Language-specific conversions (`De`, `Tr`).
- `Slugifier`: Helper type for repeated calls with the same options.

### Options

| Field        | Type              | Default | Description |
|--------------|-------------------|---------|-------------|
| `separator`  | `String`          | `"-"`  | Word separator. Consecutive separators are collapsed. |
| `locale`     | `Option<Locale>`  | `None`  | Language-specific mappings like TR/DE. |
| `remove`     | `Option<Regex>`   | `None`  | Custom removal regex applied before processing. |
| `lowercase`  | `bool`            | `true`  | Convert output to lowercase. |
| `trim`       | `bool`            | `true`  | Trim leading/trailing separators. |
| `max_length` | `Option<usize>`   | `None`  | Max length; trims trailing separator after truncation. |

Notes:
- Emoji and similar symbols are removed by default.
- Non-ASCII characters are transliterated via `deunicode`.
- Apostrophes ("'", `’`) are removed by default to avoid extra separators.

### Locale Support

- `Locale::Tr`: `İ/ı -> I/i`, `ğ -> g`, `ş -> s`, `ç -> c`, `ö -> o`, `ü -> u`, etc.
- `Locale::De`: `ä -> ae`, `ö -> oe`, `ü -> ue`, `ß -> ss`, etc.

Locale transforms are applied before transliteration; remaining characters are then converted to ASCII.

### Examples

```rust
use regex::Regex;
use slugrs::{Slugifier, slugify, slugify_with_options, Options};

assert_eq!(slugify("Crème brûlée"), "creme-brulee");
assert_eq!(slugify("🔥 Rust & Friends"), "rust-friends");

let opts = Options::default().separator("_").remove(Some(Regex::new("[0-9]").unwrap()));
assert_eq!(slugify_with_options("A1 B2 C3", &opts), "a_b_c");

let s = Slugifier::new().separator("--").trim(true);
assert_eq!(s.slugify("  A--B__C  "), "a--b--c");

let limited = Options::default().max_length(Some(10));
assert_eq!(slugify_with_options("this is a very long title", &limited), "this-is-a");
```

### Performance

- Minimized use of regex and `deunicode`.
- Typically uses single-allocation string operations for speed.

### Tests

```sh
cargo test
```

### License

MIT