Documentation ¶
Overview ¶
Package transform implements functions to manipulate UTF-8 encoded strings.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Camel ¶ added in v1.1.0
Camel returns a Camel-cased copy of the string s.
Example ¶
fmt.Println(Camel("test string"))
Output: testString
func Constant ¶ added in v1.1.0
Constant returns a underscore-separated, upper-cased copy of the string s.
Example ¶
fmt.Println(Constant("test string"))
Output: TEST_STRING
func Dash ¶ added in v1.1.0
Dash returns a dash-separated, lower-cased copy of the string s.
Example ¶
fmt.Println(Dash("test string"))
Output: test-string
func Dot ¶ added in v1.1.0
Dot returns a period-separated, lower-cased copy of the string s.
Example ¶
fmt.Println(Dot("test string"))
Output: test.string
func Pascal ¶ added in v1.1.0
Pascal returns a Pascal-cased copy of the string s.
Example ¶
fmt.Println(Pascal("test string"))
Output: TestString
Types ¶
type IgnoreFunc ¶
An IgnoreFunc is a TitleConverter callback that decides whether or not the the string word should be capitalized. firstOrLast indicates whether or not word is the first or last word in the given string.
var ( // APStyle states to: // 1. Capitalize the principal words, including prepositions and // conjunctions of four or more letters. // 2. Capitalize an article – the, a, an – or words of fewer than four // letters if it is the first or last word in a title. APStyle IgnoreFunc = optionsAP // ChicagoStyle states to lowercase articles (a, an, the), coordinating // conjunctions (and, but, or, for, nor), and prepositions, regardless of // length, unless they are the first or last word of the title. ChicagoStyle IgnoreFunc = optionsChicago )
type TitleConverter ¶
type TitleConverter struct {
// contains filtered or unexported fields
}
A TitleConverter converts a string to title case according to its style.
func NewTitleConverter ¶
func NewTitleConverter(style IgnoreFunc) *TitleConverter
NewTitleConverter returns a new TitleConverter set to enforce the specified style.
Example ¶
tc := NewTitleConverter(APStyle) fmt.Println(tc.Title("the last of the mohicans"))
Output: The Last of the Mohicans
func (*TitleConverter) Title ¶
func (tc *TitleConverter) Title(s string) string
Title returns a copy of the string s in title case format.