printers

Documentation

Index

• type Checkstyle
  • func NewCheckstyle(w io.Writer) *Checkstyle
  • func (p Checkstyle) Print(ctx context.Context, issues []result.Issue) error
• type CodeClimate
  • func NewCodeClimate(w io.Writer) *CodeClimate
  • func (p CodeClimate) Print(ctx context.Context, issues []result.Issue) error
• type CodeClimateIssue
• type HTML
  • func NewHTML(w io.Writer) *HTML
  • func (p HTML) Print(_ context.Context, issues []result.Issue) error
• type JSON
  • func NewJSON(rd *report.Data, w io.Writer) *JSON
  • func (p JSON) Print(ctx context.Context, issues []result.Issue) error
• type JSONResult
• type JunitXML
  • func NewJunitXML(w io.Writer) *JunitXML
  • func (p JunitXML) Print(ctx context.Context, issues []result.Issue) error
• type Printer
  • func NewGithub(w io.Writer) Printer
• type Tab
  • func NewTab(printLinterName bool, log logutils.Log, w io.Writer) *Tab
  • func (p *Tab) Print(ctx context.Context, issues []result.Issue) error
  • func (p Tab) SprintfColored(ca color.Attribute, format string, args ...interface{}) string
• type Text
  • func NewText(printIssuedLine, useColors, printLinterName bool, log logutils.Log, ...) *Text
  • func (p *Text) Print(ctx context.Context, issues []result.Issue) error
  • func (p Text) SprintfColored(ca color.Attribute, format string, args ...interface{}) string

Types

type Checkstyle

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

func NewCheckstyle

func NewCheckstyle(w io.Writer) *Checkstyle

func (Checkstyle) Print

func (p Checkstyle) Print(ctx context.Context, issues []result.Issue) error

type CodeClimate

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

func NewCodeClimate

func NewCodeClimate(w io.Writer) *CodeClimate

func (CodeClimate) Print

func (p CodeClimate) Print(ctx context.Context, issues []result.Issue) error

type CodeClimateIssue

type CodeClimateIssue struct {
	Description string `json:"description"`
	Severity    string `json:"severity,omitempty"`
	Fingerprint string `json:"fingerprint"`
	Location    struct {
		Path  string `json:"path"`
		Lines struct {
			Begin int `json:"begin"`
		} `json:"lines"`
	} `json:"location"`
}

CodeClimateIssue is a subset of the Code Climate spec - https://github.com/codeclimate/spec/blob/master/SPEC.md#data-types It is just enough to support GitLab CI Code Quality - https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html

type HTML

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

func NewHTML

func NewHTML(w io.Writer) *HTML

func (HTML) Print

func (p HTML) Print(_ context.Context, issues []result.Issue) error

type JSON

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

func NewJSON

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

func (JSON) Print

func (p JSON) Print(ctx context.Context, 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
}

func NewJunitXML

func NewJunitXML(w io.Writer) *JunitXML

func (JunitXML) Print

func (p JunitXML) Print(ctx context.Context, issues []result.Issue) error

type Printer

type Printer interface {
	Print(ctx context.Context, issues []result.Issue) error
}

func NewGithub

func NewGithub(w io.Writer) Printer

NewGithub output format outputs issues according to GitHub actions format: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message

type Tab

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

func NewTab

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

func (*Tab) Print

func (p *Tab) Print(ctx context.Context, issues []result.Issue) error

func (Tab) SprintfColored

func (p Tab) SprintfColored(ca color.Attribute, format string, args ...interface{}) string

type Text

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

func NewText

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

func (*Text) Print

func (p *Text) Print(ctx context.Context, issues []result.Issue) error

func (Text) SprintfColored

func (p Text) SprintfColored(ca color.Attribute, format string, args ...interface{}) string