rules

type Analyzer struct {
	// contains filtered or unexported fields
}

type AnalyzerConfig struct {
	CELEnvOptions      []cel.EnvOption // Optional custom CEL environment options, replacing the default.
	CELExpressionCache eval.Cache      // Optional expression cache: ideally it should cover the expected expressions.

	// DisableGitIgnore disables handling of .gitignore and .git/info/exclude files.
	//
	// The IgnoreDirs setting will still be respected, and certain directories will
	// always be ignored (namely .git and node_modules). Rules that implement the
	// Ignorer interface will also still be respected.
	DisableGitIgnore bool

	IgnoreDirs []string // Additional directory ignore rules, using git's exclude syntax.

	DisableMetadata bool // Skip calculating or reporting rule metadata.
}

type Ignorer interface {
	GetIgnores() []string
}

type Match struct {
	Result string
	Maybe  bool
	Err    error
	Rules  []RuleSpec
}

type Report struct {
	Ruleset string `json:"ruleset,omitempty"`
	Path    string `json:"path,omitempty"`

	Result string   `json:"result,omitempty"`
	Error  string   `json:"error,omitempty"`
	Rules  []string `json:"rules,omitempty"`

	Maybe bool `json:"maybe,omitempty"`

	Groups    []string               `json:"groups,omitempty"`
	ReadFiles []string               `json:"read_files,omitempty"`
	With      map[string]ReportValue `json:"with,omitempty"`
}

type ReportValue struct {
	Value any    `json:"value,omitempty"`
	Error string `json:"error,omitempty"`
}

type Rule struct {
	Name string `yaml:"name,omitempty"`

	When  string           `yaml:"when"`
	Then  YAMLListOrString `yaml:"then"`
	Maybe YAMLListOrString `yaml:"maybe"`

	With map[string]string `yaml:"with"`

	Group     string           `yaml:"group"`
	GroupList YAMLListOrString `yaml:"groups"`

	Ignore YAMLListOrString `yaml:"ignore"`

	ReadFiles []string `yaml:"read_files"`
}

type RuleSpec interface {
	GetName() string
	GetCondition() string
	GetResults() []string
}

type Ruleset struct {
	Name  string     `yaml:"name,omitempty"`
	Rules []RuleSpec `yaml:"rules"`
}

type RulesetSpec interface {
	GetName() string
	GetRules() []RuleSpec
}

type WithGroups interface {
	GetGroups() []string
}

type WithMaybeResults interface {
	GetMaybeResults() []string
}

type WithMetadata interface {
	GetMetadata() map[string]string
}

type WithReadFiles interface {
	GetReadFiles() []string
}

type YAMLListOrString []string