golangci-lint/pkg/golinters/gochecksumtype.go
Alec Thomas 69d6cc93cb
feat: add gochecksumtype linter (#3671)
Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>
2023-10-09 17:37:47 +02:00

81 lines
1.8 KiB
Go

package golinters
import (
"strings"
"sync"
gochecksumtype "github.com/alecthomas/go-check-sumtype"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/packages"
"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
"github.com/golangci/golangci-lint/pkg/lint/linter"
"github.com/golangci/golangci-lint/pkg/result"
)
const goCheckSumTypeName = "gochecksumtype"
func NewGoCheckSumType() *goanalysis.Linter {
var mu sync.Mutex
var resIssues []goanalysis.Issue
analyzer := &analysis.Analyzer{
Name: goCheckSumTypeName,
Doc: goanalysis.TheOnlyanalyzerDoc,
Run: func(pass *analysis.Pass) (any, error) {
issues, err := runGoCheckSumType(pass)
if err != nil {
return nil, err
}
if len(issues) == 0 {
return nil, nil
}
mu.Lock()
resIssues = append(resIssues, issues...)
mu.Unlock()
return nil, nil
},
}
return goanalysis.NewLinter(
goCheckSumTypeName,
`Run exhaustiveness checks on Go "sum types"`,
[]*analysis.Analyzer{analyzer},
nil,
).WithIssuesReporter(func(ctx *linter.Context) []goanalysis.Issue {
return resIssues
}).WithLoadMode(goanalysis.LoadModeTypesInfo)
}
func runGoCheckSumType(pass *analysis.Pass) ([]goanalysis.Issue, error) {
var resIssues []goanalysis.Issue
pkg := &packages.Package{
Fset: pass.Fset,
Syntax: pass.Files,
Types: pass.Pkg,
TypesInfo: pass.TypesInfo,
}
var unknownError error
errors := gochecksumtype.Run([]*packages.Package{pkg})
for _, err := range errors {
err, ok := err.(gochecksumtype.Error)
if !ok {
unknownError = err
continue
}
resIssues = append(resIssues, goanalysis.NewIssue(&result.Issue{
FromLinter: goCheckSumTypeName,
Text: strings.TrimPrefix(err.Error(), err.Pos().String()+": "),
Pos: err.Pos(),
}, pass))
}
return resIssues, unknownError
}