1 unstable release

Uses old Rust 2015

0.1.0 Jul 26, 2017

#965 in Text processing

Download history 1859/week @ 2023-10-27 2430/week @ 2023-11-03 2245/week @ 2023-11-10 3382/week @ 2023-11-17 3124/week @ 2023-11-24 2545/week @ 2023-12-01 2624/week @ 2023-12-08 1737/week @ 2023-12-15 961/week @ 2023-12-22 2071/week @ 2023-12-29 2706/week @ 2024-01-05 2380/week @ 2024-01-12 2410/week @ 2024-01-19 2970/week @ 2024-01-26 2673/week @ 2024-02-02 3046/week @ 2024-02-09

11,334 downloads per month
Used in 32 crates (15 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