linter

Documentation

Index

• Constants
• type Config
  • func NewConfig(linter Linter) *Config
  • func (lc Config) GetLinter() Linter
  • func (lc Config) GetSpeed() int
  • func (lc Config) NeedsProgramLoading() bool
  • func (lc Config) NeedsSSARepresentation() bool
  • func (lc Config) WithFullImport() Config
  • func (lc Config) WithPresets(presets ...string) Config
  • func (lc Config) WithSSA() Config
  • func (lc Config) WithSpeed(speed int) 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
	DoesFullImport   bool
	NeedsSSARepr     bool
	InPresets        []string
	Speed            int // more value means faster execution of linter

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

func NewConfig

func NewConfig(linter Linter) *Config

func (Config) GetLinter

func (lc Config) GetLinter() Linter

func (Config) GetSpeed

func (lc Config) GetSpeed() int

func (Config) NeedsProgramLoading

func (lc Config) NeedsProgramLoading() bool

func (Config) NeedsSSARepresentation

func (lc Config) NeedsSSARepresentation() bool

func (Config) WithFullImport

func (lc Config) WithFullImport() 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) WithURL

func (lc Config) WithURL(url string) Config

type Context

type Context struct {
	Paths                *fsutils.ProjectPaths
	Cfg                  *config.Config
	Program              *loader.Program
	SSAProgram           *ssa.Program
	LoaderConfig         *loader.Config
	ASTCache             *astcache.Cache
	NotCompilingPackages []*loader.PackageInfo
}

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
}