printers

Documentation

Index

• type Checkstyle
  • func NewCheckstyle(log logutils.Log, w io.Writer) *Checkstyle
  • func (p *Checkstyle) Print(issues []result.Issue) error
• type CodeClimate
  • func NewCodeClimate(log logutils.Log, w io.Writer) *CodeClimate
  • func (p *CodeClimate) Print(issues []result.Issue) error
• type GitHubAction
  • func NewGitHubAction(w io.Writer) *GitHubAction
  • func (p *GitHubAction) Print(issues []result.Issue) error
• type HTML
  • func NewHTML(w io.Writer) *HTML
  • func (p HTML) Print(issues []result.Issue) error
• type InspectionInstance
  • func (i InspectionInstance) Print(w io.Writer, replacer *strings.Replacer) (int, error)
• type InspectionType
  • func (i InspectionType) Print(w io.Writer, escaper *strings.Replacer) (int, error)
• type JSON
  • func NewJSON(w io.Writer, rd *report.Data) *JSON
  • func (p JSON) Print(issues []result.Issue) error
• type JSONResult
• type JUnitXML
  • func NewJUnitXML(w io.Writer, extended bool) *JUnitXML
  • func (p JUnitXML) Print(issues []result.Issue) error
• type Printer
  • func NewPrinter(log logutils.Log, cfg *config.Output, reportData *report.Data, basePath string) (*Printer, error)
  • func (c *Printer) Print(issues []result.Issue) error
• type Sarif
  • func NewSarif(log logutils.Log, w io.Writer) *Sarif
  • func (p *Sarif) Print(issues []result.Issue) error
• type SarifOutput
• type Tab
  • func NewTab(log logutils.Log, w io.Writer, printLinterName, useColors bool) *Tab
  • func (p *Tab) Print(issues []result.Issue) error
  • func (p *Tab) SprintfColored(ca color.Attribute, format string, args ...any) string
• type TeamCity
  • func NewTeamCity(log logutils.Log, w io.Writer) *TeamCity
  • func (p *TeamCity) Print(issues []result.Issue) error
• type Text
  • func NewText(log logutils.Log, w io.Writer, ...) *Text
  • func (p *Text) Print(issues []result.Issue) error
  • func (p *Text) SprintfColored(ca color.Attribute, format string, args ...any) string

Types

type Checkstyle

type Checkstyle struct {
	// contains filtered or unexported fields
}

Checkstyle prints issues in the Checkstyle format. https://checkstyle.org/config.html

func NewCheckstyle

func NewCheckstyle(log logutils.Log, w io.Writer) *Checkstyle

func (*Checkstyle) Print

func (p *Checkstyle) Print(issues []result.Issue) error

type CodeClimate

type CodeClimate struct {
	// contains filtered or unexported fields
}

CodeClimate prints issues in the Code Climate format. https://github.com/codeclimate/platform/blob/HEAD/spec/analyzers/SPEC.md

func NewCodeClimate

func NewCodeClimate(log logutils.Log, w io.Writer) *CodeClimate

func (*CodeClimate) Print

func (p *CodeClimate) Print(issues []result.Issue) error

type GitHubAction

type GitHubAction struct {
	// contains filtered or unexported fields
}

func NewGitHubAction

func NewGitHubAction(w io.Writer) *GitHubAction

NewGitHubAction output format outputs issues according to GitHub Action. Deprecated

func (*GitHubAction) Print

func (p *GitHubAction) Print(issues []result.Issue) error

type HTML

type HTML struct {
	// contains filtered or unexported fields
}

HTML prints issues in an HTML page. It uses the Cloudflare CDN (cdnjs) and React.

func NewHTML

func NewHTML(w io.Writer) *HTML

func (HTML) Print

func (p HTML) Print(issues []result.Issue) error

type InspectionInstance

type InspectionInstance struct {
	// contains filtered or unexported fields
}

InspectionInstance reports a specific defect, warning, error message. Includes location, description, and various optional and custom attributes. https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Instance

func (InspectionInstance) Print

func (i InspectionInstance) Print(w io.Writer, replacer *strings.Replacer) (int, error)

type InspectionType

type InspectionType struct {
	// contains filtered or unexported fields
}

InspectionType is the unique description of the conducted inspection. Each specific warning or an error in code (inspection instance) has an inspection type. https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Type

func (InspectionType) Print

func (i InspectionType) Print(w io.Writer, escaper *strings.Replacer) (int, error)

type JSON

type JSON struct {
	// contains filtered or unexported fields
}

JSON prints issues in a JSON representation.

func NewJSON

func NewJSON(w io.Writer, rd *report.Data) *JSON

func (JSON) Print

func (p JSON) Print(issues []result.Issue) error

type JSONResult

type JSONResult struct {
	Issues []result.Issue
	Report *report.Data
}

type JUnitXML

type JUnitXML struct {
	// contains filtered or unexported fields
}

JUnitXML prints issues in the JUnit XML format. There is no official specification for the JUnit XML file format, and various tools generate and support different flavors of this format. https://github.com/testmoapp/junitxml

func NewJUnitXML

func NewJUnitXML(w io.Writer, extended bool) *JUnitXML

func (JUnitXML) Print

func (p JUnitXML) Print(issues []result.Issue) error

type Printer

type Printer struct {
	// contains filtered or unexported fields
}

Printer prints issues

func NewPrinter

func NewPrinter(log logutils.Log, cfg *config.Output, reportData *report.Data, basePath string) (*Printer, error)

NewPrinter creates a new Printer.

func (*Printer) Print

func (c *Printer) Print(issues []result.Issue) error

Print prints issues based on the formats defined

type Sarif

type Sarif struct {
	// contains filtered or unexported fields
}

Sarif prints issues in the SARIF format. https://sarifweb.azurewebsites.net/ https://docs.oasis-open.org/sarif/sarif/v2.1.0/

func NewSarif

func NewSarif(log logutils.Log, w io.Writer) *Sarif

func (*Sarif) Print

func (p *Sarif) Print(issues []result.Issue) error

type SarifOutput

type SarifOutput struct {
	Version string     `json:"version"`
	Schema  string     `json:"$schema"`
	Runs    []sarifRun `json:"runs"`
}

type Tab

type Tab struct {
	// contains filtered or unexported fields
}

Tab prints issues using tabulation as a field separator.

func NewTab

func NewTab(log logutils.Log, w io.Writer, printLinterName, useColors bool) *Tab

func (*Tab) Print

func (p *Tab) Print(issues []result.Issue) error

func (*Tab) SprintfColored

func (p *Tab) SprintfColored(ca color.Attribute, format string, args ...any) string

type TeamCity

type TeamCity struct {
	// contains filtered or unexported fields
}

TeamCity prints issues in the TeamCity format. https://www.jetbrains.com/help/teamcity/service-messages.html

func NewTeamCity

func NewTeamCity(log logutils.Log, w io.Writer) *TeamCity

NewTeamCity output format outputs issues according to TeamCity service message format.

func (*TeamCity) Print

func (p *TeamCity) Print(issues []result.Issue) error

type Text

type Text struct {
	// contains filtered or unexported fields
}

Text prints issues with a human friendly representation.

func NewText

func NewText(log logutils.Log, w io.Writer, printLinterName, printIssuedLine, useColors bool) *Text

func (*Text) Print

func (p *Text) Print(issues []result.Issue) error

func (*Text) SprintfColored

func (p *Text) SprintfColored(ca color.Attribute, format string, args ...any) string