strs

Documentation

Overview

Package strs contains common string manipulation functionality.

Index

• func IsLowerCase(s string) bool
• func IsLowerSnakeCase(s string) bool
• func IsUpperCamelCase(s string) bool
• func IsUpperSnakeCase(s string) bool
• func SplitCamelCaseWord(s string) []string
• func SplitSnakeCaseWord(s string) []string
• type PluralizeClient
  • func NewPluralizeClient() *PluralizeClient
  • func (c *PluralizeClient) AddIrregularRule(single string, plural string)
  • func (c *PluralizeClient) AddPluralRule(rule string, replacement string)
  • func (c *PluralizeClient) AddSingularRule(rule string, replacement string)
  • func (c *PluralizeClient) AddUncountableRule(word string)
  • func (c *PluralizeClient) ToPlural(s string) string

Functions

func IsLowerCase

func IsLowerCase(s string) bool

IsLowerCase returns true if s only contain characters in the range a-z0-9.

func IsLowerSnakeCase

func IsLowerSnakeCase(s string) bool

IsLowerSnakeCase returns true if s only contains lowercase letters, digits, and/or underscores. s MUST NOT begin or end with an underscore.

func IsUpperCamelCase

func IsUpperCamelCase(s string) bool

IsUpperCamelCase returns true if s is not empty and is camel case with an initial capital.

func IsUpperSnakeCase

func IsUpperSnakeCase(s string) bool

IsUpperSnakeCase returns true if s only contains uppercase letters, digits, and/or underscores. s MUST NOT begin or end with an underscore.

func SplitCamelCaseWord

func SplitCamelCaseWord(s string) []string

SplitCamelCaseWord splits a CamelCase word into its parts.

If s is empty, returns nil. If s is not CamelCase, returns nil.

func SplitSnakeCaseWord

func SplitSnakeCaseWord(s string) []string

SplitSnakeCaseWord splits a snake_case word into its parts.

If s is empty, returns nil. If s is not snake_case, returns nil.

Types

type PluralizeClient

type PluralizeClient struct {
	// contains filtered or unexported fields
}

PluralizeClient represents a client to support a pluralization.

func NewPluralizeClient

func NewPluralizeClient() *PluralizeClient

NewPluralizeClient creates a new client.

func (*PluralizeClient) AddIrregularRule

func (c *PluralizeClient) AddIrregularRule(single string, plural string)

AddIrregularRule adds an irregular word definition.

func (*PluralizeClient) AddPluralRule

func (c *PluralizeClient) AddPluralRule(rule string, replacement string)

AddPluralRule adds a pluralization rule to the collection.

func (*PluralizeClient) AddSingularRule

func (c *PluralizeClient) AddSingularRule(rule string, replacement string)

AddSingularRule adds a singularization rule to the collection.

func (*PluralizeClient) AddUncountableRule

func (c *PluralizeClient) AddUncountableRule(word string)

AddUncountableRule adds an uncountable word rule.

func (*PluralizeClient) ToPlural

func (c *PluralizeClient) ToPlural(s string) string

ToPlural converts the given string to its plural name.