inflect

README

This repo has moved

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 NewDefaultRuleset() *Ruleset
  • func NewRuleset() *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

Functions

func AddAcronym

func AddAcronym(word string)

AddAcronym to the default ruleset

func AddHuman

func AddHuman(suffix, replacement string)

AddHuman to the default ruleset

func AddIrregular

func AddIrregular(singular, plural string)

AddIrregular to the default ruleset

func AddPlural

func AddPlural(suffix, replacement string)

AddPlural to the default ruleset

func AddSingular

func AddSingular(suffix, replacement string)

AddSingular to the default ruleset

func AddUncountable

func AddUncountable(word string)

AddUncountable to the default ruleset

func Asciify

func Asciify(word string) string

Asciify word

func Camelize

func Camelize(word string) string

Camelize word

func CamelizeDownFirst

func CamelizeDownFirst(word string) string

CamelizeDownFirst word

func Capitalize

func Capitalize(word string) string

Capitalize word

func Dasherize

func Dasherize(word string) string

Dasherize word

func ForeignKey

func ForeignKey(word string) string

ForeignKey word

func ForeignKeyCondensed

func ForeignKeyCondensed(word string) string

ForeignKeyCondensed word

func Humanize

func Humanize(word string) string

Humanize word

func Ordinalize

func Ordinalize(word string) string

Ordinalize word

func Parameterize

func Parameterize(word string) string

Parameterize word

func ParameterizeJoin

func ParameterizeJoin(word, sep string) string

ParameterizeJoin word using sep

func Pluralize

func Pluralize(word string) string

Pluralize word

func Singularize

func Singularize(word string) string

Singularize word

func Tableize

func Tableize(word string) string

Tableize word

func Titleize

func Titleize(word string) string

Titleize word

func Typeify

func Typeify(word string) string

Typeify word

func Uncountables

func Uncountables() map[string]bool

Uncountables returns the uncountable ruleset

func Underscore

func Underscore(word string) string

Underscore word

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 creates 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

func (rs *Ruleset) AddAcronym(word string)

AddAcronym - 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

func (rs *Ruleset) AddHuman(suffix, replacement string)

AddHuman added rules are applied by humanize to show more friendly versions of words

func (*Ruleset) AddIrregular

func (rs *Ruleset) AddIrregular(singular, plural string)

AddIrregular adds any inconsistant pluralizing/sinularizing rules to the set here.

func (*Ruleset) AddPlural

func (rs *Ruleset) AddPlural(suffix, replacement string)

AddPlural adds a pluralization rule

func (*Ruleset) AddPluralExact

func (rs *Ruleset) AddPluralExact(suffix, replacement string, exact bool)

AddPluralExact adds a pluralization rule with full string match

func (*Ruleset) AddSingular

func (rs *Ruleset) AddSingular(suffix, replacement string)

AddSingular adds a singular rule

func (*Ruleset) AddSingularExact

func (rs *Ruleset) AddSingularExact(suffix, replacement string, exact bool)

AddSingularExact is the same as AddSingular but you can set `exact` to force a full string match

func (*Ruleset) AddUncountable

func (rs *Ruleset) AddUncountable(word string)

AddUncountable adds a word to this ruleset that has the same singular and plural form for example: "rice"

func (*Ruleset) Asciify

func (rs *Ruleset) Asciify(word string) string

Asciify transforms latin characters like é -> e

func (*Ruleset) Camelize

func (rs *Ruleset) Camelize(word string) string

Camelize "dino_party" -> "DinoParty"

func (*Ruleset) CamelizeDownFirst

func (rs *Ruleset) CamelizeDownFirst(word string) string

CamelizeDownFirst is the same as Camelcase but with first letter downcased

func (*Ruleset) Capitalize

func (rs *Ruleset) Capitalize(word string) string

Capitalize will uppercase first character

func (*Ruleset) Dasherize

func (rs *Ruleset) Dasherize(word string) string

Dasherize converts "SomeText" -> "some-text"

func (*Ruleset) ForeignKey

func (rs *Ruleset) ForeignKey(word string) string

ForeignKey returns an underscored foreign key name "Person" -> "person_id"

func (*Ruleset) ForeignKeyCondensed

func (rs *Ruleset) ForeignKeyCondensed(word string) string

ForeignKeyCondensed returns a foreign key (with an underscore) "Person" -> "personid"

func (*Ruleset) Humanize

func (rs *Ruleset) Humanize(word string) string

Humanize converts the first letter of sentence captitilized Uses custom friendly replacements via AddHuman()

func (*Ruleset) Ordinalize

func (rs *Ruleset) Ordinalize(str string) string

Ordinalize converts "1031" -> "1031st"

func (*Ruleset) Parameterize

func (rs *Ruleset) Parameterize(word string) string

Parameterize returns a param safe dasherized names like "my-param"

func (*Ruleset) ParameterizeJoin

func (rs *Ruleset) ParameterizeJoin(word, sep string) string

ParameterizeJoin returns a param safe dasherized names with custom seperator

func (*Ruleset) Pluralize

func (rs *Ruleset) Pluralize(word string) string

Pluralize returns the plural form of a singular word

func (*Ruleset) Singularize

func (rs *Ruleset) Singularize(word string) string

Singularize returns the singular form of a plural word

func (*Ruleset) Tableize

func (rs *Ruleset) Tableize(word string) string

Tableize returns a rails style pluralized table names: "SuperPerson" -> "super_people"

func (*Ruleset) Titleize

func (rs *Ruleset) Titleize(word string) string

Titleize captitilizes every word in sentance "hello there" -> "Hello There"

func (*Ruleset) Typeify

func (rs *Ruleset) Typeify(word string) string

Typeify converts "something_like_this" -> "SomethingLikeThis"

func (*Ruleset) Uncountables

func (rs *Ruleset) Uncountables() map[string]bool

Uncountables returns the uncountables ruleset

func (*Ruleset) Underscore

func (rs *Ruleset) Underscore(word string) string

Underscore returns the lowercase underscore version "BigBen" -> "big_ben"