html_report

package

v0.36.0 Latest Latest Go to latest Published: Oct 29, 2026 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/daveshanley/vacuum

Links

Open Source Insights

Documentation ¶

Overview ¶

Index ¶

Constants
func AssetsAvailable() bool
func WriteExport(w io.Writer, rows []ExportRow) error
type ExportRow
type HTMLReport
- func NewHTMLReport(index *index.SpecIndex, info *datamodel.SpecInfo, results *model.RuleResultSet, ...) HTMLReport
type ReportData

Constants ¶

View Source

const MaxViolations = 100

MaxViolations the maximum number of violations the report will render per broken rule. TODO: make this configurable

Variables ¶

This section is empty.

Functions ¶

func AssetsAvailable ¶ added in v0.25.4

func AssetsAvailable() bool

AssetsAvailable indicates whether the interactive HTML report UI bundles were compiled into this build. Official release builds enable this using the `html_report_ui` build tag.

func WriteExport ¶ added in v0.36.0

func WriteExport(w io.Writer, rows []ExportRow) error

WriteExport writes all findings as a standalone HTML report without UI assets or scripts.

Types ¶

type ExportRow ¶ added in v0.36.0

type ExportRow struct {
	Source, Rule, Message, Severity, Path string
	Line, Column                          int
}

ExportRow contains a complete finding for the standalone HTML export. Line and Column are one-based. All strings are escaped by html/template.

type HTMLReport ¶

type HTMLReport interface {
	GenerateReport(testMode bool, version string) []byte
}

func NewHTMLReport ¶

func NewHTMLReport(
	index *index.SpecIndex,
	info *datamodel.SpecInfo,
	results *model.RuleResultSet,
	stats *reports.ReportStatistics,
	disableTimestamp bool) HTMLReport

type ReportData ¶

type ReportData struct {
	BundledJS        string                    `json:"bundledJS"`
	HydrateJS        string                    `json:"hydrateJS"`
	ShoelaceJS       string                    `json:"shoelaceJS"`
	ReportCSS        string                    `json:"reportCSS"`
	Statistics       *reports.ReportStatistics `json:"reportStatistics"`
	TestMode         bool                      `json:"test"`
	RuleCategories   []*model.RuleCategory     `json:"ruleCategories"`
	RuleResults      *model.RuleResultSet      `json:"ruleResults"`
	MaxViolations    int                       `json:"maxViolations"`
	Generated        time.Time                 `json:"generated"`
	Version          string                    `json:"version"`
	DisableTimestamp bool                      `json:"-"`
	SpecString       []string                  `json:"-"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL