config

Documentation

Index

• func FilterIgnoredPaths(paths, ignore []string, checkFileExists bool, rootDir string) ([]string, error)
• func FindConfig(path string) (*os.File, error)
• func FindRegalDirectory(path string) (*os.File, error)
• func ToMap(config Config) map[string]any
• type Builtin
• type Capabilities
  • func CapabilitiesForThisVersion() *Capabilities
• type Category
• type Config
  • func FromMap(confMap map[string]any) (Config, error)
  • func (config Config) MarshalYAML() (any, error)
  • func (config *Config) UnmarshalYAML(value *yaml.Node) error
• type Decl
• type Default
• type Defaults
• 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, rootDir string) ([]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 Builtin

type Builtin struct {
	Decl Decl `json:"decl" yaml:"decl"`
}

type Capabilities

type Capabilities struct {
	Builtins       map[string]*Builtin `json:"builtins"        yaml:"builtins"`
	FutureKeywords []string            `json:"future_keywords" yaml:"future_keywords"`
	Features       []string            `json:"features"        yaml:"features"`
}

func CapabilitiesForThisVersion

func CapabilitiesForThisVersion() *Capabilities

CapabilitiesForThisVersion returns the capabilities for the current OPA version Regal depends on.

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"`
	Capabilities *Capabilities       `json:"capabilities,omitempty" yaml:"capabilities,omitempty"`

	// Defaults state is loaded from configuration under rules and so is not (un)marshalled
	// in the same way.
	Defaults Defaults `json:"-" yaml:"-"`
}

func FromMap

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

func (Config) MarshalYAML

func (config Config) MarshalYAML() (any, error)

func (*Config) UnmarshalYAML

func (config *Config) UnmarshalYAML(value *yaml.Node) error

type Decl

type Decl struct {
	Args   []string `json:"args"   yaml:"args"`
	Result string   `json:"result" yaml:"result"`
}

type Default

type Default struct {
	Level string `json:"level" yaml:"level"`
}

Default represents global or category settings for rules, currently only the level is supported.

type Defaults

type Defaults struct {
	Global     Default
	Categories map[string]Default
}

Defaults is used to store information about global and category defaults for rules.

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