reporter

Documentation

Index

• Constants
• type Option
  • func DisableLintIgnore() Option
  • func DisableNoLint() Option
  • func ExcludeFiles(configDir string, files []string) Option
  • func IgnoreAnotation(s string) Option
  • func IncludeGenerated() Option
  • func Prefix(s string) Option
• type Reporter
  • func New(name string, pass *analysis.Pass, opts ...Option) (*Reporter, error)
  • func (r *Reporter) Append(pos token.Pos, msg string)
  • func (r *Reporter) AppendOr(pos token.Pos, end token.Pos, msg string)
  • func (r *Reporter) Report()

Constants

const (
	NoLintCommentAnnotation  = "nolint"
	NoStyleCommentAnnotation = "nostyle"
	LintIgnore               = "lint:ignore"
	IgnoreAll                = "all"
)

Types

type Option

type Option func(*Reporter)

func DisableLintIgnore

func DisableLintIgnore() Option

DisableLintIgnore disables handling for '//lint:ignore'.

func DisableNoLint

func DisableNoLint() Option

DisableNoLint disables handling for '//nolint:*'.

func ExcludeFiles

func ExcludeFiles(configDir string, files []string) Option

ExcludeFiles excludes files from the report.

func IgnoreAnotation

func IgnoreAnotation(s string) Option

IgnoreAnotation sets the annotation to ignore the report.

func IncludeGenerated

func IncludeGenerated() Option

IncludeGenerated includes generated codes in the report.

func Prefix

func Prefix(s string) Option

Prefix sets the prefix of the report.

type Reporter

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

Reporter is a wrapper of analysis.Pass.Reportf.

func New

func New(name string, pass *analysis.Pass, opts ...Option) (*Reporter, error)

New returns a new Reporter.

func (*Reporter) Append

func (r *Reporter) Append(pos token.Pos, msg string)

Append appends token.Pos and message to the report.

func (*Reporter) AppendOr

func (r *Reporter) AppendOr(pos token.Pos, end token.Pos, msg string)

AppendOr appends posititons (start, end) and message to the report.

func (*Reporter) Report

func (r *Reporter) Report()

Report reports all reports.