fileslug 0.1.3

Filename-aware slug generator — slugifies file names (preserving extensions, dotfiles, version numbers) and arbitrary text
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

# fileslug

Slug generator for Rust. Slugifies filenames and arbitrary text into clean, URL and shell-friendly strings.

Two entry points:

- **`slugify()`** — filename-aware: preserves extensions, dotfiles, compound extensions (`.tar.gz`), and version numbers
- **`slugify_string()`** — plain text: treats input as a raw string with no filename handling — use for URL slugs, identifiers, titles, etc.

## Usage

### Filenames

```rust
use fileslug::{slugify, SlugifyOptions, Style};

let opts = SlugifyOptions::default(); // kebab-case, transliterate unicode
assert_eq!(slugify("Café Résumé (Final).pdf", &opts), "cafe-resume-final.pdf");
assert_eq!(slugify(".env.local", &opts), ".env.local");
assert_eq!(slugify("archive.tar.gz", &opts), "archive.tar.gz");
assert_eq!(slugify("app-1.2.3.dmg", &opts), "app-1.2.3.dmg");

// Snake case
let snake = SlugifyOptions { style: Style::Snake, ..Default::default() };
assert_eq!(slugify("My Cool File.txt", &snake), "my_cool_file.txt");

// camelCase
let camel = SlugifyOptions { style: Style::Camel, ..Default::default() };
assert_eq!(slugify("my cool file.txt", &camel), "myCoolFile.txt");

// Keep unicode (skip transliteration)
let unicode = SlugifyOptions { keep_unicode: true, ..Default::default() };
assert_eq!(slugify("Café.txt", &unicode), "café.txt");
```

### Arbitrary text

```rust
use fileslug::{slugify_string, SlugifyOptions};

let opts = SlugifyOptions::default();
assert_eq!(slugify_string("My Blog Post Title!", &opts), "my-blog-post-title");
assert_eq!(slugify_string("Café Résumé", &opts), "cafe-resume");
```

## Features

- **Two modes** — filename-aware (`slugify`) and plain text (`slugify_string`)
- **Extension preservation** — `.txt`, `.tar.gz`, `.tar.bz2` etc. never modified
- **Dotfile awareness** — `.gitignore`, `.env` returned as-is
- **Version number preservation** — `1.2.3` dots kept intact
- **Unicode transliteration** — via `any_ascii` (or keep-unicode to skip)
- **Three styles** — kebab-case (default), snake_case, camelCase
- **Zero-copy for dotfiles** — returns `Cow::Borrowed` when no changes needed