output

Documentation

Index

• func CreateReport(w io.Writer, format string, baseDir string, suggestions []*core.Suggestion) error
• type ReportFormat

Functions

func CreateReport

func CreateReport(w io.Writer, format string, baseDir string, suggestions []*core.Suggestion) error

CreateReport generates a report for the reported suggestions into the specified format. The formats currently accepted are: json, yaml, sarif, basic and text.

Types

type ReportFormat

type ReportFormat int

ReportFormat enumerates the output format for reported issues

const (
	// ReportText is the default format that writes to stdout
	ReportText ReportFormat = iota // Plain text format

	// ReportJSON set the output format to json
	ReportJSON // Json format

	// ReportCSV set the output format to csv
	ReportCSV // CSV format

	// ReportJUnitXML set the output format to junit xml
	ReportJUnitXML // JUnit XML format

	// ReportSARIF set the output format to SARIF
	ReportSARIF // SARIF format

	//SonarqubeEffortMinutes effort to fix in minutes
	SonarqubeEffortMinutes = 5
)