refactor: Remove unused GetStructNameForField util function

Author: yongruilin

pkg/analysis/utils/utils.go

@@ -21,7 +21,6 @@ import (
 	"go/ast"
 	"go/token"
 	"go/types"
-	"slices"
 	"strings"
 
 	"golang.org/x/tools/go/analysis"
@@ -354,52 +353,6 @@ func isTypeBasic(t types.Type) bool {
 	return false
 }
 
-// GetStructNameForField inspects the AST of the package and returns the name of the struct
-// that contains the field being inspected.
-func GetStructNameForField(pass *analysis.Pass, field *ast.Field) string {
-	for _, file := range pass.Files {
-		var (
-			structName string
-			found      bool
-		)
-
-		ast.Inspect(file, func(n ast.Node) bool {
-			if found {
-				return false
-			}
-
-			typeSpec, ok := n.(*ast.TypeSpec)
-			if !ok {
-				return true
-			}
-
-			structType, ok := typeSpec.Type.(*ast.StructType)
-			if !ok {
-				return true
-			}
-
-			structName = typeSpec.Name.Name
-
-			if structType.Fields == nil {
-				return true
-			}
-
-			if slices.Contains(structType.Fields.List, field) {
-				found = true
-				return false
-			}
-
-			return true
-		})
-
-		if found {
-			return structName
-		}
-	}
-
-	return ""
-}
-
 // GetMinProperties returns the value of the minimum properties marker.
 // It returns a nil value when the marker is not present, and an error
 // when the marker is present, but malformed.

pkg/analysis/utils/utils_test.go

@@ -20,10 +20,6 @@ import (
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
-	"golang.org/x/tools/go/analysis"
-	"golang.org/x/tools/go/analysis/analysistest"
-	"golang.org/x/tools/go/analysis/passes/inspect"
-	"golang.org/x/tools/go/ast/inspector"
 
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/utils"
 )
@@ -77,45 +73,3 @@ var _ = Describe("FieldName", func() {
 		}),
 	)
 })
-
-var _ = Describe("GetStructNameForField", func() {
-	It("should find the correct struct name for a field", func() {
-		testdata := analysistest.TestData()
-		analysistest.Run(GinkgoT(), testdata, testGetStructNameAnalyzer(), "getstructname")
-	})
-})
-
-func testGetStructNameAnalyzer() *analysis.Analyzer {
-	return &analysis.Analyzer{
-		Name:     "testgetstructname",
-		Doc:      "test analyzer for GetStructNameForField",
-		Requires: []*analysis.Analyzer{inspect.Analyzer},
-		Run: func(pass *analysis.Pass) (any, error) {
-			inspect, ok := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
-			if !ok {
-				return nil, errCouldNotGetInspector
-			}
-
-			nodeFilter := []ast.Node{
-				(*ast.Field)(nil),
-			}
-
-			inspect.Preorder(nodeFilter, func(n ast.Node) {
-				field, ok := n.(*ast.Field)
-				if !ok {
-					return
-				}
-				if len(field.Names) == 0 {
-					return
-				}
-
-				structName := utils.GetStructNameForField(pass, field)
-				if structName != "" {
-					pass.Reportf(field.Pos(), "field %s is in struct %s", field.Names[0].Name, structName)
-				}
-			})
-
-			return nil, nil
-		},
-	}
-}