html_report

Documentation

Overview

Copyright 2022 Dave Shanley / Quobix SPDX-License-Identifier: MIT

Index

• Constants
• type HTMLReport
  • func NewHTMLReport(index *index.SpecIndex, info *datamodel.SpecInfo, results *model.RuleResultSet, ...) HTMLReport
• type ReportData

Constants

const MaxViolations = 100

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

Types

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:"-"`
}