Documentation
¶
Overview ¶
Package value provides the transport structures used to unmarshal the config value types like string patterns, integer ranges, etc. from config files and convert them into the matching domain values through their Config methods.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Issue ¶
type Issue struct {
// Level stores the severity level
// of the issue as a string read from the config file.
Level string `yaml:"level,omitempty"`
}
Issue is the transport representation of the issue severity level used by the gitamix linter to report problems.
type Pattern ¶
type Pattern struct {
// Issue stores the transport representation
// of the issue type level associated with the pattern value.
Issue Issue `yaml:"issue,omitempty"`
// Pattern stores the exact string pattern
// in its transport representation.
Pattern string `yaml:"pattern,omitempty"`
}
Pattern is the transport representation of a pattern config value, pairing an exact string pattern with the issue type level used to report violations of the pattern.
type Range ¶
type Range struct {
// Issue stores the transport representation
// of the issue type level associated with the range value.
Issue Issue `yaml:"issue,omitempty"`
// Min stores the lower bound of the interval
// in its transport representation.
Min int `yaml:"min,omitempty"`
// Max stores the upper bound of the interval
// in its transport representation.
Max int `yaml:"max,omitempty"`
}
Range is the transport representation of a range config value, an inclusive [min, max] interval paired with the issue type level used to report violations of the interval.
type Strings ¶
type Strings struct {
// List stores the slice of exact string values
// in its transport representation.
List []string `yaml:"list,omitempty"`
// Issue stores the transport representation
// of the issue type level associated with the list of values.
Issue Issue `yaml:"issue,omitempty"`
}
Strings is the transport representation of a string list config value, pairing a list of exact string values with the issue type level used to report violations of the list.
Source Files