check only identical marker

Signed-off-by: sivchari <[email protected]>

Author: sivchari

README.md

@@ -165,13 +165,10 @@ When the `json` tag is present, and matches the first word of the field comment
 
 ## DuplicateMarkers
 
-The `duplicatemarkers` linter checks that all markers in the API types which have duplicated markers related with field and type.
+The `duplicatemarkers` linter checks for duplicate markers related with specific type or field.
+This linter diagnose _only_ if the marker and value together are completely unique. e.g. the `duplicatemarkers` will not diagnose the field has kubebuilder:validation:MaxLength=10 and kubebuilder:validation:MaxLength=11
 
-### Fixes
-
-The `duplicatemarkers` linter can automatically fix markers that are duplicated.
-
-When the marker is duplicated, the linter will suggest to remove the duplicate marker.
+About the duplicated markers which has different value, it requires specific rule for each marker, these are processed by its corresponding linter.
 
 ## Integers
 

pkg/analysis/duplicatemarkers/analyzer.go

@@ -20,6 +20,7 @@ import (
 	"go/ast"
 
 	"golang.org/x/tools/go/analysis"
+	"k8s.io/apimachinery/pkg/util/sets"
 
 	kalerrors "sigs.k8s.io/kube-api-linter/pkg/analysis/errors"
 	"sigs.k8s.io/kube-api-linter/pkg/analysis/helpers/extractjsontags"
@@ -47,37 +48,56 @@ func run(pass *analysis.Pass) (any, error) {
 	}
 
 	inspect.InspectFields(func(field *ast.Field, _ []ast.Node, _ extractjsontags.FieldTagInfo, markersAccess markers.Markers) {
-		if len(field.Names) == 0 {
-			return
-		}
 		checkField(pass, field, markersAccess)
 	})
 
+	inspect.InspectTypeSpec(func(typeSpec *ast.TypeSpec, markersAccess markers.Markers) {
+		checkTypeSpec(pass, typeSpec, markersAccess)
+	})
+
 	return nil, nil //nolint:nilnil
 }
 
 func checkField(pass *analysis.Pass, field *ast.Field, markersAccess markers.Markers) {
-	set := markersAccess.FieldMarkers(field)
+	if field == nil || len(field.Names) == 0 {
+		return
+	}
+
+	fieldMarkers := markersAccess.FieldMarkers(field)
 
-	fieldName := field.Names[0].Name
+	set := sets.New[string]()
+
+	for _, marker := range fieldMarkers.UnsortedList() {
+		if !set.Has(marker.String()) {
+			set.Insert(marker.String())
+			continue
+		}
 
-	for _, marker := range set.UnsortedList() {
-		// TODO: Add check whether the marker is a duuplicate or not.
 		pass.Report(analysis.Diagnostic{
 			Pos:     field.Pos(),
-			Message: fmt.Sprintf("%s has duplicated markers %s", fieldName, marker.String()),
-			SuggestedFixes: []analysis.SuggestedFix{
-				{
-					Message: fmt.Sprintf("should remove `// +%s`", marker.String()),
-					TextEdits: []analysis.TextEdit{
-						{
-							Pos:     marker.Pos,
-							End:     marker.End,
-							NewText: nil,
-						},
-					},
-				},
-			},
+			Message: fmt.Sprintf("%s has duplicated markers %s", field.Names[0].Name, marker.String()),
+		})
+	}
+}
+
+func checkTypeSpec(pass *analysis.Pass, typeSpec *ast.TypeSpec, markersAccess markers.Markers) {
+	if typeSpec == nil {
+		return
+	}
+
+	typeMarkers := markersAccess.TypeMarkers(typeSpec)
+
+	set := sets.New[string]()
+
+	for _, marker := range typeMarkers.UnsortedList() {
+		if !set.Has(marker.String()) {
+			set.Insert(marker.String())
+			continue
+		}
+
+		pass.Report(analysis.Diagnostic{
+			Pos:     typeSpec.Pos(),
+			Message: fmt.Sprintf("%s has duplicated markers %s", typeSpec.Name.Name, marker.String()),
 		})
 	}
 }

pkg/analysis/duplicatemarkers/doc.go

@@ -15,6 +15,22 @@ limitations under the License.
 */
 
 /*
-duplicatemarkers is an analyzer that checks for duplicated markers in the code.
+duplicatemarkers is an analyzer that checks for duplicate markers in the API types.
+
+It reports only if the marker and value together are completely unique now. For example, the `duplicatemarkers` will not diagnose the field has kubebuilder:validation:MaxLength=10 and kubebuilder:validation:MaxLength=11
+
+Example:
+
+	type Foo struct {
+		// +kubebuilder:validation:MaxLength=10
+		// +kubebuilder:validation:MaxLength=11
+		Field string `json:"field"`
+	}
+
+	// +kubebuilder:validation:MaxLength=10
+	// +kubebuilder:validation:MaxLength=11
+	type Bar string
+
+About the duplicated markers which has different value, it requires specific rule for each marker, these are processed by its corresponding linter.
 */
 package duplicatemarkers

pkg/analysis/duplicatemarkers/testdata/src/a/a.go

@@ -10,7 +10,7 @@ type Enum string // want "Enum has duplicated markers kubebuilder:validation:Enu
 
 // +kubebuilder:validation:MaxLength=10
 // +kubebuilder:validation:MaxLength=11
-type MaxLength int // want "MaxLength has duplicated markers kubebuilder:validation:MaxLength"
+type MaxLength int
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
@@ -43,14 +43,14 @@ type DuplicateMarkerSpec struct { // want "DuplicateMarkerSpec has duplicated ma
 
 	// +kubebuilder:validation:MaxLength=11
 	// +kubebuilder:validation:MaxLength=10
-	DuplicatedMaxlength int `json:"maxlength"` // want "DuplicatedMaxlength has duplicated markers kubebuilder:validation:MaxLength"
+	DuplicatedMaxlength int `json:"maxlength"`
 
 	// +listType=map
 	// +listMapKey=primaryKey
 	// +listMapKey=secondaryKey
 	// +listType=map
 	// +required
-	DuplicatedListTypeMap Map `json:"duplicatedListTypeMap"` // want "DuplicatedListTypeMap has duplicated markers listType=map, listMapKey=primaryKey, listMapKey=secondaryKey"
+	DuplicatedListTypeMap Map `json:"duplicatedListTypeMap"` // want "DuplicatedListTypeMap has duplicated markers listType=map"
 
 	// +optional
 	// +kubebuilder:validation:XValidation:rule="self >= 1 && self <= 3",message="must be 1 to 5"