strcase

Documentation

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 CaseConverter
• type CaseOptFunc
  • func UsingIndicator(indicator IndicatorFunc) CaseOptFunc
  • func UsingPrefix(prefix string) CaseOptFunc
  • func UsingVocab(vocab []string) CaseOptFunc
• type CaseOpts
• type IgnoreFunc
• type IndicatorFunc
• type SentenceConverter
  • func NewSentenceConverter(opts ...CaseOptFunc) *SentenceConverter
  • func (sc *SentenceConverter) Convert(s string) string
• type TitleConverter
  • func NewTitleConverter(style IgnoreFunc, opts ...CaseOptFunc) *TitleConverter
  • func (tc *TitleConverter) Convert(s string) string

Functions

func Camel

func Camel(s string) string

func Constant

func Constant(s string) string

func Dash

func Dash(s string) string

func Dot

func Dot(s string) string

func Pascal

func Pascal(s string) string

func Simple

func Simple(s string) string

func Snake

func Snake(s string) string

Types

type CaseConverter

type CaseConverter interface {
	Convert(string) string
}

A CaseConverter converts a string to a specific case.

type CaseOptFunc

type CaseOptFunc func(opts *CaseOpts)

CaseOptFunc is a function that modifies a CaseConverter.

func UsingIndicator

func UsingIndicator(indicator IndicatorFunc) CaseOptFunc

UsingIndicator sets the indicator for the CaseConverter.

func UsingPrefix

func UsingPrefix(prefix string) CaseOptFunc

UsingPrefix sets the prefix for the CaseConverter.

func UsingVocab

func UsingVocab(vocab []string) CaseOptFunc

UsingVocab sets the vocab for the CaseConverter.

type CaseOpts

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

CaseOpts is a struct that holds the options for a CaseConverter.

type IgnoreFunc

type IgnoreFunc func(word string, tags []tag.Token, idx int, 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      IgnoreFunc = optionsAP
	ChicagoStyle IgnoreFunc = optionsChicago
)

type IndicatorFunc

type IndicatorFunc func(word string, idx int) bool

An IndicatorFunc is a SentenceConverter callback that decides whether or not the string word should be capitalized.

type SentenceConverter

type SentenceConverter struct {
	CaseOpts
}

A SentenceConverter converts a string to sentence case.

func NewSentenceConverter

func NewSentenceConverter(opts ...CaseOptFunc) *SentenceConverter

NewSentenceConverter returns a new SentenceConverter.

func (*SentenceConverter) Convert

func (sc *SentenceConverter) Convert(s string) string

Convert returns a copy of the string s in sentence case format.

type TitleConverter

type TitleConverter struct {
	CaseOpts
	// contains filtered or unexported fields
}

A TitleConverter converts a string to title case according to its style.

func NewTitleConverter

func NewTitleConverter(style IgnoreFunc, opts ...CaseOptFunc) *TitleConverter

NewTitleConverter returns a new TitleConverter set to enforce the specified style.

func (*TitleConverter) Convert

func (tc *TitleConverter) Convert(s string) string

Convert returns a copy of the string s in title case format.