Slugify any language

The same thing in your own code

Each code block has been compiled and verified in CI. Provided under the MIT license to illustrate disarm. disarm on GitHub →

# A slug romanized as the language, not character by character.
#   pip install disarm
from disarm import slugify

# и romanizes differently in Ukrainian than in Russian, so a library with one
# table for all Cyrillic cannot get both right. Kyiv is the city; kiyiv is what
# you get when nothing knew the language.
assert slugify("Київ") == "kiyiv"
assert slugify("Київ", lang="uk") == "kyiv"
assert slugify("Київ", lang="auto") == "kyiv"

# Detection needs a character exclusive to one language. ї is Ukrainian and
# appears in no other Cyrillic alphabet disarm profiles, so auto finds it.
# ß plays the same role for German.
assert slugify("Fußgänger", lang="auto") == "fussgaenger"
assert slugify("Fußgänger") == "fussganger"

# And where there is no such character, detection declines rather than guessing.
# Ärger is German to a reader and ambiguous to a machine: ä and ü are used by
# other languages too, so the profile has to be passed.
assert slugify("Ärger im Büro", lang="auto") == "arger-im-buro"
assert slugify("Ärger im Büro", lang="de") == "aerger-im-buero"

print("ok: kyiv not kiyiv; detection found ї and ß, and declined on Ärger")

// A slug romanized as the language, not character by character.
//   cargo add disarm
use disarm::api::{slugify, SlugConfig};

fn slug(text: &str, lang: Option<&str>) -> String {
    let mut cfg = SlugConfig::new();
    cfg.lang = lang.map(str::to_string);
    slugify(text, &cfg)
}

fn main() {
    // и romanizes differently in Ukrainian than in Russian, so a library with
    // one table for all Cyrillic cannot get both right. Kyiv is the city;
    // kiyiv is what you get when nothing knew the language.
    assert_eq!(slug("Київ", None), "kiyiv");
    assert_eq!(slug("Київ", Some("uk")), "kyiv");
    assert_eq!(slug("Київ", Some("auto")), "kyiv");

    // Detection needs a character exclusive to one language. ї is Ukrainian
    // and ß is German.
    assert_eq!(slug("Fußgänger", Some("auto")), "fussgaenger");
    assert_eq!(slug("Fußgänger", None), "fussganger");

    // Where there is no such character, detection declines rather than guessing.
    assert_eq!(slug("Ärger im Büro", Some("auto")), "arger-im-buro");
    assert_eq!(slug("Ärger im Büro", Some("de")), "aerger-im-buero");

    println!("ok: kyiv not kiyiv; detection found ї and ß, and declined on Ärger");
}

// A slug romanized as the language, not character by character.
//   npm install disarm
const { slugify } = require("disarm");

const eq = (got, want, msg) => {
  if (got !== want) throw new Error(`${msg}: expected ${want}, got ${got}`);
};

// и romanizes differently in Ukrainian than in Russian, so a library with one
// table for all Cyrillic cannot get both right. Kyiv is the city; kiyiv is what
// you get when nothing knew the language.
eq(slugify("Київ"), "kiyiv", "no profile");
eq(slugify("Київ", { lang: "uk" }), "kyiv", "explicit Ukrainian");
eq(slugify("Київ", { lang: "auto" }), "kyiv", "detected");

// Detection needs a character exclusive to one language. ї is Ukrainian and ß
// is German.
eq(slugify("Fußgänger", { lang: "auto" }), "fussgaenger", "detected German");
eq(slugify("Fußgänger"), "fussganger", "no profile");

// Where there is no such character, detection declines rather than guessing.
eq(slugify("Ärger im Büro", { lang: "auto" }), "arger-im-buro", "nothing to detect");
eq(slugify("Ärger im Büro", { lang: "de" }), "aerger-im-buero", "explicit German");

console.log("ok: kyiv not kiyiv; detection found ї and ß, and declined on Ärger");

# A slug romanized as the language, not character by character.
#   gem install disarm
require "disarm"

def eq(got, want, msg)
  raise "#{msg}: expected #{want}, got #{got}" unless got == want
end

