testsuite

type Case struct {
	// Name identifies the case in the report. It is required, and unique
	// within its file.
	Name string `yaml:"name"`

	// About is a note for the reader -- an issue number, or what the case is
	// really pinning down. Never asserted on.
	About string `yaml:"about"`

	// Input is the document to lint.
	Input string `yaml:"input"`

	// Format is the extension Input is read as, with or without the dot.
	// Defaults to `md`.
	Format string `yaml:"format"`

	// View names a View, found under a search path's `config/views`, to
	// read Input through. An isolated case loads nothing from the project's
	// configuration, and that includes the View that gives a rule its scope:
	// a rule scoped to `subject` sees no subject without one. With it, the
	// case runs the way the project's section would run it, and the cases
	// of a View's rules can live beside them.
	View string `yaml:"view"`

	// Rule isolates the case to a single rule, named by a path relative to the
	// test file. Nothing else is loaded -- not the rest of the style, not the
	// project's configuration -- so the case says exactly what the rule does
	// and nothing about what a run would surface.
	//
	// Without it, the case is linted by the configuration a `vale` run in this
	// directory would use, which is what tells you whether the rule reaches
	// real documents at all.
	Rule string `yaml:"rule"`

	// Want is the exact output expected, Contains excerpts of it, and Absent
	// what must not appear. Want is a pointer so that an empty block asserts
	// "no alerts at all" rather than going unset.
	Want     *string `yaml:"want"`
	Contains Strings `yaml:"contains"`
	Absent   Strings `yaml:"absent"`

	// Path is the file this case was read from.
	Path string `yaml:"-"`
}

type Line struct {
	Op   Op
	Text string
}

type Op byte

type Result struct {
	Case Case

	// Got is the alert output, one `line:col:check:message` per line. There is
	// no path: the document was a string.
	Got string

	// Reason says what went wrong, and is empty when the case passed. Err is
	// set instead when the case could not be run at all -- a rule that does
	// not compile is not a failing assertion.
	Reason string
	Err    error
}

type Runner struct {

	// Install puts packages into a StylesPath the way `vale sync` does. With
	// it, a package's own `Packages` are installed for its isolated cases, so
	// a rule that extends Std resolves without a synced project.
	Install func(pkgs []string, styles string) error
	// contains filtered or unexported fields
}

type Strings []string