linter

Documentation

Index

• Constants
• func IsGoLowerThanGo122() func(cfg *config.Config) error
• type Config
  • func NewConfig(linter Linter) *Config
  • func (lc *Config) AllNames() []string
  • func (lc *Config) ConsiderSlow() *Config
  • func (lc *Config) Deprecated(message, version, replacement string, level DeprecationLevel) *Config
  • func (lc *Config) DeprecatedError(message, version, replacement string) *Config
  • func (lc *Config) DeprecatedWarning(message, version, replacement string) *Config
  • func (lc *Config) IsDeprecated() bool
  • 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) WithEnabledByDefault() *Config
  • func (lc *Config) WithInternal() *Config
  • func (lc *Config) WithLoadFiles() *Config
  • func (lc *Config) WithLoadForGoAnalysis() *Config
  • func (lc *Config) WithNoopFallback(cfg *config.Config, cond func(cfg *config.Config) error) *Config
  • func (lc *Config) WithPresets(presets ...string) *Config
  • func (lc *Config) WithSince(version string) *Config
  • func (lc *Config) WithURL(url string) *Config
• type Context
  • func (c *Context) ClearTypesInPackages()
  • func (c *Context) Settings() *config.LintersSettings
• type Deprecation
• type DeprecationLevel
• type Linter
• type Noop
  • func NewNoop(l Linter, reason string) Noop
  • func NewNoopDeprecated(name string, cfg *config.Config, level DeprecationLevel) Noop
  • func (n Noop) Desc() string
  • func (n Noop) Name() string
  • func (n Noop) Run(_ context.Context, lintCtx *Context) ([]result.Issue, error)

Constants

const (
	PresetBugs        = "bugs"        // Related to bugs detection.
	PresetComment     = "comment"     // Related to comments analysis.
	PresetComplexity  = "complexity"  // Related to code complexity analysis.
	PresetError       = "error"       // Related to error handling analysis.
	PresetFormatting  = "format"      // Related to code formatting.
	PresetImport      = "import"      // Related to imports analysis.
	PresetMetaLinter  = "metalinter"  // Related to linter that contains multiple rules or multiple linters.
	PresetModule      = "module"      // Related to Go modules analysis.
	PresetPerformance = "performance" // Related to performance.
	PresetSQL         = "sql"         // Related to SQL.
	PresetStyle       = "style"       // Related to coding style.
	PresetTest        = "test"        // Related to the analysis of the code of the tests.
	PresetUnused      = "unused"      // Related to the detection of unused code.
)

const LastLinter = "nolintlint"

LastLinter nolintlint must be last because it looks at the results of all the previous linters for unused nolint directives.

Functions

func IsGoLowerThanGo122

func IsGoLowerThanGo122() func(cfg *config.Config) error

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
	Internal        bool   // Internal linters cannot be disabled (ex: typecheck).
	CanAutoFix      bool
	IsSlow          bool
	DoesChangeTypes bool

	Since       string
	Deprecation *Deprecation
}

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) Deprecated

func (lc *Config) Deprecated(message, version, replacement string, level DeprecationLevel) *Config

func (*Config) DeprecatedError

func (lc *Config) DeprecatedError(message, version, replacement string) *Config

func (*Config) DeprecatedWarning

func (lc *Config) DeprecatedWarning(message, version, replacement string) *Config

func (*Config) IsDeprecated

func (lc *Config) IsDeprecated() bool

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) WithEnabledByDefault

func (lc *Config) WithEnabledByDefault() *Config

func (*Config) WithInternal

func (lc *Config) WithInternal() *Config

func (*Config) WithLoadFiles

func (lc *Config) WithLoadFiles() *Config

func (*Config) WithLoadForGoAnalysis

func (lc *Config) WithLoadForGoAnalysis() *Config

func (*Config) WithNoopFallback

func (lc *Config) WithNoopFallback(cfg *config.Config, cond func(cfg *config.Config) error) *Config

func (*Config) WithPresets

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

func (*Config) WithSince

func (lc *Config) WithSince(version 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
	Log       logutils.Log

	PkgCache  *cache.Cache
	LoadGuard *load.Guard
}

func (*Context) ClearTypesInPackages

func (c *Context) ClearTypesInPackages()

func (*Context) Settings

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

type Deprecation

type Deprecation struct {
	Since       string
	Message     string
	Replacement string
	Level       DeprecationLevel
}

type DeprecationLevel

type DeprecationLevel int

const (
	DeprecationNone DeprecationLevel = iota
	DeprecationWarning
	DeprecationError
)

type Linter

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

type Noop

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

func NewNoop

func NewNoop(l Linter, reason string) Noop

func NewNoopDeprecated

func NewNoopDeprecated(name string, cfg *config.Config, level DeprecationLevel) Noop

func (Noop) Desc

func (n Noop) Desc() string

func (Noop) Name

func (n Noop) Name() string

func (Noop) Run

func (n Noop) Run(_ context.Context, lintCtx *Context) ([]result.Issue, error)