# и romanizes differently in Ukrainian than in Russian, so a library with one
# table for all Cyrillic cannot get both right. Kyiv is the city; kiyiv is what
# you get when nothing knew the language.
eq(Disarm.slugify("Київ"), "kiyiv", "no profile")
eq(Disarm.slugify("Київ", lang: "uk"), "kyiv", "explicit Ukrainian")
eq(Disarm.slugify("Київ", lang: "auto"), "kyiv", "detected")

# Detection needs a character exclusive to one language. ї is Ukrainian, ß German.
eq(Disarm.slugify("Fußgänger", lang: "auto"), "fussgaenger", "detected German")
eq(Disarm.slugify("Fußgänger"), "fussganger", "no profile")

# Where there is no such character, detection declines rather than guessing.
eq(Disarm.slugify("Ärger im Büro", lang: "auto"), "arger-im-buro", "nothing to detect")
eq(Disarm.slugify("Ärger im Büro", lang: "de"), "aerger-im-buero", "explicit German")

puts "ok: kyiv not kiyiv; detection found ї and ß, and declined on Ärger"

// A slug romanized as the language, not character by character.
//   implementation("dev.disarm:disarm:0.14.1")
import dev.disarm.Disarm;
import dev.disarm.SlugOptions;

public class SlugifyLang {
    static void eq(String got, String want, String msg) {
        if (!got.equals(want)) {
            throw new IllegalStateException(msg + ": expected " + want + ", got " + got);
        }
    }

    static String slug(String text, String lang) {
        if (lang == null) return Disarm.slugify(text);
        return Disarm.slugify(text, SlugOptions.builder().lang(lang).build());
    }

    public static void main(String[] args) {
        // и romanizes differently in Ukrainian than in Russian, so a library
        // with one table for all Cyrillic cannot get both right. Kyiv is the
        // city; kiyiv is what you get when nothing knew the language.
        String kyiv = "Київ";
        eq(slug(kyiv, null), "kiyiv", "no profile");
        eq(slug(kyiv, "uk"), "kyiv", "explicit Ukrainian");
        eq(slug(kyiv, "auto"), "kyiv", "detected");

        // Detection needs a character exclusive to one language: ї is
        // Ukrainian, ß is German.
        eq(slug("Fußgänger", "auto"), "fussgaenger", "detected German");
        eq(slug("Fußgänger", null), "fussganger", "no profile");

        // Where there is no such character, detection declines rather than guessing.
        eq(slug("Ärger im Büro", "auto"), "arger-im-buro", "nothing to detect");
        eq(slug("Ärger im Büro", "de"), "aerger-im-buero", "explicit German");

        System.out.println("ok: kyiv not kiyiv; detection found ї and ß, "
            + "and declined on Ärger");
    }
}

// A slug romanized as the language, not character by character.
//   implementation("dev.disarm:disarm-kotlin:0.14.1")
import dev.disarm.Disarm
import dev.disarm.SlugOptions

fun eq(got: String, want: String, msg: String) {
    check(got == want) { "$msg: expected $want, got $got" }
}

fun slug(text: String, lang: String?): String =
    if (lang == null) Disarm.slugify(text)
    else Disarm.slugify(text, SlugOptions.builder().lang(lang).build())

fun main() {
    // и romanizes differently in Ukrainian than in Russian, so a library with
    // one table for all Cyrillic cannot get both right. Kyiv is the city;
    // kiyiv is what you get when nothing knew the language.
    val kyiv = "Київ"
    eq(slug(kyiv, null), "kiyiv", "no profile")
    eq(slug(kyiv, "uk"), "kyiv", "explicit Ukrainian")
    eq(slug(kyiv, "auto"), "kyiv", "detected")

    // Detection needs a character exclusive to one language: ї is Ukrainian,
    // ß is German.
    eq(slug("Fußgänger", "auto"), "fussgaenger", "detected German")
    eq(slug("Fußgänger", null), "fussganger", "no profile")

    // Where there is no such character, detection declines rather than guessing.
    eq(slug("Ärger im Büro", "auto"), "arger-im-buro", "nothing to detect")
    eq(slug("Ärger im Büro", "de"), "aerger-im-buero", "explicit German")

    println("ok: kyiv not kiyiv; detection found ї and ß, and declined on Ärger")
}