linter

Documentation

Index

• Constants
• type Config
  • func NewConfig(linter Linter) *Config
  • func (lc Config) AllNames() []string
  • func (lc Config) GetSpeed() int
  • func (lc Config) Name() string
  • func (lc Config) WithAlternativeNames(names ...string) Config
  • func (lc Config) WithPresets(presets ...string) Config
  • func (lc Config) WithSSA() Config
  • func (lc Config) WithSpeed(speed int) Config
  • func (lc Config) WithTypeInfo() Config
  • func (lc Config) WithURL(url string) Config
• type Context
  • func (c *Context) Settings() *config.LintersSettings
• type Linter

Constants

const (
	PresetFormatting  = "format"
	PresetComplexity  = "complexity"
	PresetStyle       = "style"
	PresetBugs        = "bugs"
	PresetUnused      = "unused"
	PresetPerformance = "performance"
)

Types

type Config

type Config struct {
	Linter           Linter
	EnabledByDefault bool

	NeedsTypeInfo bool
	NeedsSSARepr  bool

	InPresets        []string
	Speed            int // more value means faster execution of linter
	AlternativeNames []string

	OriginalURL string // URL of original (not forked) repo, needed for autogenerated README
}

func NewConfig

func NewConfig(linter Linter) *Config

func (Config) AllNames

func (lc Config) AllNames() []string

func (Config) GetSpeed

func (lc Config) GetSpeed() int

func (Config) Name

func (lc Config) Name() string

func (Config) WithAlternativeNames

func (lc Config) WithAlternativeNames(names ...string) Config

func (Config) WithPresets

func (lc Config) WithPresets(presets ...string) Config

func (Config) WithSSA

func (lc Config) WithSSA() Config

func (Config) WithSpeed

func (lc Config) WithSpeed(speed int) Config

func (Config) WithTypeInfo

func (lc Config) WithTypeInfo() Config

func (Config) WithURL

func (lc Config) WithURL(url string) Config

type Context

type Context struct {
	Packages             []*packages.Package
	NotCompilingPackages []*packages.Package

	LoaderConfig *loader.Config  // deprecated, don't use for new linters
	Program      *loader.Program // deprecated, use Packages for new linters

	SSAProgram *ssa.Program

	Cfg      *config.Config
	ASTCache *astcache.Cache
	Log      logutils.Log
}

func (*Context) Settings

func (c *Context) Settings() *config.LintersSettings

type Linter

type Linter interface {
	Run(ctx context.Context, lintCtx *Context) ([]result.Issue, error)
	Name() string
	Desc() string
}