render

package

v0.0.1 Latest Latest Go to latest Published: Sep 1, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

This section is empty.

This section is empty.

func Findings(w io.Writer, fs []validate.Finding, format Format) error

Findings writes findings in the chosen format.

func Index(w io.Writer, data IndexData, tmpl string) error

Index renders the index. An empty tmpl uses the embedded default.

type Format int

Format selects an output encoding.

const (
	FormatAuto Format = iota
	FormatTable
	FormatJSON
	FormatJSONL
	FormatPaths
)

func Detect(w io.Writer, flag, cfgDefault string) Format

Detect resolves the output format from an explicit flag, the config default, and whether w is a TTY.

type Group struct {
	Type string
	Docs []model.Doc
}

Group is one type bucket of documents.

type IndexData struct {
	Groups   []Group
	Unmarked []model.Doc
}

IndexData is the template input.

func BuildIndex(docs []model.Doc, s *schema.Schema) IndexData

BuildIndex groups marked docs by type and collects the unmarked ones.