rules

type BundleRootError struct {
	Root    string
	Docsets []string
}

type Check interface {
	Evaluate(context.Context, Subject) ([]Finding, error)
	OnWrite(context.Context, string, []byte, string) error
	OnRemove(context.Context, string, string) error
	OnMove(context.Context, string, string) error
}

type CompiledRule struct {
	Name    string
	Spec    RuleSpec
	Origins []string
	Scope   string
	Member  Member
	Check   Check
}

type Defaults struct {
	Growth float64
}

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

type Env struct {
	Defaults  Defaults
	State     packagestate.Store
	Tokenizer tokenizer.Tokenizer
	Logger    *slog.Logger
	// AliasRoots contains configured docset aliases, longest first.
	AliasRoots []string
}

type FileConfig struct {
	Version    int                 `yaml:"version"`
	Rules      map[string]RuleSpec `yaml:"rules,omitempty"`
	Packages   map[string]any      `yaml:"packages,omitempty"`
	Hooks      map[string]any      `yaml:"hooks,omitempty"`
	Operations map[string]any      `yaml:"operations,omitempty"`
}

type Finding struct {
	Code   string
	Path   string
	Line   int
	Column int
	// Warning never rejects a write and remains a warning during validation,
	// even when its enclosing rule is enforcing.
	Warning  bool
	Measured string
	Limit    string
	Remedy   string
	Override string
}

type FolderLayerSource interface {
	LayersForDir(context.Context, string) ([]Layer, error)
	LayersAbove(context.Context, string) ([]Layer, error)
	Invalidate(string)
}

type Kind string

type Layer struct {
	Origin string
	Scope  string
	Rules  map[string]RuleSpec
}

type LayerSource interface {
	LayersFor(context.Context, string) ([]Layer, error)
}

type Manifest struct {
	Path    string
	Kind    Kind
	Scope   Scope
	Summary string
	Doc     string
	Params  []Param
	Example string
}

type Member interface {
	Manifest() Manifest
	Compile(with map[string]any, env Env) (Check, error)
}

type Mode int

type Options struct {
	Registry *Registry
	Config   LayerSource
	Folders  FolderLayerSource
	Env      func(string) Env
	Logger   *slog.Logger
}

type Param struct {
	Name     string
	Type     ParamType
	Required bool
	Default  any
	Doc      string
}

type ParamType string

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

type Rejection struct {
	Path     string
	Rule     string
	Member   string
	Origin   string
	Findings []Finding
	Err      error
}

type RuleSpec struct {
	Match   []string       `yaml:"match" json:"match"`
	Exclude []string       `yaml:"exclude,omitempty" json:"exclude,omitempty"`
	Use     string         `yaml:"use" json:"use"`
	With    map[string]any `yaml:"with,omitempty" json:"with,omitempty"`
	Enforce *bool          `yaml:"enforce,omitempty" json:"enforce,omitempty"`
	Default bool           `yaml:"default,omitempty" json:"default,omitempty"`
}

type Scope string

type Subject struct {
	Mode       Mode
	Path       string
	Dir        string
	Content    []byte
	Existing   func() ([]byte, bool, error)
	Commit     string
	Actor      string
	FS         vfs.FileSystem
	BundleRoot string
	Bundle     *validation.Bundle
}

type UnificationError struct {
	Rule          string
	OuterOrigin   string
	InnerOrigin   string
	DifferingKeys []string
}

type UnifiedRule struct {
	Spec    RuleSpec
	Origins []string
	Scope   string
}