Documentation
¶
Index ¶
Constants ¶
const ( OutFormatText = "text" OutFormatSimple = "simple" OutFormatGitHubActions = "github-actions" )
const MaxLineLengthForShowingViolationSource = 200
MaxLineLengthForShowingViolationSource is the max line length that this printer will show the source of the violation and the location within the line of the violation. Helps avoid consuming the console when minified files contine violations.
Variables ¶
var OutFormats = []string{ OutFormatText, OutFormatSimple, OutFormatGitHubActions, }
var OutFormatsString = strings.Join(OutFormats, ",")
Functions ¶
This section is empty.
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
func NewPrinter ¶ added in v0.1.1
type Simple ¶
type Simple struct{}
Simple is a simple printer meant for a machine to read
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
Source Files