#normalization #wikidot #normal #slug #name

wikidot-normalize

Simple library to provide Wikidot-compatible string normalization

19 releases (11 breaking)

0.12.0 Sep 29, 2023
0.11.0 Apr 16, 2023
0.10.0 May 11, 2022
0.9.2 Sep 9, 2021
0.3.0 Oct 20, 2019

#314 in Text processing

Download history 2/week @ 2023-12-11 35/week @ 2023-12-18 67/week @ 2024-01-08 38/week @ 2024-01-15 2/week @ 2024-01-22 35/week @ 2024-01-29 33/week @ 2024-02-05 83/week @ 2024-02-12 7/week @ 2024-02-19 47/week @ 2024-02-26 39/week @ 2024-03-04 68/week @ 2024-03-11

162 downloads per month
Used in 4 crates (3 directly)

MIT license

19KB
299 lines

wikidot-normalize

Rust CI badge docs.rs link

Simple library to provide Wikidot-compatible string normalization. It is a Rust port of the functionality in WDStringUtils::toUnixName.

Wikidot normal form is used in the site's page names. Essentially it ensures the following:

  • All ASCII is lowercase.
  • All characters outside of :, a-z, 0-9, or - are replaced with dashes.
  • Underscores are only permitted as the first character.
  • Any leading or trailing dashes are removed.
  • Any set of multiple dashes are replaced with a single dash.
  • Any set of multiple colons are replaced with a single colon.

Examples:

  • "Big Cheese Horace" -> "big-cheese-horace"
  • "bottom--Text" -> "bottom-text"
  • "Tufto's Proposal" -> "tufto-s-proposal"
  • "-test-" -> "test"

This library is getting close to finalization with a v1.0.0 release.

Available under the terms of the MIT License. See LICENSE.md.

Compilation

This library targets the latest stable Rust. At time of writing, that is 1.68.2

$ cargo build --release

Testing

$ cargo test

Add -- --nocapture to the end if you want to see test output.

Dependencies

~2.8–4MB
~95K SLoC