config

Documentation

Index

• func FilterIgnoredPaths(paths, ignore []string, checkFileExists bool) ([]string, error)
• func FindConfig(path string) (*os.File, error)
• func FindRegalDirectory(path string) (*os.File, error)
• func ToMap(config Config) map[string]any
• type Category
• type Config
  • func FromMap(confMap map[string]any) (Config, error)
• type ExtraAttributes
• type Ignore
• type Rule
  • func (rule Rule) MarshalJSON() ([]byte, error)
  • func (rule Rule) MarshalYAML() (interface{}, error)
  • func (rule *Rule) UnmarshalJSON(data []byte) error
  • func (rule *Rule) UnmarshalYAML(value *yaml.Node) error

Functions

func FilterIgnoredPaths

func FilterIgnoredPaths(paths, ignore []string, checkFileExists bool) ([]string, error)

func FindConfig

func FindConfig(path string) (*os.File, error)

func FindRegalDirectory

func FindRegalDirectory(path string) (*os.File, error)

FindRegalDirectory searches for a .regal directory first in the directory of path, and if not found, in the parent directory, and if not found, in the parent's parent directory, and so on.

func ToMap

func ToMap(config Config) map[string]any

Types

type Category

type Category map[string]Rule

type Config

type Config struct {
	Rules  map[string]Category `json:"rules"            yaml:"rules"`
	Ignore Ignore              `json:"ignore,omitempty" yaml:"ignore,omitempty"`
}

func FromMap

func FromMap(confMap map[string]any) (Config, error)

type ExtraAttributes

type ExtraAttributes map[string]any

type Ignore

type Ignore struct {
	Files []string `json:"files,omitempty" yaml:"files,omitempty"`
}

type Rule

type Rule struct {
	Level  string
	Ignore Ignore `json:"ignore,omitempty" yaml:"ignore,omitempty"`
	Extra  ExtraAttributes
}

func (Rule) MarshalJSON

func (rule Rule) MarshalJSON() ([]byte, error)

func (Rule) MarshalYAML

func (rule Rule) MarshalYAML() (interface{}, error)

func (*Rule) UnmarshalJSON

func (rule *Rule) UnmarshalJSON(data []byte) error

func (*Rule) UnmarshalYAML

func (rule *Rule) UnmarshalYAML(value *yaml.Node) error