printers

Documentation

Overview

Package printers provides various printing implementation that can be used to print/display found link issues.

Index

• func NewJSON() *jsoner
• func NewText(useColors bool) *texter
• type JSONResult
• type Printer
  • func GetPrinter(typ string) Printer
  • func NewGithub() Printer

Functions

func NewJSON

func NewJSON() *jsoner

func NewText

func NewText(useColors bool) *texter

Types

type JSONResult

type JSONResult struct {
	Issues []models.Fix `json:"issues"`
}

type Printer

type Printer interface {
	Print(issue models.Fix) error
	PrintAll(issues []models.Fix) error
}

func GetPrinter

func GetPrinter(typ string) Printer

func NewGithub

func NewGithub() Printer

Github 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