gid

README

gid

gid is a small lib to convert a string to a valid Go identifier.

• checking for keywords and predeclared identifiers
• checking for initialisms

TLDR;

import "github.com/MartyHub/gid"

tok := gid.Default()

tok.ExportID("id") // ID 
tok.ExportID("my_id") // MyID 
tok.ExportID("json_id") // JSONId

tok.UnexportID("ID") // id 
tok.UnexportID("my_id") // myID 
tok.UnexportID("json_id") // jsonID

Documentation

Index

• func Capitalize(s string) string
• type Option
  • func WithDefaultReplacements() Option
  • func WithDefaultReserved() Option
  • func WithReplacement(s string) Option
  • func WithReserved(s string) Option
• type Token
  • func NewToken(class TokenClass, r ...rune) *Token
  • func (tok *Token) Append(r rune)
  • func (tok *Token) Pop() rune
  • func (tok *Token) Valid() bool
• type TokenClass
• type Tokenizer
  • func Default() Tokenizer
  • func New(opts ...Option) Tokenizer
  • func (tokenizer Tokenizer) ExportID(s string) string
  • func (tokenizer Tokenizer) ToCamel(s string, export bool) string
  • func (tokenizer Tokenizer) Tokens(s string) []*Token
  • func (tokenizer Tokenizer) UnexportID(s string) string

Functions

func Capitalize

func Capitalize(s string) string

Types

type Option

type Option func(Tokenizer)

func WithDefaultReplacements

func WithDefaultReplacements() Option

func WithDefaultReserved

func WithDefaultReserved() Option

func WithReplacement

func WithReplacement(s string) Option

func WithReserved

func WithReserved(s string) Option

type Token

type Token struct {
	Class TokenClass
	Runes []rune
}

func NewToken

func NewToken(class TokenClass, r ...rune) *Token

func (*Token) Append

func (tok *Token) Append(r rune)

func (*Token) Pop

func (tok *Token) Pop() rune

func (*Token) Valid

func (tok *Token) Valid() bool

type TokenClass

type TokenClass int

const (
	ClassOther TokenClass = iota
	ClassLowerCase
	ClassUpperCase
	ClassDigit
)

type Tokenizer

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

func Default

func Default() Tokenizer

func New

func New(opts ...Option) Tokenizer

func (Tokenizer) ExportID

func (tokenizer Tokenizer) ExportID(s string) string

func (Tokenizer) ToCamel

func (tokenizer Tokenizer) ToCamel(s string, export bool) string

func (Tokenizer) Tokens

func (tokenizer Tokenizer) Tokens(s string) []*Token

func (Tokenizer) UnexportID

func (tokenizer Tokenizer) UnexportID(s string) string