printer

Documentation

Index

• Constants
• Variables
• type GitHubActions
  • func NewGitHubActions() *GitHubActions
  • func (p *GitHubActions) Print(w io.Writer, fs *result.FileResults) error
• type JSON
  • func NewJSON() *JSON
  • func (p *JSON) Print(w io.Writer, fs *result.FileResults) error
• type Printer
  • func NewPrinter(f string) (Printer, error)
• type Simple
  • func NewSimple() *Simple
  • func (p *Simple) Print(w io.Writer, fs *result.FileResults) error
• type Text
  • func NewText(disableColor bool) *Text
  • func (t *Text) Print(w io.Writer, fs *result.FileResults) error

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"
)

Variables

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

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 GitHubActions

type GitHubActions struct{}

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

func NewGitHubActions

func NewGitHubActions() *GitHubActions

NewGitHubActions returns a new GitHubActions printer

func (*GitHubActions) Print

func (p *GitHubActions) Print(w io.Writer, 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

type JSON

type JSON struct{}

JSON is a JSON printer meant for a machine to read

func NewJSON

func NewJSON() *JSON

NewJSON returns a new JSON printer

func (*JSON) Print

func (p *JSON) Print(w io.Writer, 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

type Printer

type Printer interface {
	Print(io.Writer, *result.FileResults) error
}

Printer is an interface for printing FileResults

func NewPrinter

func NewPrinter(f string) (Printer, error)

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

type Simple

type Simple struct{}

Simple is a simple printer meant for a machine to read

func NewSimple

func NewSimple() *Simple

NewSimple returns a new simple printer

func (*Simple) Print

func (p *Simple) Print(w io.Writer, 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

type Text

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

Text is a text printer meant for humans to read

func NewText

func NewText(disableColor bool) *Text

NewText returns a text Printer with color optionally disabled

func (*Text) Print

func (t *Text) Print(w io.Writer, fs *result.FileResults) error

Print prints the file results