metalinter

Documentation

Index

• Constants
• type Finding
  • func LintGo(pkgPaths []string) ([]Finding, error)
  • func (f Finding) ProblemsFormat() string

Constants

const (
	SeverityError   = "error"
	SeverityWarning = "warning"
	SeverityInfo    = "info"

	CategoryBug         = "bug"
	CategoryStyle       = "style"
	CategoryFormatting  = "formatting"
	CategoryUnused      = "unused"
	CategoryPerformance = "performance"
	CategoryCorrectness = "correctness"
)

Types

type Finding

type Finding struct {
	Tool     string `json:"tool"`     // "govet", "staticcheck", "gofmt", "misspell", "ineffassign"
	Code     string `json:"code"`     // e.g. "SA1000", "S1017", "formatting"
	Severity string `json:"severity"` // "error", "warning", "info"
	File     string `json:"file_path"`
	Line     int    `json:"line_start"`
	Column   int    `json:"col_start"`
	Message  string `json:"message"`
	Category string `json:"category"` // "bug", "style", "formatting", "unused", "performance"
}

Finding represents a single issue detected by an embedded meta-linter.

func LintGo

func LintGo(pkgPaths []string) ([]Finding, error)

LintGo runs all Go meta-linters on the given package paths. Returns findings from all embedded tools. The pkgPaths are file paths or directory paths containing Go files.

func (Finding) ProblemsFormat

func (f Finding) ProblemsFormat() string

ProblemsFormat returns a GCC-style string for IDE problem matchers.