1 unstable release

Uses old Rust 2015

0.1.0 Jul 26, 2017

#643 in Text processing

Download history 2283/week @ 2024-07-21 2697/week @ 2024-07-28 2628/week @ 2024-08-04 2811/week @ 2024-08-11 2996/week @ 2024-08-18 2849/week @ 2024-08-25 4025/week @ 2024-09-01 3217/week @ 2024-09-08 3075/week @ 2024-09-15 3523/week @ 2024-09-22 2025/week @ 2024-09-29 2733/week @ 2024-10-06 1502/week @ 2024-10-13 3111/week @ 2024-10-20 2854/week @ 2024-10-27 4389/week @ 2024-11-03

11,891 downloads per month
Used in 45 crates (21 directly)

MIT license

14KB
209 lines

Slugify

Build Status Build status Crates.io docs.rs License: MIT

A utility macro for flexible slug genereation that handles unicode.

The slugify! macro implements a flexible slug generator, allowing for stop words, custom separator and maximum length options. The macro provides both a simple call format that has sane default parameters but also allows there default parameters to be overriden when needed.

Features:

  • Unicode strings support (phonetic conversion).
  • Support for custom slug separator.
  • Stop words filtering.
  • Slug maximum length support.

Usage

This crate is on crates.io and can be used by adding slugify to the dependencies in your project's Cargo.toml

[dependencies]
slugify = "0.1.0"

and this to your crate root:

#[macro_use] extern  crate  slugify;
use slugify::slugify;

Examples

Basic slug generation

assert_eq!(slugify!("hello world"), "hello-world");

Using a custom separator

assert_eq!(slugify!("hello world", separator = "."), "hello.world");
assert_eq!(slugify!("hello world", separator = " "), "hello world");

Stop words filtering

assert_eq!(slugify!("the quick brown fox jumps over the lazy dog", stop_words = "the,fox"), "quick-brown-jumps-over-lazy-dog");

Maximum slug length

assert_eq!(slugify!("the hello world", stop_words = "the", max_length = 5), "hello");

Phonetic Conversion and accented text

assert_eq!(slugify!("影師嗎"), "ying-shi-ma");
assert_eq!(slugify!("Æúű--cool?"), "aeuu-cool");
assert_eq!(slugify!("Nín hǎo. Wǒ shì zhōng guó rén"), "nin-hao-wo-shi-zhong-guo-ren");

Passing multiple optional parameters.

NOTE: the order of optional parameters matters: stop_words, separator and then max_length. All of them are optional, however when specifying more than one optional parameter, this order must be adhered.

assert_eq!(slugify!("the hello world", stop_words = "the", separator = "-"), "hello-world");
assert_eq!(slugify!("the hello world", separator = ".", max_length = 10), "the.hello");
assert_eq!(slugify!("the hello world", stop_words = "the", max_length = 5), "hello");
assert_eq!(slugify!("the hello world", stop_words = "the", separator = "-", max_length = 20), "hello-world");

Dependencies

~2MB
~66K SLoC