core

type Alert struct {
	Check       string // the name of the check
	Description string // why `Message` is meaningful
	Line        int    // the source line
	Link        string // reference material
	Message     string // the output message
	Severity    string // 'suggestion', 'warning', or 'error'
	Span        []int  // the [begin, end] location within a line
}

type Block struct {
	Context string   // parent content (if any) - e.g., paragraph -> sentence
	Text    string   // text content
	Scope   Selector // section selector
}

type ByPosition []Alert

type File struct {
	Alerts     []Alert         // all alerts associated with this file
	BaseStyles []string        // base style assigned in .vale
	Checks     map[string]bool // syntax-specific checks assigned in .txtint
	Counts     map[string]int  // word counts
	Format     string          // 'code', 'markup' or 'prose'
	NormedExt  string          // the normalized extension (see util/format.go)
	Path       string          // the full path
	RealExt    string          // actual file extension
	Scanner    *bufio.Scanner  // used by lintXXX functions
	Sequences  []string        // tracks various info (e.g., defined abbreviations)
}

type Linter struct{}

type Selector struct {
	Value string // e.g., text.comment.line.py
}