linter

Documentation

Index

• Constants
• type Config
  • func NewConfig(linter Linter) *Config
  • func (lc *Config) AllNames() []string
  • func (lc *Config) ConsiderSlow() *Config
  • func (lc *Config) IsSlowLinter() bool
  • func (lc *Config) Name() string
  • func (lc *Config) WithAlternativeNames(names ...string) *Config
  • func (lc *Config) WithAutoFix() *Config
  • func (lc *Config) WithChangeTypes() *Config
  • func (lc *Config) WithLoadFiles() *Config
  • func (lc *Config) WithLoadForGoAnalysis() *Config
  • func (lc *Config) WithPresets(presets ...string) *Config
  • func (lc *Config) WithURL(url string) *Config
• type Context
  • func (c *Context) ClearTypesInPackages()
  • 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

	LoadMode packages.LoadMode

	InPresets        []string
	AlternativeNames []string

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

func NewConfig

func NewConfig(linter Linter) *Config

func (*Config) AllNames

func (lc *Config) AllNames() []string

func (*Config) ConsiderSlow

func (lc *Config) ConsiderSlow() *Config

func (*Config) IsSlowLinter

func (lc *Config) IsSlowLinter() bool

func (*Config) Name

func (lc *Config) Name() string

func (*Config) WithAlternativeNames

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

func (*Config) WithAutoFix

func (lc *Config) WithAutoFix() *Config

func (*Config) WithChangeTypes

func (lc *Config) WithChangeTypes() *Config

func (*Config) WithLoadFiles

func (lc *Config) WithLoadFiles() *Config

func (*Config) WithLoadForGoAnalysis

func (lc *Config) WithLoadForGoAnalysis() *Config

func (*Config) WithPresets

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

func (*Config) WithURL

func (lc *Config) WithURL(url string) *Config

type Context

type Context struct {
	// Packages are deduplicated (test and normal packages) packages
	Packages []*packages.Package

	// OriginalPackages aren't deduplicated: they contain both normal and test
	// version for each of packages
	OriginalPackages []*packages.Package

	Cfg       *config.Config
	FileCache *fsutils.FileCache
	LineCache *fsutils.LineCache
	Log       logutils.Log

	PkgCache  *pkgcache.Cache
	LoadGuard *load.Guard
}

func (*Context) ClearTypesInPackages

func (c *Context) ClearTypesInPackages()

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
}