config

Documentation

Index

• func FilterIgnoredPaths(paths, ignore []string, checkFileExists bool, pathPrefix string) ([]string, error)
• func FindBundleRootDirectories(path string) ([]string, error)
• func FindConfig(path string) (*os.File, error)
• func FindRegalDirectory(path string) (*os.File, error)
• func GetPotentialRoots(paths ...string) ([]string, error)
• func GlobalDir() string
• 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 LoadConfigWithDefaultsFromBundle(regalBundle *bundle.Bundle, userConfig *Config) (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 Features
• type Ignore
• type Project
• type RemoteFeatures
• 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, pathPrefix string) ([]string, error)

func FindBundleRootDirectories

func FindBundleRootDirectories(path string) ([]string, error)

FindBundleRootDirectories finds all bundle root directories from the provided path, which **must** be an absolute path. Bundle root directories may be found either by:

- Configuration (`project.roots`) - By the presence of a .manifest file anywhere under the path - By the presence of a .regal directory anywhere under or above the path ...

All returned paths are absolute paths. If the provided path itself is determined to be a bundle root directory it will be included in the result.

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 GetPotentialRoots

func GetPotentialRoots(paths ...string) ([]string, error)

func GlobalDir

func GlobalDir() string

GlobalDir is the config directory that will be used for user-wide configuration. This is different from the .regal directories that are searched for when linting.

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 {
	// Defaults state is loaded from configuration under rules and so is not (un)marshalled
	// in the same way.
	Defaults        Defaults            `json:"-"                          yaml:"-"`
	Rules           map[string]Category `json:"rules"                      yaml:"rules"`
	Capabilities    *Capabilities       `json:"capabilities,omitempty"     yaml:"capabilities,omitempty"`
	Features        *Features           `json:"features,omitempty"         yaml:"features,omitempty"`
	Project         *Project            `json:"project,omitempty"          yaml:"project,omitempty"`
	CapabilitiesURL string              `json:"capabilities_url,omitempty" yaml:"capabilities_url,omitempty"`
	Ignore          Ignore              `json:"ignore,omitempty"           yaml:"ignore,omitempty"`
}

func FromMap

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

func LoadConfigWithDefaultsFromBundle

func LoadConfigWithDefaultsFromBundle(regalBundle *bundle.Bundle, userConfig *Config) (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 {
	Result string   `json:"result" yaml:"result"`
	Args   []string `json:"args"   yaml:"args"`
}

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 {
	Categories map[string]Default
	Global     Default
}

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

type ExtraAttributes

type ExtraAttributes map[string]any

type Features

type Features struct {
	Remote *RemoteFeatures `json:"remote,omitempty" yaml:"remote,omitempty"`
}

type Ignore

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

type Project

type Project struct {
	Roots []string `json:"roots" yaml:"roots"`
}

type RemoteFeatures

type RemoteFeatures struct {
	CheckVersion bool `json:"check-version,omitempty" yaml:"check-version,omitempty"`
}

type Rule

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

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