pluralise

README

Pluralise for Golang

Pluralise and singularise any word.

A port of blakeembrey/pluralize to golang

Installation

go get -u github.com/UnwrittenFun/pluralise

Usage

import "github.com/UnwrittenFun/pluralise"

pluralise.Pluralise("test") //=> "tests"
pluralise.WithCount("test", 1) //=> "test"
pluralise.WithCount("test", 5) //=> "tests"
pluralise.WithCountInclusive("test", 1) //=> "1 test"
pluralise.WithCountInclusive("test", 5) //=> "5 tests"
pluralise.WithCountInclusive("蘋果", 2) //=> "2 蘋果"

pluralise.Pluralise("regex") //=> "regexes"
pluralise.AddPluralRule("gex$", "gexii")
pluralise.Pluralise("regex") //=> "regexii"

pluralise.Singularise("singles") //=> "single"
pluralise.AddSingularRule("singles$", "singular")
pluralise.Singularise("singles") //=> "singular"

pluralise.Pluralise("irregular") //=> "irregulars"
pluralise.AddIrregularRule("irregular", "regular")
pluralise.Pluralise("irregular") //=> "regular"

pluralise.Pluralise("paper") //=> "papers"
pluralise.AddUncountableRule("paper")
pluralise.Pluralise("paper") //=> "paper"

License

MIT

Documentation

Index

• func AddIrregularRule(single string, plural string)
• func AddPluralRule(pattern string, replacement string)
• func AddSingularRule(pattern string, replacement string)
• func AddUncountableRule(word string)
• func Pluralise(word string) string
• func Singularise(word string) string
• func WithCount(word string, count int) string
• func WithCountInclusive(word string, count int) string

Functions

func AddIrregularRule

func AddIrregularRule(single string, plural string)

AddIrregularRule adds and irregular word definition

func AddPluralRule

func AddPluralRule(pattern string, replacement string)

AddPluralRule adds a pluralisation rule to the collection

func AddSingularRule

func AddSingularRule(pattern string, replacement string)

AddSingularRule adds a singularisation rule to the collection

func AddUncountableRule

func AddUncountableRule(word string)

AddUncountableRule adds an uncountable word rule

func Pluralise

func Pluralise(word string) string

Pluralise pluralises a word

func Singularise

func Singularise(word string) string

Singularise singularises a word

func WithCount

func WithCount(word string, count int) string

WithCount pluralises or singularises a word depending on the count supplied

func WithCountInclusive

func WithCountInclusive(word string, count int) string

WithCountInclusive pluralises or singularises a word depending on the count supplied, prepending the count to the word