package inflection

Import Path
	github.com/jinzhu/inflection (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	   #d inflections.go
		Package inflection pluralizes and singularizes English nouns.

			inflection.Plural("person") => "people"
			inflection.Plural("Person") => "People"
			inflection.Plural("PERSON") => "PEOPLE"

			inflection.Singular("people") => "person"
			inflection.Singular("People") => "Person"
			inflection.Singular("PEOPLE") => "PERSON"

			inflection.Plural("FancyPerson") => "FancydPeople"
			inflection.Singular("FancyPeople") => "FancydPerson"

		Standard rules are from Rails's ActiveSupport (https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflections.rb)

		If you want to register more rules, follow:

			inflection.AddUncountable("fish")
			inflection.AddIrregular("person", "people")
			inflection.AddPlural("(bu)s$", "${1}ses") # "bus" => "buses" / "BUS" => "BUSES" / "Bus" => "Buses"
			inflection.AddSingular("(bus)(es)?$", "${1}") # "buses" => "bus" / "Buses" => "Bus" / "BUSES" => "BUS"
Package-Level Type Names (total 5, in which 4 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Irregular (struct)
		Irregular is a hard replace inflection,
		containing both singular and plural forms

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			plural string
			singular string

	 type IrregularSlice ([])
		IrregularSlice is a slice of Irregular inflections

		As Outputs Of (at least one exported)
			func GetIrregular() IrregularSlice
		As Inputs Of (at least one exported)
			func SetIrregular(inflections IrregularSlice)
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var irregularInflections

	 type Regular (struct)
		Regular is a regexp find replace inflection

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			find string
			replace string

	 type RegularSlice ([])
		RegularSlice is a slice of Regular inflections

		As Outputs Of (at least 2, both are exported)
			func GetPlural() RegularSlice
			func GetSingular() RegularSlice
		As Inputs Of (at least 2, both are exported)
			func SetPlural(inflections RegularSlice)
			func SetSingular(inflections RegularSlice)
		As Types Of (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			  var pluralInflections
			  var singularInflections

	/* one unexported ... *//* one unexported: */
	 type inflection (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			regexp *regexp.Regexp
			replace string


Package-Level Functions (total 16, in which 14 are exported)

	 func AddIrregular(singular, plural string)
		AddIrregular adds an irregular inflection

	 func AddPlural(find, replace string)
		AddPlural adds a plural inflection

	 func AddSingular(find, replace string)
		AddSingular adds a singular inflection

	 func AddUncountable(values ...string)
		AddUncountable adds an uncountable inflection

	 func GetIrregular() IrregularSlice
		GetIrregular retrieves the irregular inflection values

	 func GetPlural() RegularSlice
		GetPlural retrieves the plural inflection values

	 func GetSingular() RegularSlice
		GetSingular retrieves the singular inflection values

	 func GetUncountable() []string
		GetUncountable retrieves the uncountable inflection values

	 func Plural(str string) string
		Plural converts a word to its plural form

	 func SetIrregular(inflections IrregularSlice)
		SetIrregular sets the irregular inflections slice

	 func SetPlural(inflections RegularSlice)
		SetPlural sets the plural inflections slice

	 func SetSingular(inflections RegularSlice)
		SetSingular sets the singular inflections slice

	 func SetUncountable(inflections []string)
		SetUncountable sets the uncountable inflections slice

	 func Singular(str string) string
		Singular converts a word to its singular form

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func compile()
	 func init()
Package-Level Variables (total 6, none are exported)

	/* 6 unexporteds ... *//* 6 unexporteds: */
	  var compiledPluralMaps []inflection
	  var compiledSingularMaps []inflection
	  var irregularInflections IrregularSlice
	  var pluralInflections RegularSlice
	  var singularInflections RegularSlice
	  var uncountableInflections []string

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)