https://github.com/globalwebindex/elm-plural-rules

Abstraction for working with pluralization rules
https://github.com/globalwebindex/elm-plural-rules

Last synced: 2 months ago
JSON representation

Abstraction for working with pluralization rules

• Host: GitHub
• URL: https://github.com/globalwebindex/elm-plural-rules
• Owner: GlobalWebIndex
• License: bsd-3-clause
• Created: 2020-04-23T20:47:33.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-12T23:18:38.000Z (6 months ago)
• Last Synced: 2024-08-13T01:56:10.532Z (6 months ago)
• Language: Elm
• Size: 280 KB
• Stars: 9
• Watchers: 34
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# `GlobalWebIndex/elm-plural-rules`

An abstraction for working with pluralization rules.

Based largely on [Unicode Language Plural

Rules](https://unicode-org.github.io/cldr-staging/charts/37/supplemental/language_plural_rules.html).

![Screenshot of English

rules](https://github.com/GlobalWebIndex/elm-plural-rules/raw/master/docs/en.png)

![Screenshot of Czech

rules](https://github.com/GlobalWebIndex/elm-plural-rules/raw/master/docs/cz.png)

(For the description of what the `v = 0` conditions in the above screenshots

mean, look at the [Plural Operand Meanings](http://unicode.org/reports/tr35/tr35-numbers.html#Operands)

table or check the `Plural Operands` section of the `PluralRules` module!)

----

This library helps you arrive at an API like:

```elm

pluralize 1 "message" --> "message"

pluralize 5 "message" --> "messages"

pluralize 1 "man" --> "man"

pluralize 5 "man" --> "men"

pluralize 1 "query" --> "query"

pluralize 5 "query" --> "queries"

```

See the `examples/` folder for how to get there!

There are also helpers for writing pluralization logic for languages not

included in this package. Obviously, there's a lot of languages and each of

those has its own rules for how it pluralizes. Check them

[here!](https://unicode-org.github.io/cldr-staging/charts/37/supplemental/language_plural_rules.html)

## Currently supported Languages

* English

* Czech

* French

* Dutch

## FAQ

### Where do the rules come from?

You're supposed to make your own dictionary of Rules and add words into it as you start using them in the app.

Each language has its own ways of pluralizing words and we've opted out to let you "grow your own dictionary" based on the words you're using in your app, because:

  - it would be impractical for the package to contain a whole dictionary in that given language,

  - and we believe it would be impossible / very impractical to try to implement that behaviour with some kind of function. This is not a NLP package :)

 

See [examples/Pluralize.elm](https://github.com/GlobalWebIndex/elm-plural-rules/blob/master/examples/Pluralize.elm) for how rules for specific words can be created.