rule

package
v2.2.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 15, 2024 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Rules = map[string]Rule{
	"lowercase": RulesIndex["lowercase"],
	"regex":     RulesIndex["regex"],

	"camelcase": RulesIndex["camelcase"],
	"camelCase": RulesIndex["camelcase"],

	"pascalcase": RulesIndex["pascalcase"],
	"PascalCase": RulesIndex["pascalcase"],

	"snakecase":  RulesIndex["snakecase"],
	"snake_case": RulesIndex["snakecase"],

	"screamingsnakecase":   RulesIndex["screamingsnakecase"],
	"SCREAMING_SNAKE_CASE": RulesIndex["screamingsnakecase"],

	"kebabcase":  RulesIndex["kebabcase"],
	"kebab-case": RulesIndex["kebabcase"],

	"pointcase":  RulesIndex["pointcase"],
	"point.case": RulesIndex["pointcase"],
}
View Source 
var RulesIndex = map[string]Rule{
	"lowercase": new(Lowercase).Init(),
	"regex":     new(Regex).Init(),

	"camelcase":          new(CamelCase).Init(),
	"pascalcase":         new(PascalCase).Init(),
	"snakecase":          new(SnakeCase).Init(),
	"screamingsnakecase": new(ScreamingSnakeCase).Init(),
	"kebabcase":          new(KebabCase).Init(),
	"pointcase":          new(PointCase).Init(),
}

Functions

This section is empty.

Types

type CamelCase 

type CamelCase struct {
	Name string
	*sync.RWMutex
}

func (*CamelCase) GetErrorMessage 

func (rule *CamelCase) GetErrorMessage() string

func (*CamelCase) GetName 

func (rule *CamelCase) GetName() string

func (*CamelCase) GetParameters added in v2.2.0 

func (rule *CamelCase) GetParameters() []string

func (*CamelCase) Init 

func (rule *CamelCase) Init() Rule

func (*CamelCase) SetParameters 

func (rule *CamelCase) SetParameters(params []string) error

func (*CamelCase) Validate 

func (rule *CamelCase) Validate(value string) (bool, error)

Validate checks if string is camel case false if rune is no letter and no digit

type Error 

type Error struct {
	Path  string
	Rules []Rule
	*sync.RWMutex
}

func (*Error) GetPath 

func (error *Error) GetPath() string

func (*Error) GetRules 

func (error *Error) GetRules() []Rule

type KebabCase 

type KebabCase struct {
	Name string
	*sync.RWMutex
}

func (*KebabCase) GetErrorMessage 

func (rule *KebabCase) GetErrorMessage() string

func (*KebabCase) GetName 

func (rule *KebabCase) GetName() string

func (*KebabCase) GetParameters added in v2.2.0 

func (rule *KebabCase) GetParameters() []string

func (*KebabCase) Init 

func (rule *KebabCase) Init() Rule

func (*KebabCase) SetParameters 

func (rule *KebabCase) SetParameters(params []string) error

func (*KebabCase) Validate 

func (rule *KebabCase) Validate(value string) (bool, error)

Validate checks if string is kebab case false if rune is no lowercase letter, digit or -

type Lowercase 

type Lowercase struct {
	Name string
	*sync.RWMutex
}

func (*Lowercase) GetErrorMessage 

func (rule *Lowercase) GetErrorMessage() string

func (*Lowercase) GetName 

func (rule *Lowercase) GetName() string

func (*Lowercase) GetParameters added in v2.2.0 

func (rule *Lowercase) GetParameters() []string

func (*Lowercase) Init 

func (rule *Lowercase) Init() Rule

func (*Lowercase) SetParameters 

func (rule *Lowercase) SetParameters(params []string) error

func (*Lowercase) Validate 

func (rule *Lowercase) Validate(value string) (bool, error)

Validate checks if every letter is lower

type PascalCase 

type PascalCase struct {
	Name string
	*sync.RWMutex
}

