Align type checker linters on helpers inspector

Author: JoelSpeed

pkg/analysis/integers/analyzer.go

@@ -19,9 +19,11 @@ import (
 	"go/ast"
 
 	"golang.org/x/tools/go/analysis"
-	"golang.org/x/tools/go/analysis/passes/inspect"
-	"golang.org/x/tools/go/ast/inspector"
+
 	kalerrors "sigs.k8s.io/kube-api-linter/pkg/analysis/errors"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/extractjsontags"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/inspector"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/markers"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/utils"
 )
 
@@ -33,30 +35,23 @@ var Analyzer = &analysis.Analyzer{
 	Name:     name,
 	Doc:      "All integers should be explicit about their size, int32 and int64 should be used over plain int. Unsigned ints are not allowed.",
 	Run:      run,
-	Requires: []*analysis.Analyzer{inspect.Analyzer},
+	Requires: []*analysis.Analyzer{inspector.Analyzer},
 }
 
 func run(pass *analysis.Pass) (any, error) {
-	inspect, ok := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+	inspect, ok := pass.ResultOf[inspector.Analyzer].(inspector.Inspector)
 	if !ok {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	// Filter to fields so that we can look at fields within structs.
-	// Filter typespecs so that we can look at type aliases.
-	nodeFilter := []ast.Node{
-		(*ast.StructType)(nil),
-		(*ast.TypeSpec)(nil),
-	}
-
 	typeChecker := utils.NewTypeChecker(utils.IsBasicType, checkIntegers)
 
-	// Preorder visits all the nodes of the AST in depth-first order. It calls
-	// f(n) for each node n before it visits n's children.
-	//
-	// We use the filter defined above, ensuring we only look at struct fields and type declarations.
-	inspect.Preorder(nodeFilter, func(n ast.Node) {
-		typeChecker.CheckNode(pass, n)
+	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, _ markers.Markers, _ string) {
+		typeChecker.CheckNode(pass, field)
+	})
+
+	inspect.InspectTypeSpec(func(typeSpec *ast.TypeSpec, markersAccess markers.Markers) {
+		typeChecker.CheckNode(pass, typeSpec)
 	})
 
 	return nil, nil //nolint:nilnil

pkg/analysis/nobools/analyzer.go

@@ -19,9 +19,11 @@ import (
 	"go/ast"
 
 	"golang.org/x/tools/go/analysis"
-	"golang.org/x/tools/go/analysis/passes/inspect"
-	"golang.org/x/tools/go/ast/inspector"
+
 	kalerrors "sigs.k8s.io/kube-api-linter/pkg/analysis/errors"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/extractjsontags"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/inspector"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/markers"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/utils"
 )
 
@@ -33,30 +35,23 @@ var Analyzer = &analysis.Analyzer{
 	Name:     name,
 	Doc:      "Boolean values cannot evolve over time, use an enum with meaningful values instead",
 	Run:      run,
-	Requires: []*analysis.Analyzer{inspect.Analyzer},
+	Requires: []*analysis.Analyzer{inspector.Analyzer},
 }
 
 func run(pass *analysis.Pass) (any, error) {
-	inspect, ok := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+	inspect, ok := pass.ResultOf[inspector.Analyzer].(inspector.Inspector)
 	if !ok {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	// Filter to fields so that we can look at fields within structs.
-	// Filter typespecs so that we can look at type aliases.
-	nodeFilter := []ast.Node{
-		(*ast.StructType)(nil),
-		(*ast.TypeSpec)(nil),
-	}
-
 	typeChecker := utils.NewTypeChecker(utils.IsBasicType, checkBool)
 
-	// Preorder visits all the nodes of the AST in depth-first order. It calls
-	// f(n) for each node n before it visits n's children.
-	//
-	// We use the filter defined above, ensuring we only look at struct fields and type declarations.
-	inspect.Preorder(nodeFilter, func(n ast.Node) {
-		typeChecker.CheckNode(pass, n)
+	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, _ markers.Markers, _ string) {
+		typeChecker.CheckNode(pass, field)
+	})
+
+	inspect.InspectTypeSpec(func(typeSpec *ast.TypeSpec, markersAccess markers.Markers) {
+		typeChecker.CheckNode(pass, typeSpec)
 	})
 
 	return nil, nil //nolint:nilnil

pkg/analysis/nofloats/analyzer.go

@@ -19,9 +19,11 @@ import (
 	"go/ast"
 
 	"golang.org/x/tools/go/analysis"
-	"golang.org/x/tools/go/analysis/passes/inspect"
-	"golang.org/x/tools/go/ast/inspector"
+
 	kalerrors "sigs.k8s.io/kube-api-linter/pkg/analysis/errors"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/extractjsontags"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/inspector"
+	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/markers"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/utils"
 )
 
@@ -33,30 +35,23 @@ var Analyzer = &analysis.Analyzer{
 	Name:     name,
 	Doc:      "Float values cannot be reliably round-tripped without changing and have varying precisions and representations across languages and architectures.",
 	Run:      run,
-	Requires: []*analysis.Analyzer{inspect.Analyzer},
+	Requires: []*analysis.Analyzer{inspector.Analyzer},
 }
 
 func run(pass *analysis.Pass) (any, error) {
-	inspect, ok := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
+	inspect, ok := pass.ResultOf[inspector.Analyzer].(inspector.Inspector)
 	if !ok {
 		return nil, kalerrors.ErrCouldNotGetInspector
 	}
 
-	// Filter to structs so that we can look at fields within structs.
-	// Filter typespecs so that we can look at type aliases.
-	nodeFilter := []ast.Node{
-		(*ast.StructType)(nil),
-		(*ast.TypeSpec)(nil),
-	}
-
 	typeChecker := utils.NewTypeChecker(utils.IsBasicType, checkFloat)
 
-	// Preorder visits all the nodes of the AST in depth-first order. It calls
-	// f(n) for each node n before it visits n's children.
-	//
-	// We use the filter defined above, ensuring we only look at struct fields and type declarations.
-	inspect.Preorder(nodeFilter, func(n ast.Node) {
-		typeChecker.CheckNode(pass, n)
+	inspect.InspectFields(func(field *ast.Field, _ extractjsontags.FieldTagInfo, _ markers.Markers, _ string) {
+		typeChecker.CheckNode(pass, field)
+	})
+
+	inspect.InspectTypeSpec(func(typeSpec *ast.TypeSpec, markersAccess markers.Markers) {
+		typeChecker.CheckNode(pass, typeSpec)
 	})
 
 	return nil, nil //nolint:nilnil