rules

type Filter struct {
	Type   *phpdoc.Type
	Pure   bool
	Regexp *regexp.Regexp
}

type Parser struct{}

type Rule struct {
	// Name tells whether this rule causes critical report.
	Name string

	// Matcher is an object that is used to check whether a given AST node
	// should trigger a warning that is associated with rule.
	Matcher *phpgrep.Matcher

	// Level is a severity level that is used during report generation.
	Level int

	// StrictSyntax determines whether phpgrep fuzzy search should not be used.
	StrictSyntax bool

	// Message is a report text that is printed when this rule matches.
	Message string

	// Fix is a quickfix template.
	Fix string

	// Location is a phpgrep variable name that should be used as a warning location.
	// WithDeprecationNote string selects the root node.
	Location string

	// Path is a filter-like rule switcher.
	// A rule is only applied to a file that contains a Path as a substring in its name.
	Path string

	// PathExcludes is a filter-like rule switcher.
	// A rule is not applied to a file that contains a PathExcludes as a substring in its name.
	PathExcludes map[string]bool

	// Filters is a list of OR-connected filter sets.
	// Every filter set is a mapping of phpgrep variable to a filter.
	Filters []map[string]Filter
	// contains filtered or unexported fields
}

type RuleDoc struct {
	Comment  string
	Before   string
	After    string
	Fix      bool
	Extends  bool
	Disabled bool
}

type ScopedSet struct {
	RulesByKind [ir.NumKinds][]Rule
	CountRules  int
}

type Set struct {
	Any     *ScopedSet // Anywhere
	Root    *ScopedSet // Only outside of functions
	Local   *ScopedSet // Only inside functions
	Builtin bool       // Whether this is a NoVerify builtin rule set

	Names     []string // All rule names
	DocByName map[string]RuleDoc
}