func (*PascalCase) GetErrorMessage 

func (rule *PascalCase) GetErrorMessage() string

func (*PascalCase) GetName 

func (rule *PascalCase) GetName() string

func (*PascalCase) GetParameters added in v2.2.0 

func (rule *PascalCase) GetParameters() []string

func (*PascalCase) Init 

func (rule *PascalCase) Init() Rule

func (*PascalCase) SetParameters 

func (rule *PascalCase) SetParameters(params []string) error

func (*PascalCase) Validate 

func (rule *PascalCase) Validate(value string) (bool, error)

Validate checks if string is pascal case false if rune is no letter and no digit false if first rune is not upper

type PointCase 

type PointCase struct {
	Name string
	*sync.RWMutex
}

func (*PointCase) GetErrorMessage 

func (rule *PointCase) GetErrorMessage() string

func (*PointCase) GetName 

func (rule *PointCase) GetName() string

func (*PointCase) GetParameters added in v2.2.0 

func (rule *PointCase) GetParameters() []string

func (*PointCase) Init 

func (rule *PointCase) Init() Rule

func (*PointCase) SetParameters 

func (rule *PointCase) SetParameters(params []string) error

func (*PointCase) Validate 

func (rule *PointCase) Validate(value string) (bool, error)

Validate checks if string is "point case" false if rune is no lowercase letter, digit or .

type Regex 

type Regex struct {
	Name         string
	RegexPattern string
	*sync.RWMutex
}

func (*Regex) GetErrorMessage 

func (rule *Regex) GetErrorMessage() string

func (*Regex) GetName 

func (rule *Regex) GetName() string

func (*Regex) GetParameters added in v2.2.0 

func (rule *Regex) GetParameters() []string

func (*Regex) Init 

func (rule *Regex) Init() Rule

func (*Regex) SetParameters 

func (rule *Regex) SetParameters(params []string) error

0 = regex pattern

func (*Regex) Validate 

func (rule *Regex) Validate(value string) (bool, error)

Validate checks if full string matches regex

type Rule 

type Rule interface {
	Init() Rule
	GetName() string
	SetParameters(params []string) error
	GetParameters() []string
	Validate(value string) (bool, error)
	GetErrorMessage() string
}

type ScreamingSnakeCase 

type ScreamingSnakeCase struct {
	Name string
	*sync.RWMutex
}

func (*ScreamingSnakeCase) GetErrorMessage 

func (rule *ScreamingSnakeCase) GetErrorMessage() string

func (*ScreamingSnakeCase) GetName 

func (rule *ScreamingSnakeCase) GetName() string

func (*ScreamingSnakeCase) GetParameters added in v2.2.0 

func (rule *ScreamingSnakeCase) GetParameters() []string

func (*ScreamingSnakeCase) Init 

func (rule *ScreamingSnakeCase) Init() Rule

func (*ScreamingSnakeCase) SetParameters 

func (rule *ScreamingSnakeCase) SetParameters(params []string) error

func (*ScreamingSnakeCase) Validate 

func (rule *ScreamingSnakeCase) Validate(value string) (bool, error)

Validate checks if string is screaming sneak case false if rune is no uppercase letter, digit or _

type SnakeCase 

type SnakeCase struct {
	Name string
	*sync.RWMutex
}

func (*SnakeCase) GetErrorMessage 

func (rule *SnakeCase) GetErrorMessage() string

func (*SnakeCase) GetName 

func (rule *SnakeCase) GetName() string

func (*SnakeCase) GetParameters added in v2.2.0 

func (rule *SnakeCase) GetParameters() []string

func (*SnakeCase) Init 

func (rule *SnakeCase) Init() Rule

func (*SnakeCase) SetParameters 

func (rule *SnakeCase) SetParameters(params []string) error

func (*SnakeCase) Validate 

func (rule *SnakeCase) Validate(value string) (bool, error)

Validate checks if string is sneak case false if rune is no lowercase letter, digit or _

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.