slug-preserve 0.2.1

Case-preserving slugifier with Unicode PUA sentinel support (internal to fren)
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

# slug-preserve

Case-preserving slugifier with Unicode support.

Unlike most Rust slug crates (including the popular [`slug`](https://crates.io/crates/slug) crate) which always
lowercase, `slug-preserve` lets you choose how case is handled via `CaseMode`.

## Usage

```rust
use slug_preserve::{slugify, SlugOpts, CaseMode};

// Preserve original case (default)
let opts = SlugOpts::default();
assert_eq!(slugify("Hello World", &opts), "Hello-World");

// Lowercase
let opts = SlugOpts { separator: '_', case: CaseMode::Lower, ..Default::default() };
assert_eq!(slugify("Hello World", &opts), "hello_world");

// Title case
let opts = SlugOpts { case: CaseMode::Title, ..Default::default() };
assert_eq!(slugify("hello world", &opts), "Hello-World");
```

## Case modes

| `CaseMode`   | Effect                                    |
| ------------ | ----------------------------------------- |
| `Preserve`   | Keep original character case (default)    |
| `Lower`      | Lowercase everything                      |
| `Upper`      | Uppercase everything                      |
| `Title`      | First char of each word upper, rest lower |
| `Capitalize` | Alias for `Title`                         |

## Notes

- Input is NFKC-normalized before slugifying.
- Non-alphanumeric characters become the separator; runs collapse to one.
- Leading/trailing separators are trimmed from output.
- `split_camel` on `SlugOpts` is carried through but not acted on by this
  crate - callers (like [`fren-date`](https://crates.io/crates/fren-date)) split CamelCase before calling `slugify`.

## License

MIT - see [LICENSE](../../LICENSE) in the workspace root.