fix: align rule implementations with typescript-eslint (#502)

Author: fansenze

internal/plugins/typescript/rules/ban_ts_comment/ban_ts_comment.go

@@ -237,13 +237,10 @@ func checkComment(ctx rule.RuleContext, commentText string, commentStart int, co
 		afterDirective = withoutClosing
 	}
 
-	// Check if there's a description
+	// Description is everything after the directive, trimmed of whitespace only.
+	// Separators like ':' and '--' are part of the description (included in length).
 	description := strings.TrimSpace(afterDirective)
 
-	// Remove leading separators (: -- etc.)
-	description = strings.TrimLeft(description, ": \t-")
-	description = strings.TrimSpace(description)
-
 	// Special case: for ts-ignore with no description allowed, suggest ts-expect-error
 	if directiveType == "ignore" && !config.AllowWithDescription {
 		ctx.ReportRange(
@@ -268,28 +265,15 @@ func checkComment(ctx rule.RuleContext, commentText string, commentStart int, co
 		return
 	}
 
-	// If description is required
+	// If description is required, check minimum length (handles both empty and too-short)
 	if config.AllowWithDescription {
-		// Check if description exists
-		if len(description) == 0 {
-			ctx.ReportRange(
-				core.NewTextRange(commentStart, commentStart+len(commentText)),
-				rule.RuleMessage{
-					Id:          "tsDirectiveCommentRequiresDescription",
-					Description: "Include a description after the '@" + directiveName + "' directive to explain why the '@" + directiveName + "' is necessary. The description must be " + formatMinimumDescLength(minDescLength) + " characters long.",
-				},
-			)
-			return
-		}
-
-		// Check minimum description length (counting grapheme clusters for Unicode)
 		descLength := graphemeLength(description)
 		if descLength < minDescLength {
 			ctx.ReportRange(
 				core.NewTextRange(commentStart, commentStart+len(commentText)),
 				rule.RuleMessage{
-					Id:          "tsDirectiveCommentDescriptionNotMatchPattern",
-					Description: "The description for the '@" + directiveName + "' directive must be " + formatMinimumDescLength(minDescLength) + " characters long.",
+					Id:          "tsDirectiveCommentRequiresDescription",
+					Description: "Include a description after the '@" + directiveName + "' directive to explain why the '@" + directiveName + "' is necessary. The description must be " + formatMinimumDescLength(minDescLength) + " characters long.",
 				},
 			)
 			return
@@ -299,10 +283,7 @@ func checkComment(ctx rule.RuleContext, commentText string, commentStart int, co
 		if config.DescriptionFormat != "" {
 			formatRegex, err := regexp.Compile(config.DescriptionFormat)
 			if err == nil {
-				// For format checking, we need to check the original afterDirective text
-				// to preserve the exact format (including leading colons, etc.)
-				checkText := strings.TrimSpace(afterDirective)
-				if !formatRegex.MatchString(checkText) {
+				if !formatRegex.MatchString(description) {
 					ctx.ReportRange(
 						core.NewTextRange(commentStart, commentStart+len(commentText)),
 						rule.RuleMessage{

internal/plugins/typescript/rules/ban_ts_comment/ban_ts_comment_test.go

@@ -26,6 +26,15 @@ func TestBanTsCommentRule(t *testing.T) {
 		{Code: "// @ts-expect-error: This is a very long description that exceeds minimum\nconst a = 0;", Options: map[string]interface{}{"ts-expect-error": "allow-with-description", "minimumDescriptionLength": 10}},
 		{Code: "// @ts-expect-error 0123456789012345678901\nconst a = 0;", Options: map[string]interface{}{"ts-expect-error": "allow-with-description", "minimumDescriptionLength": 21}},
 
+		// Description length includes colon separator (": ab" = 4 chars >= 3)
+		{Code: "// @ts-expect-error: ab\nconst a = 0;", Options: map[string]interface{}{"ts-expect-error": "allow-with-description"}},
+		// Description length includes dash separator ("-- ab" = 5 chars >= 3)
+		{Code: "// @ts-expect-error -- ab\nconst a = 0;", Options: map[string]interface{}{"ts-expect-error": "allow-with-description"}},
+		// Colon with single char (": a" = 3 chars, exactly at minimum)
+		{Code: "// @ts-expect-error: a\nconst a = 0;", Options: map[string]interface{}{"ts-expect-error": "allow-with-description"}},
+		// Multi-line with colon separator
+		{Code: "/* @ts-expect-error: ab */\nconst a = 0;", Options: map[string]interface{}{"ts-expect-error": "allow-with-description"}},
+
 		// ts-expect-error - description format
 		{Code: "// @ts-expect-error: TS1234 because reasons\nconst a = 0;", Options: map[string]interface{}{"ts-expect-error": map[string]interface{}{"descriptionFormat": "^: TS\\d+ because .+$"}}},
 		{Code: "// @ts-expect-error: TS2345 because type mismatch\nconst a = 0;", Options: map[string]interface{}{"ts-expect-error": map[string]interface{}{"descriptionFormat": "^: TS\\d+ because .+$"}}},
@@ -96,17 +105,41 @@ func TestBanTsCommentRule(t *testing.T) {
 
 		// ts-expect-error - description too short
 		{
-			Code:    "// @ts-expect-error: ab\nconst a = 0;",
+			Code:    "// @ts-expect-error ab\nconst a = 0;",
 			Options: map[string]interface{}{"ts-expect-error": "allow-with-description"},
 			Errors: []rule_tester.InvalidTestCaseError{
-				{MessageId: "tsDirectiveCommentDescriptionNotMatchPattern"},
+				{MessageId: "tsDirectiveCommentRequiresDescription"},
 			},
 		},
 		{
 			Code:    "// @ts-expect-error 0123456789012345678\nconst a = 0;",
 			Options: map[string]interface{}{"ts-expect-error": "allow-with-description", "minimumDescriptionLength": 21},
 			Errors: []rule_tester.InvalidTestCaseError{
-				{MessageId: "tsDirectiveCommentDescriptionNotMatchPattern"},
+				{MessageId: "tsDirectiveCommentRequiresDescription"},
+			},
+		},
+		// Just colon, no real description (length 1 < 3)
+		{
+			Code:    "// @ts-expect-error:\nconst a = 0;",
+			Options: map[string]interface{}{"ts-expect-error": "allow-with-description"},
+			Errors: []rule_tester.InvalidTestCaseError{
+				{MessageId: "tsDirectiveCommentRequiresDescription"},
+			},
+		},
+		// Just dashes, too short (length 2 < 3)
+		{
+			Code:    "// @ts-expect-error --\nconst a = 0;",
+			Options: map[string]interface{}{"ts-expect-error": "allow-with-description"},
+			Errors: []rule_tester.InvalidTestCaseError{
+				{MessageId: "tsDirectiveCommentRequiresDescription"},
+			},
+		},
+		// Colon + space only (": " trimmed to ":" = length 1 < 3)
+		{
+			Code:    "// @ts-expect-error: \nconst a = 0;",
+			Options: map[string]interface{}{"ts-expect-error": "allow-with-description"},
+			Errors: []rule_tester.InvalidTestCaseError{
+				{MessageId: "tsDirectiveCommentRequiresDescription"},
 			},
 		},
 
@@ -133,12 +166,12 @@ func TestBanTsCommentRule(t *testing.T) {
 			},
 		},
 
-		// ts-expect-error - Unicode/emoji too short
+		// ts-expect-error - Unicode/emoji too short (": 💩💩💩" = 6 runes, but with minimumDescriptionLength: 8)
 		{
 			Code:    "// @ts-expect-error: 💩💩💩\nconst a = 0;",
-			Options: map[string]interface{}{"ts-expect-error": "allow-with-description", "minimumDescriptionLength": 4},
+			Options: map[string]interface{}{"ts-expect-error": "allow-with-description", "minimumDescriptionLength": 8},
 			Errors: []rule_tester.InvalidTestCaseError{
-				{MessageId: "tsDirectiveCommentDescriptionNotMatchPattern"},
+				{MessageId: "tsDirectiveCommentRequiresDescription"},
 			},
 		},