slug: Type-safe slugs for Yesod ecosystem

[ bsd3, deprecated, library, web, yesod ] [ Propose Tags ]

Type-safe slugs for Yesod ecosystem.

[Skip to Readme]
Versions [faq] 0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.6, 0.1.7
Change log
Dependencies aeson (>=0.8), base (>=4.6 && <5), exceptions (>=0.6), path-pieces (>=0.1.5), persistent (>=2.0), text (>=1.0) [details]
License BSD-3-Clause
Author Mark Karpov <>
Maintainer Mark Karpov <>
Category Web, Yesod
Home page
Bug tracker
Source repo head: git clone
Uploaded by mrkkrp at Wed Apr 6 13:21:37 UTC 2016
Distributions NixOS:0.1.7
Downloads 2594 total (73 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2016-11-27 [all 1 reports]





Turn on development settings.


Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info


Maintainer's Corner

For package maintainers and hackage trustees

Readme for slug-0.1.3

[back to package description]


License BSD3 Hackage Stackage Nightly Stackage LTS Build Status Coverage Status

This is slug implementation that plays nicely with Yesod ecosystem. Although it's fairly easy to write this thing, slugs are useful and general enough to be coded once and be used again and again. So this little package eliminates some boilerplate you might find yourself writing.

Quick start

The package provides data type Slug that is instance of various type classes, so it can be used with Persistent or as part of route. It also works with aeson package.

The slugs are completely type-safe. When you have a Slug, you can be sure that there is a valid slug inside. Valid slug has the following qualities:

  • it's not empty;

  • it consists only of alpha-numeric groups of characters (words) separated by '-' dashes in such a way that entire slug cannot start or end in a dash and also two dashes in a row cannot be found;

  • every character with defined notion of case is lower-cased.

To use the package with persistent models, just import Web.Slug and add it to model file:

  slug Slug

Use it in route file like this:

/post/#Slug PostR GET

In Haskell code, create slugs from Text with mkSlug and extract their textual representation with unSlug. The following property holds:

mkSlug = mkSlug >=> mkSlug . unSlug


Copyright © 2015–2016 Mark Karpov

Distributed under BSD 3 clause license.