@hackage countable-inflections0.0.1

Countable Text Inflections

Countable Inflections

License MIT Hackage Stackage LTS ![Build Status](https://circleci.com/gh/tippenein/countable-inflections.svg?style=shield&circle-token=)

This library implements pluralization and singularization in a similar way to the rails inflectors

It uses regexes to define the non-standard transformations and therefore doesn't provide much safety. If you need to provide the same pluralization and singularization which rails does out of the box, this will work the same. If you want more you should be using inflections-hs which uses megaparsec to give you more guarantees

Usage

λ: pluralize "person"
"people"

λ: singularize "branches"
"branch"

These can also be given custom inflection matchers

λ: :t singularizeWith
[Inflection] -> Text -> Text

There are 3 different types of transformations:

Match (takes a PCRE regex and a replacement string)

λ: :t makeMatchMapping
[(RegexPattern, RegexReplace)] -> [Inflection]

λ: let mapping = makeMatchMapping [("(octop)us", "\1i")]
λ: pluralizeWith mapping "octopus"
"octopi"

Irregular (from singular to plural with no greater pattern)

λ: :t makeIrregularMapping
[(Singular, Plural)] -> [Inflection]

λ: let mapping = makeIrregularMapping [("zombie","zombies")]
λ: pluralizeWith mapping "zombie"
"zombies"

Uncountable (doesn't have a mapping, word stays the same) so it has the type:

[Text] -> [Inflection]

License

MIT - see the LICENSE file.