add FieldName API

Signed-off-by: sivchari <shibuuuu5@gmail.com>

Author: sivchari

pkg/analysis/helpers/inspector/analyzer_test.go

@@ -25,6 +25,7 @@ import (
 	"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"
 )
 
 func TestInspector(t *testing.T) {
@@ -49,14 +50,7 @@ func run(pass *analysis.Pass) (any, error) {
 	}
 
 	inspect.InspectFields(func(field *ast.Field, stack []ast.Node, jsonTagInfo extractjsontags.FieldTagInfo, markersAccess markers.Markers) {
-		var fieldName string
-		if len(field.Names) > 0 {
-			fieldName = field.Names[0].Name
-		} else if ident, ok := field.Type.(*ast.Ident); ok {
-			fieldName = ident.Name
-		}
-
-		pass.Reportf(field.Pos(), "field: %v", fieldName)
+		pass.Reportf(field.Pos(), "field: %v", utils.FieldName(field))
 
 		if jsonTagInfo.Name != "" {
 			pass.Reportf(field.Pos(), "json tag: %v", jsonTagInfo.Name)

pkg/analysis/jsontags/analyzer.go

@@ -24,6 +24,7 @@ import (
 	"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"
 	"sigs.k8s.io/kube-api-linter/pkg/config"
 
 	"golang.org/x/tools/go/analysis"
@@ -75,15 +76,13 @@ func (a *analyzer) run(pass *analysis.Pass) (any, error) {
 }
 
 func (a *analyzer) checkField(pass *analysis.Pass, field *ast.Field, tagInfo extractjsontags.FieldTagInfo) {
-	var prefix string
+	prefix := "embedded field %s"
 	if len(field.Names) > 0 && field.Names[0] != nil {
-		prefix = fmt.Sprintf("field %s", field.Names[0].Name)
-	} else if ident, ok := field.Type.(*ast.Ident); ok {
-		prefix = fmt.Sprintf("embedded field %s", ident.Name)
+		prefix = "field %s"
 	}
 
 	if tagInfo.Missing {
-		pass.Reportf(field.Pos(), "%s is missing json tag", prefix)
+		pass.Reportf(field.Pos(), "%s is missing json tag", fmt.Sprintf(prefix, utils.FieldName(field)))
 		return
 	}
 
@@ -92,13 +91,13 @@ func (a *analyzer) checkField(pass *analysis.Pass, field *ast.Field, tagInfo ext
 	}
 
 	if tagInfo.Name == "" {
-		pass.Reportf(field.Pos(), "%s has empty json tag", prefix)
+		pass.Reportf(field.Pos(), "%s has empty json tag", fmt.Sprintf(prefix, utils.FieldName(field)))
 		return
 	}
 
 	matched := a.jsonTagRegex.Match([]byte(tagInfo.Name))
 	if !matched {
-		pass.Reportf(field.Pos(), "%s json tag does not match pattern %q: %s", prefix, a.jsonTagRegex.String(), tagInfo.Name)
+		pass.Reportf(field.Pos(), "%s json tag does not match pattern %q: %s", fmt.Sprintf(prefix, utils.FieldName(field)), a.jsonTagRegex.String(), tagInfo.Name)
 	}
 }
 

pkg/analysis/utils/utils.go

@@ -77,6 +77,21 @@ func LookupTypeSpec(pass *analysis.Pass, ident *ast.Ident) (*ast.TypeSpec, bool)
 	return nil, false
 }
 
+// FieldName returns the name of the field. If the field has a name, it returns that name.
+// If the field is embedded and it can be converted to an identifier, it returns the name of the identifier.
+func FieldName(field *ast.Field) string {
+	if len(field.Names) > 0 {
+		return field.Names[0].Name
+	}
+
+	ident, ok := field.Type.(*ast.Ident)
+	if !ok {
+		return ""
+	}
+
+	return ident.Name
+}
+
 func getFilesForType(pass *analysis.Pass, ident *ast.Ident) (*token.File, *ast.File) {
 	namedType, ok := pass.TypesInfo.TypeOf(ident).(*types.Named)
 	if !ok {