159 lines
3.8 KiB
Go
159 lines
3.8 KiB
Go
package linter
|
|
|
|
import (
|
|
"golang.org/x/tools/go/analysis"
|
|
"golang.org/x/tools/go/packages"
|
|
|
|
"github.com/golangci/golangci-lint/pkg/config"
|
|
)
|
|
|
|
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.
|
|
)
|
|
|
|
// LastLinter nolintlint must be last because it looks at the results of all the previous linters for unused nolint directives.
|
|
const LastLinter = "nolintlint"
|
|
|
|
type Deprecation struct {
|
|
Since string
|
|
Message string
|
|
Replacement string
|
|
}
|
|
|
|
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 (lc *Config) WithEnabledByDefault() *Config {
|
|
lc.EnabledByDefault = true
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) WithInternal() *Config {
|
|
lc.Internal = true
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) ConsiderSlow() *Config {
|
|
lc.IsSlow = true
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) IsSlowLinter() bool {
|
|
return lc.IsSlow
|
|
}
|
|
|
|
func (lc *Config) WithLoadFiles() *Config {
|
|
lc.LoadMode |= packages.NeedName | packages.NeedFiles | packages.NeedCompiledGoFiles
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) WithLoadForGoAnalysis() *Config {
|
|
lc = lc.WithLoadFiles()
|
|
lc.LoadMode |= packages.NeedImports | packages.NeedDeps | packages.NeedExportFile | packages.NeedTypesSizes
|
|
lc.IsSlow = true
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) WithPresets(presets ...string) *Config {
|
|
lc.InPresets = presets
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) WithURL(url string) *Config {
|
|
lc.OriginalURL = url
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) WithAlternativeNames(names ...string) *Config {
|
|
lc.AlternativeNames = names
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) WithAutoFix() *Config {
|
|
lc.CanAutoFix = true
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) WithChangeTypes() *Config {
|
|
lc.DoesChangeTypes = true
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) WithSince(version string) *Config {
|
|
lc.Since = version
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) Deprecated(message, version, replacement string) *Config {
|
|
lc.Deprecation = &Deprecation{
|
|
Since: version,
|
|
Message: message,
|
|
Replacement: replacement,
|
|
}
|
|
return lc
|
|
}
|
|
|
|
func (lc *Config) IsDeprecated() bool {
|
|
return lc.Deprecation != nil
|
|
}
|
|
|
|
func (lc *Config) AllNames() []string {
|
|
return append([]string{lc.Name()}, lc.AlternativeNames...)
|
|
}
|
|
|
|
func (lc *Config) Name() string {
|
|
return lc.Linter.Name()
|
|
}
|
|
|
|
func (lc *Config) WithNoopFallback(cfg *config.Config) *Config {
|
|
if cfg != nil && config.IsGreaterThanOrEqualGo118(cfg.Run.Go) {
|
|
lc.Linter = &Noop{
|
|
name: lc.Linter.Name(),
|
|
desc: lc.Linter.Desc(),
|
|
run: func(pass *analysis.Pass) (any, error) {
|
|
return nil, nil
|
|
},
|
|
}
|
|
|
|
lc.LoadMode = 0
|
|
return lc.WithLoadFiles()
|
|
}
|
|
|
|
return lc
|
|
}
|
|
|
|
func NewConfig(linter Linter) *Config {
|
|
lc := &Config{
|
|
Linter: linter,
|
|
}
|
|
return lc.WithLoadFiles()
|
|
}
|