polylint

type ConfigFile struct {
	Rules   []Rule
	Version string
}

type FileReport struct {
	Path     string
	Ignores  []Ignore
	Rules    []Rule
	Findings []Finding
}

type Finding struct {
	Path      string
	Line      string
	LineIndex int
	LineNo    int
	Rule      Rule
	RuleId    string
}

type Fn struct {
	Type  string
	Scope Scope
	Name  string
	Args  []any
	Body  string
}

type Ignore struct {
	Id           string
	Scope        Scope
	SourceLineNo int
	LineNo       int
}

type IncludeRaw struct {
	Path string `yaml:"path"`
	// Hash of the file contents prefixed with the algorithm
	Hash string `yaml:"hash"`
}

type RawConfig struct {
	Version  string
	Includes []IncludeRaw
	Rules    []RawRule
}

type RawFn struct {
	Type  string
	Scope Scope
	Name  string
	Args  []any
	Body  string
}

type RawRule struct {
	Id             string
	Description    string
	Recommendation string
	Severity       string
	Link           string
	IncludePaths   *regexp.Regexp `yaml:"include_paths"`
	ExcludePaths   *regexp.Regexp `yaml:"exclude_paths"`
	Fn             RawFn
}

type Rule struct {
	Fn             RuleFunc
	Id             string
	Description    string
	Recommendation string
	Severity       SeverityLevel
	// Link to the documentation for this Rule
	Link string
	// FilenameRegex is the regexp used to determine if this Rule should run on a given file
	IncludePaths *regexp.Regexp
	ExcludePaths *regexp.Regexp
	Scope        Scope
}

type RuleFunc func(string, int, string) bool

type Scope string

type SeverityLevel int