package transform

import "github.com/jdkato/prose/transform"

Package transform implements functions to manipulate UTF-8 encoded strings.

Index ¶

• func Camel(s string) string
• func Constant(s string) string
• func Dash(s string) string
• func Dot(s string) string
• func Pascal(s string) string
• func Simple(s string) string
• func Snake(s string) string
• type IgnoreFunc
• type TitleConverter
• func NewTitleConverter(style IgnoreFunc) *TitleConverter
• func (tc *TitleConverter) Title(s string) string

Examples ¶

• Camel
• Constant
• Dash
• Dot
• NewTitleConverter
• Pascal
• Simple
• Snake

Functions ¶

func Camel ¶

func Camel(s string) string

Camel returns a Camel-cased copy of the string s.

{
	fmt.Println(Camel("test string"))
	// Output: testString
}

testString

func Constant ¶

func Constant(s string) string

Constant returns a underscore-separated, upper-cased copy of the string s.

{
	fmt.Println(Constant("test string"))
	// Output: TEST_STRING
}

TEST_STRING

func Dash ¶

func Dash(s string) string

Dash returns a dash-separated, lower-cased copy of the string s.

{
	fmt.Println(Dash("test string"))
	// Output: test-string
}

test-string

func Dot ¶

func Dot(s string) string

Dot returns a period-separated, lower-cased copy of the string s.

{
	fmt.Println(Dot("test string"))
	// Output: test.string
}

test.string

func Pascal ¶

func Pascal(s string) string

Pascal returns a Pascal-cased copy of the string s.

{
	fmt.Println(Pascal("test string"))
	// Output: TestString
}

TestString

func Simple ¶

func Simple(s string) string

Simple returns a space-separated, lower-cased copy of the string s.

{
	fmt.Println(Simple("test string"))
	// Output: test string
}

test string

func Snake ¶

func Snake(s string) string

Snake returns a underscore-separated, lower-cased copy of the string s.

{
	fmt.Println(Snake("test string"))
	// Output: test_string
}

test_string

Types ¶

type IgnoreFunc ¶

type IgnoreFunc func(word string, firstOrLast bool) bool

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.

{
	tc := NewTitleConverter(APStyle)
	fmt.Println(tc.Title("the last of the mohicans"))
	// Output: The Last of the Mohicans
}

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.

Source Files ¶

title.go transform.go