chore: update lint rules for comments

web/eslint-plugins/__tests__/comments-english.test.ts

@@ -3,12 +3,14 @@
 //
 // Pure AST check over comment nodes with an ASCII whitelist; string literals
 // are ignored by construction (they are not comments), which the cases below
-// pin down.
+// pin down. .svelte gets its own pass: template `<!-- -->` comments are AST
+// nodes (SvelteHTMLComment), not comment tokens, so they need a svelte parser.
 import { RuleTester } from "eslint";
+import svelteParser from "svelte-eslint-parser";
 import tseslint from "typescript-eslint";
 import { describe, it } from "vitest";
 import commentsEnglish from "../conventions/comments-english.js";
-import { asRuleModule } from "./helpers.js";
+import { asRuleModule, svelteComponent } from "./helpers.js";
 
 RuleTester.describe = describe;
 RuleTester.it = it;
@@ -19,6 +21,13 @@ const tester = new RuleTester({
 	},
 });
 
+const svelteTester = new RuleTester({
+	languageOptions: {
+		parser: svelteParser,
+		parserOptions: { parser: tseslint.parser },
+	},
+});
+
 tester.run("comments-english", asRuleModule(commentsEnglish), {
 	valid: [
 		{ code: "// resize the canvas\nconst x = 1;", filename: "a.ts" },
@@ -94,3 +103,77 @@ tester.run("comments-english", asRuleModule(commentsEnglish), {
 		},
 	],
 });
+
+// Svelte components: both comment kinds are in scope. `<script>` comments
+// come in as ordinary comment tokens; template `<!-- -->` comments only exist
+// as SvelteHTMLComment nodes, which is the case the ts pass cannot reach.
+svelteTester.run("comments-english (svelte)", asRuleModule(commentsEnglish), {
+	valid: [
+		{
+			code: "<!-- resize the canvas -->\n<main>Hello</main>",
+			filename: "Component.svelte",
+		},
+		{
+			code: svelteComponent("// resize the canvas"),
+			filename: "Component.svelte",
+		},
+		{
+			code: '<!-- svelte-ignore a11y_missing_attribute -->\n<main lang="en">Hello</main>',
+			filename: "Component.svelte",
+		},
+		{
+			// allowChars applies to template comments too.
+			code: "<!-- size 512×512 -->\n<main>Hello</main>",
+			filename: "Component.svelte",
+			options: [{ allowChars: ["×"] }],
+		},
+		{
+			// CSS comments in <style> are checked as well, ASCII passes.
+			code: '<div class="x">hi</div>\n<style>\n/* keep the row height stable */\n.x {\n\tcolor: red;\n}\n</style>',
+			filename: "Component.svelte",
+		},
+	],
+	invalid: [
+		{
+			// The template comment the ts pass could never see.
+			code: "<!-- русский комментарий -->\n<main>Hello</main>",
+			filename: "Component.svelte",
+			errors: [{ messageId: "nonAscii" }],
+		},
+		{
+			// <style> is a postcss AST, so its comments are invisible to
+			// getAllComments(); the loc must still point at the real line.
+			code: '<div class="x">hi</div>\n<style>\n/* русский комментарий в стилях */\n.x {\n\tcolor: red;\n}\n</style>',
+			filename: "Component.svelte",
+			errors: [{ messageId: "nonAscii", line: 3 }],
+		},
+		{
+			// All three comment kinds in one component, reported by position.
+			code: '<!-- раз -->\n<style>\n/* два */\n.x {\n\tcolor: red;\n}\n</style>\n<script lang="ts">\n// три\n</script>',
+			filename: "Component.svelte",
+			errors: [
+				{ messageId: "nonAscii", line: 1 },
+				{ messageId: "nonAscii", line: 3 },
+				{ messageId: "nonAscii", line: 9 },
+			],
+		},
+		{
+			code: svelteComponent("// ресайз холста"),
+			filename: "Component.svelte",
+			errors: [{ messageId: "nonAscii" }],
+		},
+		{
+			// One report per comment, script and template alike.
+			code: '<!-- раз -->\n<main>два</main>\n<script lang="ts">\n// три\n</script>',
+			filename: "Component.svelte",
+			errors: [{ messageId: "nonAscii" }, { messageId: "nonAscii" }],
+		},
+		{
+			// allowChars does not whitelist other glyphs in the same comment.
+			code: "<!-- 512×512 → done -->\n<main>Hello</main>",
+			filename: "Component.svelte",
+			options: [{ allowChars: ["×"] }],
+			errors: [{ messageId: "nonAscii" }],
+		},
+	],
+});