mirror of
https://github.com/google/go-github.git
synced 2026-10-29 00:44:52 +08:00
77 lines
2.1 KiB
Go
77 lines
2.1 KiB
Go
// Copyright 2025 The go-github AUTHORS. All rights reserved.
|
|
//
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
// Package sliceofpointers is a custom linter to be used by
|
|
// golangci-lint to find instances of `[]*string` and
|
|
// slices of structs without pointers and report them.
|
|
// See: https://github.com/google/go-github/issues/180
|
|
package sliceofpointers
|
|
|
|
import (
|
|
"go/ast"
|
|
"go/token"
|
|
|
|
"github.com/golangci/plugin-module-register/register"
|
|
"golang.org/x/tools/go/analysis"
|
|
)
|
|
|
|
func init() {
|
|
register.Plugin("sliceofpointers", New)
|
|
}
|
|
|
|
// SliceOfPointersPlugin is a custom linter plugin for golangci-lint.
|
|
type SliceOfPointersPlugin struct{}
|
|
|
|
// New returns an analysis.Analyzer to use with golangci-lint.
|
|
func New(_ any) (register.LinterPlugin, error) {
|
|
return &SliceOfPointersPlugin{}, nil
|
|
}
|
|
|
|
// BuildAnalyzers builds the analyzers for the SliceOfPointersPlugin.
|
|
func (f *SliceOfPointersPlugin) BuildAnalyzers() ([]*analysis.Analyzer, error) {
|
|
return []*analysis.Analyzer{
|
|
{
|
|
Name: "sliceofpointers",
|
|
Doc: "Reports usage of []*string and slices of structs without pointers.",
|
|
Run: run,
|
|
},
|
|
}, nil
|
|
}
|
|
|
|
// GetLoadMode returns the load mode for the SliceOfPointersPlugin.
|
|
func (f *SliceOfPointersPlugin) GetLoadMode() string {
|
|
return register.LoadModeSyntax
|
|
}
|
|
|
|
func run(pass *analysis.Pass) (any, error) {
|
|
for _, file := range pass.Files {
|
|
ast.Inspect(file, func(n ast.Node) bool {
|
|
if n == nil {
|
|
return false
|
|
}
|
|
|
|
if t, ok := n.(*ast.ArrayType); ok {
|
|
checkArrayType(t, t.Pos(), pass)
|
|
}
|
|
|
|
return true
|
|
})
|
|
}
|
|
return nil, nil
|
|
}
|
|
|
|
func checkArrayType(arrType *ast.ArrayType, tokenPos token.Pos, pass *analysis.Pass) {
|
|
if starExpr, ok := arrType.Elt.(*ast.StarExpr); ok {
|
|
if ident, ok := starExpr.X.(*ast.Ident); ok && ident.Name == "string" {
|
|
const msg = "use []string instead of []*string"
|
|
pass.Reportf(tokenPos, msg)
|
|
}
|
|
} else if ident, ok := arrType.Elt.(*ast.Ident); ok && ident.Obj != nil {
|
|
if _, ok := ident.Obj.Decl.(*ast.TypeSpec).Type.(*ast.StructType); ok {
|
|
pass.Reportf(tokenPos, "use []*%v instead of []%[1]v", ident.Name)
|
|
}
|
|
}
|
|
}
|