format

Documentation

Index

• Variables
• func CreateReportDescription(event *output.ResultEvent, formatter ResultFormatter, omitRaw bool) string
• func CreateTemplateInfoTable(templateInfo *model.Info, formatter ResultFormatter) string
• func GetMatchedTemplateName(event *output.ResultEvent) string
• func Summary(event *output.ResultEvent) string
• type ResultFormatter

Variables

var (
	// ReportGenerationMetadataHooks are the hooks for adding metadata to the report
	ReportGenerationMetadataHooks []reportMetadataEditorHook
)

Functions

func CreateReportDescription

func CreateReportDescription(event *output.ResultEvent, formatter ResultFormatter, omitRaw bool) string

func CreateTemplateInfoTable

func CreateTemplateInfoTable(templateInfo *model.Info, formatter ResultFormatter) string

func GetMatchedTemplateName

func GetMatchedTemplateName(event *output.ResultEvent) string

GetMatchedTemplateName returns the matched template name from a result event together with the found matcher and extractor name, if present

func Summary

func Summary(event *output.ResultEvent) string

Summary returns a formatted built one line summary of the event

Types

type ResultFormatter

type ResultFormatter interface {
	MakeBold(text string) string
	CreateCodeBlock(title string, content string, language string) string
	CreateTable(headers []string, rows [][]string) (string, error)
	CreateLink(title string, url string) string
	CreateHorizontalLine() string
}