printer

Documentation

Index

• type GitHubActions
  • func NewGitHubActions() *GitHubActions
  • func (p *GitHubActions) Print(fs *result.FileResults) error
• type Printer
• type Simple
  • func NewSimple() *Simple
  • func (p *Simple) Print(fs *result.FileResults) error
• type Text
  • func NewText(disableColor bool) *Text
  • func (t *Text) Print(fs *result.FileResults) error

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(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 Printer

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

Printer is an interface for printing FileResults

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(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(fs *result.FileResults) error

Print prints the file results