rule

type DeclSpec struct {
	ID         string
	Type       string // required | length | not_equal | match | deny
	Glob       string // optional path scope (doublestar)
	Field      string // for required/length/match/deny
	Fields     []string
	Min, Max   int
	Pattern    string // for match/deny
	SkipDrafts bool
	Severity   Severity
}

type Example struct {
	Bad  string
	Good string
}

type Finding struct {
	Rule     string     `json:"rule"`
	Path     string     `json:"path"`
	Line     int        `json:"line"`
	Col      int        `json:"col"`
	Message  string     `json:"message"`
	Severity Severity   `json:"severity"`
	Safety   FixSafety  `json:"-"`
	DocURL   string     `json:"-"` // documentation URL (built-in rules only)
	Fixes    []TextEdit `json:"-"`
}

type FixSafety int

type Meta struct {
	Name        string
	Title       string            // human-readable display name, shown in the docs
	Description string            // one line, shown by `list`
	Detail      string            // long help, shown by `explain`
	Severity    Severity          // default; config may override
	Formats     []document.Format // which formats this rule applies to
	Safety      FixSafety         // safety of fixes this rule emits
	Example     Example           // optional before/after for the docs page
}

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

type Rule interface {
	Meta() Meta
	Check(doc *document.Document, report func(Finding))
}

type Severity int

type TextEdit struct {
	Start   int
	End     int
	NewText string
}