config

Documentation

Index

• type Config
  • func DefaultConfig() *Config
  • func WithOptions(options ...Option) *Config
  • func (c Config) Violates(match string) bool
• type Option
  • func WithAbbrs(abbrs string) Option
  • func WithIgnoreAbbrs(abbrs string) Option

Types

type Config

type Config struct {
	IgnoreAbbrs []string
	Abbrs       []string
}

func DefaultConfig

func DefaultConfig() *Config

func WithOptions

func WithOptions(options ...Option) *Config

func (Config) Violates

func (c Config) Violates(match string) bool

Violates checks if the passed string value exists in the forbidden list of abbreviations If the string exists in the list, and is not lowercase or uppercase, throws false

type Option

type Option func(config *Config)

func WithAbbrs

func WithAbbrs(abbrs string) Option

func WithIgnoreAbbrs

func WithIgnoreAbbrs(abbrs string) Option