golangci-lint/pkg/golinters/forbidigo.go
2021-02-01 21:16:28 +01:00

71 lines
1.9 KiB
Go

package golinters
import (
"sync"
"github.com/ashanbrown/forbidigo/forbidigo"
"github.com/pkg/errors"
"golang.org/x/tools/go/analysis"
"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
"github.com/golangci/golangci-lint/pkg/lint/linter"
"github.com/golangci/golangci-lint/pkg/result"
)
func NewForbidigo() *goanalysis.Linter {
const linterName = "forbidigo"
var mu sync.Mutex
var resIssues []goanalysis.Issue
analyzer := &analysis.Analyzer{
Name: linterName,
Doc: goanalysis.TheOnlyanalyzerDoc,
}
return goanalysis.NewLinter(
linterName,
"Forbids identifiers",
[]*analysis.Analyzer{analyzer},
nil,
).WithContextSetter(func(lintCtx *linter.Context) {
s := &lintCtx.Settings().Forbidigo
analyzer.Run = func(pass *analysis.Pass) (interface{}, error) {
var res []goanalysis.Issue
options := []forbidigo.Option{
forbidigo.OptionExcludeGodocExamples(s.ExcludeGodocExamples),
// disable "//permit" directives so only "//nolint" directives matters within golangci lint
forbidigo.OptionIgnorePermitDirectives(true),
}
forbid, err := forbidigo.NewLinter(s.Forbid, options...)
if err != nil {
return nil, errors.Wrapf(err, "failed to create linter %q", linterName)
}
for _, file := range pass.Files {
hints, err := forbid.Run(pass.Fset, file)
if err != nil {
return nil, errors.Wrapf(err, "forbidigo linter failed on file %q", file.Name.String())
}
for _, hint := range hints {
res = append(res, goanalysis.NewIssue(&result.Issue{
Pos: hint.Position(),
Text: hint.Details(),
FromLinter: linterName,
}, pass))
}
}
if len(res) == 0 {
return nil, nil
}
mu.Lock()
resIssues = append(resIssues, res...)
mu.Unlock()
return nil, nil
}
}).WithIssuesReporter(func(*linter.Context) []goanalysis.Issue {
return resIssues
}).WithLoadMode(goanalysis.LoadModeSyntax)
}