printer

Documentation

Index

• Constants
• Variables
• type Checkstyle
  • func NewCheckstyle(w io.Writer) *Checkstyle
  • func (p *Checkstyle) End()
  • func (p *Checkstyle) Print(fs *result.FileResults) error
  • func (p *Checkstyle) PrintSuccessExitMessage() bool
  • func (p *Checkstyle) Start()
• type Error
• type File
• type GitHubActions
  • func NewGitHubActions(w io.Writer) *GitHubActions
  • func (p *GitHubActions) End()
  • func (p *GitHubActions) Print(fs *result.FileResults) error
  • func (p *GitHubActions) PrintSuccessExitMessage() bool
  • func (p *GitHubActions) Start()
• type Issue
• type JSON
  • func NewJSON(w io.Writer) *JSON
  • func (p *JSON) End()
  • func (p *JSON) Print(fs *result.FileResults) error
  • func (p *JSON) PrintSuccessExitMessage() bool
  • func (p *JSON) Start()
• type Location
• type Printer
  • func NewPrinter(f string, w io.Writer) (Printer, error)
• type Simple
  • func NewSimple(w io.Writer) *Simple
  • func (p *Simple) End()
  • func (p *Simple) Print(fs *result.FileResults) error
  • func (p *Simple) PrintSuccessExitMessage() bool
  • func (p *Simple) Start()
• type SonarQube
  • func NewSonarQube(w io.Writer) *SonarQube
  • func (p *SonarQube) End()
  • func (p *SonarQube) Print(fs *result.FileResults) error
  • func (p *SonarQube) PrintSuccessExitMessage() bool
  • func (p *SonarQube) Start()
• type Text
  • func NewText(w io.Writer, disableColor bool) *Text
  • func (t *Text) End()
  • func (t *Text) Print(fs *result.FileResults) error
  • func (t *Text) PrintSuccessExitMessage() bool
  • func (t *Text) Start()
• type TextRange

Constants

const (
	// OutFormatText is a text-based output format, best for CLIs
	OutFormatText = "text"
	// OutFormatSimple is a simplified output format, which can be used with something like https://github.com/reviewdog/reviewdog
	OutFormatSimple = "simple"
	// OutFormatGitHubActions is an output format supported by GitHub Actions annotations
	// https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-a-warning-message
	OutFormatGitHubActions = "github-actions"

	// OutFormatJSON outputs in json
	OutFormatJSON = "json"

	// OutFormatSonarQube is an output format supported by SonarQube
	// https://docs.sonarqube.org/latest/analysis/generic-issue/
	OutFormatSonarQube = "sonarqube"

	// OutFormatCheckstyle outputs in checkstyle format.
	// https://github.com/checkstyle/checkstyle
	OutFormatCheckstyle = "checkstyle"
)

Variables

var OutFormats = []string{
	OutFormatText,
	OutFormatSimple,
	OutFormatGitHubActions,
	OutFormatJSON,
	OutFormatSonarQube,
	OutFormatCheckstyle,
}

OutFormats are all the available output formats. The first one should be the default

var OutFormatsString = strings.Join(OutFormats, ",")

OutFormatsString is all OutFormats, as a comma-separated string

Types

type Checkstyle

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

Checkstyle is a Checkstyle printer meant for use by a Checkstyle annotation

func NewCheckstyle

func NewCheckstyle(w io.Writer) *Checkstyle

NewCheckstyle returns a new Checkstyle printer

func (*Checkstyle) End

func (p *Checkstyle) End()

func (*Checkstyle) Print

func (p *Checkstyle) Print(fs *result.FileResults) error

Print prints in the format for Checkstyle. https://github.com/checkstyle/checkstyle

func (*Checkstyle) PrintSuccessExitMessage

func (p *Checkstyle) PrintSuccessExitMessage() bool

func (*Checkstyle) Start

func (p *Checkstyle) Start()

type Error

type Error struct {
	XMLName  xml.Name `xml:"error"`
	Column   int      `xml:"column,attr"`
	Line     int      `xml:"line,attr"`
	Message  string   `xml:"message,attr"`
	Severity string   `xml:"severity,attr"`
	Source   string   `xml:"source,attr"`
}

type File

