76 lines
1.7 KiB
Go
76 lines
1.7 KiB
Go
package golinters
|
|
|
|
import (
|
|
"go/token"
|
|
"strings"
|
|
"sync"
|
|
|
|
"github.com/matoous/godox"
|
|
"golang.org/x/tools/go/analysis"
|
|
|
|
"github.com/golangci/golangci-lint/pkg/config"
|
|
"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
|
|
"github.com/golangci/golangci-lint/pkg/lint/linter"
|
|
"github.com/golangci/golangci-lint/pkg/result"
|
|
)
|
|
|
|
const godoxName = "godox"
|
|
|
|
func NewGodox(settings *config.GodoxSettings) *goanalysis.Linter {
|
|
var mu sync.Mutex
|
|
var resIssues []goanalysis.Issue
|
|
|
|
analyzer := &analysis.Analyzer{
|
|
Name: godoxName,
|
|
Doc: goanalysis.TheOnlyanalyzerDoc,
|
|
Run: func(pass *analysis.Pass) (any, error) {
|
|
issues := runGodox(pass, settings)
|
|
|
|
if len(issues) == 0 {
|
|
return nil, nil
|
|
}
|
|
|
|
mu.Lock()
|
|
resIssues = append(resIssues, issues...)
|
|
mu.Unlock()
|
|
|
|
return nil, nil
|
|
},
|
|
}
|
|
|
|
return goanalysis.NewLinter(
|
|
godoxName,
|
|
"Tool for detection of FIXME, TODO and other comment keywords",
|
|
[]*analysis.Analyzer{analyzer},
|
|
nil,
|
|
).WithIssuesReporter(func(*linter.Context) []goanalysis.Issue {
|
|
return resIssues
|
|
}).WithLoadMode(goanalysis.LoadModeSyntax)
|
|
}
|
|
|
|
func runGodox(pass *analysis.Pass, settings *config.GodoxSettings) []goanalysis.Issue {
|
|
var messages []godox.Message
|
|
for _, file := range pass.Files {
|
|
messages = append(messages, godox.Run(file, pass.Fset, settings.Keywords...)...)
|
|
}
|
|
|
|
if len(messages) == 0 {
|
|
return nil
|
|
}
|
|
|
|
issues := make([]goanalysis.Issue, len(messages))
|
|
|
|
for k, i := range messages {
|
|
issues[k] = goanalysis.NewIssue(&result.Issue{
|
|
Pos: token.Position{
|
|
Filename: i.Pos.Filename,
|
|
Line: i.Pos.Line,
|
|
},
|
|
Text: strings.TrimRight(i.Message, "\n"),
|
|
FromLinter: godoxName,
|
|
}, pass)
|
|
}
|
|
|
|
return issues
|
|
}
|