README
¶
inflect
A package to pluralize words.
Originally forked from https://bitbucket.org/pkg/inflect under a MIT License.
Status
API is stable.
This library is not used at all by other go-openapi packages and is somewhat redundant with go-openapi/swag/mangling (for camelcase etc).
Currently we have one single dependency in one place in a go-swagger template (used as a funcmap).
Import this library in your project
go get github.com/go-openapi/inflect
Basic usage
A golang library applying grammar rules to English words.
This package provides a basic set of functions applying grammar rules to inflect English words, modify case style (Capitalize, camelCase, snake_case, etc.).
Acronyms are properly handled. A common use case is word pluralization.
Change log
See https://github.com/go-openapi/inflect/releases
Licensing
This library ships under the SPDX-License-Identifier: Apache-2.0.
See the license NOTICE, which recalls the licensing terms of all the pieces of software on top of which it has been built.
Other documentation
Cutting a new release
Maintainers can cut a new release by either:
- running this workflow
- or pushing a semver tag
- signed tags are preferred
- The tag message is prepended to release notes
Documentation
¶
Index ¶
- func AddAcronym(word string)
- func AddHuman(suffix, replacement string)
- func AddIrregular(singular, plural string)
- func AddPlural(suffix, replacement string)
- func AddSingular(suffix, replacement string)
- func AddUncountable(word string)
- func Asciify(word string) string
- func Camelize(word string) string
- func CamelizeDownFirst(word string) string
- func Capitalize(word string) string
- func Dasherize(word string) string
- func ForeignKey(word string) string
- func ForeignKeyCondensed(word string) string
- func Humanize(word string) string
- func Ordinalize(word string) string
- func Parameterize(word string) string
- func ParameterizeJoin(word, sep string) string
- func Pluralize(word string) string
- func Singularize(word string) string
- func Tableize(word string) string
- func Titleize(word string) string
- func Typeify(word string) string
- func Uncountables() map[string]bool
- func Underscore(word string) string
- type Rule
- type Ruleset
- func (rs *Ruleset) AddAcronym(word string)
- func (rs *Ruleset) AddHuman(suffix, replacement string)
- func (rs *Ruleset) AddIrregular(singular, plural string)
- func (rs *Ruleset) AddPlural(suffix, replacement string)
- func (rs *Ruleset) AddPluralExact(suffix, replacement string, exact bool)
- func (rs *Ruleset) AddSingular(suffix, replacement string)
- func (rs *Ruleset) AddSingularExact(suffix, replacement string, exact bool)
- func (rs *Ruleset) AddUncountable(word string)
- func (rs *Ruleset) Asciify(word string) string
- func (rs *Ruleset) Camelize(word string) string
- func (rs *Ruleset) CamelizeDownFirst(word string) string
- func (rs *Ruleset) Capitalize(word string) string
- func (rs *Ruleset) Dasherize(word string) string
- func (rs *Ruleset) ForeignKey(word string) string
- func (rs *Ruleset) ForeignKeyCondensed(word string) string
- func (rs *Ruleset) Humanize(word string) string
- func (rs *Ruleset) Ordinalize(str string) string
- func (rs *Ruleset) Parameterize(word string) string
- func (rs *Ruleset) ParameterizeJoin(word, sep string) string
- func (rs *Ruleset) Pluralize(word string) string
- func (rs *Ruleset) Singularize(word string) string
- func (rs *Ruleset) Tableize(word string) string
- func (rs *Ruleset) Titleize(word string) string
- func (rs *Ruleset) Typeify(word string) string
- func (rs *Ruleset) Uncountables() map[string]bool
- func (rs *Ruleset) Underscore(word string) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddAcronym ¶
func AddAcronym(word string)
func AddIrregular ¶
func AddIrregular(singular, plural string)
func AddSingular ¶
func AddSingular(suffix, replacement string)
func AddUncountable ¶
func AddUncountable(word string)
func CamelizeDownFirst ¶
func Capitalize ¶
func ForeignKey ¶
func ForeignKeyCondensed ¶
func Ordinalize ¶
func Parameterize ¶
func ParameterizeJoin ¶
func Singularize ¶
func Uncountables ¶
func Underscore ¶
Types ¶
type Rule ¶
type Rule struct {
// contains filtered or unexported fields
}
Rule is used by rulesets.
type Ruleset ¶
type Ruleset struct {
// contains filtered or unexported fields
}
Ruleset is the config of pluralization rules you can extend the rules with the Add* methods.
func NewDefaultRuleset ¶
func NewDefaultRuleset() *Ruleset
NewDefaultRuleset create a new ruleset and load it with the default set of common English pluralization rules.
func NewRuleset ¶
func NewRuleset() *Ruleset
NewRuleset creates a blank ruleset. Unless you are going to build your own rules from scratch you probably won't need this and can just use the defaultRuleset via the global inflect.* methods.
func (*Ruleset) AddAcronym ¶
AddAcronym is used if you use acronym you may need to add them to the ruleset to prevent Underscored words of things like "HTML" coming out as "h_t_m_l".
func (*Ruleset) AddHuman ¶
AddHuman rules are applied by humanize to show more friendly versions of words.
func (*Ruleset) AddIrregular ¶
AddIrregular adds any inconsistent pluralizing/singularizing rules to the set here.
func (*Ruleset) AddPluralExact ¶
AddPluralExact adds a pluralization rule with full string match.
func (*Ruleset) AddSingular ¶
AddSingular add a singular rule.
func (*Ruleset) AddSingularExact ¶
AddSingularExact same as AddSingular but you can set `exact` to force a full string match.
func (*Ruleset) AddUncountable ¶
AddUncountable adds a word to this ruleset that has the same singular and plural form for example: "rice".
func (*Ruleset) CamelizeDownFirst ¶
CamelizeDownFirst is the same as Camelcase but with first letter downcased.
func (*Ruleset) Capitalize ¶
Capitalize uppercase first character.
func (*Ruleset) ForeignKey ¶
ForeignKey makes an underscored foreign key name: "Person" -> "person_id".
func (*Ruleset) ForeignKeyCondensed ¶
ForeignKeyCondensed makes a foreign key (without an underscore) "Person" -> "personid".
func (*Ruleset) Humanize ¶
Humanize makes the first letter of a sentence capitalized.
Uses custom friendly replacements via AddHuman().
func (*Ruleset) Ordinalize ¶
Ordinalize returns an ordinal: "1031" -> "1031st"
func (*Ruleset) Parameterize ¶
Parameterize makes param safe dasherized names like "my-param".
func (*Ruleset) ParameterizeJoin ¶
ParameterizeJoin makes param safe dasherized names with custom separator.
func (*Ruleset) Singularize ¶
Singularize returns the singular form of a plural word.
func (*Ruleset) Tableize ¶
Tableize makes a rails style pluralized table name: "SuperPerson" -> "super_people".
func (*Ruleset) Titleize ¶
Titleize capitalizes every word in sentence: "hello there" -> "Hello There".
func (*Ruleset) Uncountables ¶
func (*Ruleset) Underscore ¶
Underscore makes a lowercase underscore version: "BigBen" -> "big_ben".
Source Files