type File struct {
	XMLName xml.Name `xml:"file"`
	Name    string   `xml:"name,attr"`
	Errors  []Error  `xml:"error"`
}

type GitHubActions

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

GitHubActions is a GitHubActions printer meant for use by a GitHub Action annotation

func NewGitHubActions

func NewGitHubActions(w io.Writer) *GitHubActions

NewGitHubActions returns a new GitHubActions printer

func (*GitHubActions) End

func (p *GitHubActions) End()

func (*GitHubActions) Print

func (p *GitHubActions) Print(fs *result.FileResults) error

Print prints in the format for GitHub actions https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message

func (*GitHubActions) PrintSuccessExitMessage

func (p *GitHubActions) PrintSuccessExitMessage() bool

func (*GitHubActions) Start

func (p *GitHubActions) Start()

type Issue

type Issue struct {
	EngineID        string   `json:"engineId"`
	RuleID          string   `json:"ruleId"`
	PrimaryLocation Location `json:"primaryLocation"`
	Type            string   `json:"type"`
	Severity        string   `json:"severity"`
}

type JSON

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

JSON is a JSON printer meant for a machine to read

func NewJSON

func NewJSON(w io.Writer) *JSON

NewJSON returns a new JSON printer

func (*JSON) End

func (p *JSON) End()

func (*JSON) Print

func (p *JSON) Print(fs *result.FileResults) error

Print prints in FileResults as json NOTE: The JSON printer will bring each line result as a JSON string. It will not be presented as an array of FileResults. You will neeed to Split by new line to parse the full output

func (*JSON) PrintSuccessExitMessage

func (p *JSON) PrintSuccessExitMessage() bool

func (*JSON) Start

func (p *JSON) Start()

type Location

type Location struct {
	Message   string    `json:"message"`
	FilePath  string    `json:"filePath"`
	TextRange TextRange `json:"textRange"`
}

type Printer

type Printer interface {
	Print(*result.FileResults) error
	Start()
	End()
	PrintSuccessExitMessage() bool
}

Printer is an interface for printing FileResults

func NewPrinter

func NewPrinter(f string, w io.Writer) (Printer, error)

NewPrinter returns a valid new Printer from a string, or an error if the printer is invalid

type Simple

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

Simple is a simple printer meant for a machine to read

func NewSimple

func NewSimple(w io.Writer) *Simple

NewSimple returns a new simple printer

func (*Simple) End

func (p *Simple) End()

func (*Simple) Print

func (p *Simple) Print(fs *result.FileResults) error

Print prints in the format 'filename:line:column: message' based on golint's output: https://github.com/golang/lint/blob/738671d3881b9731cc63024d5d88cf28db875626/golint/golint.go#L121

func (*Simple) PrintSuccessExitMessage

func (p *Simple) PrintSuccessExitMessage() bool

func (*Simple) Start

func (p *Simple) Start()

type SonarQube

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

SonarQube is a JSON printer meant for import into SonarQube

func NewSonarQube

func NewSonarQube(w io.Writer) *SonarQube

NewSonarQube returns a new SonarQube JSON printer

func (*SonarQube) End

func (p *SonarQube) End()

func (*SonarQube) Print

func (p *SonarQube) Print(fs *result.FileResults) error

Print outputs lines in FileResults as sonarqube json format. NOTE: Start() must be called before printing results and End() after printing is complete in order to form a valid JSON structure for sonarqube to import.

func (*SonarQube) PrintSuccessExitMessage

func (p *SonarQube) PrintSuccessExitMessage() bool

func (*SonarQube) Start

func (p *SonarQube) Start()

type Text

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

Text is a text printer meant for humans to read

func NewText

func NewText(w io.Writer, disableColor bool) *Text

NewText returns a text Printer with color optionally disabled

func (*Text) End

func (t *Text) End()

func (*Text) Print

func (t *Text) Print(fs *result.FileResults) error

Print prints the file results

func (*Text) PrintSuccessExitMessage

func (t *Text) PrintSuccessExitMessage() bool

func (*Text) Start

func (t *Text) Start()

type TextRange

type TextRange struct {
	StartLine   int `json:"startLine"`
	StartColumn int `json:"startColumn"`
	EndColumn   int `json:"endColumn"`
}