fix: support each blocks without an item for require-each-key rule (#…

…961)
sveltejs · Dec 29, 2024 · 117e60d · 117e60d
1 parent 2c551b2
commit 117e60d
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 1 deletion.
diff --git a/.changeset/blue-panthers-run.md b/.changeset/blue-panthers-run.md
@@ -0,0 +1,5 @@
+---
+'eslint-plugin-svelte': patch
+---
+
+fix: support each blocks without an item
diff --git a/packages/eslint-plugin-svelte/src/rules/require-each-key.ts b/packages/eslint-plugin-svelte/src/rules/require-each-key.ts
@@ -15,7 +15,9 @@ export default createRule('require-each-key', {
 	create(context) {
 		return {
 			SvelteEachBlock(node: AST.SvelteEachBlock) {
-				if (node.key == null) {
+				// No need a `key` if an each blocks without an item
+				// see: https://svelte.dev/docs/svelte/each#Each-blocks-without-an-item
+				if (node.context != null && node.key == null) {
 					context.report({
 						node,
 						messageId: 'expectedKey'

diff --git a/...lint-plugin-svelte/tests/fixtures/rules/require-each-key/valid/svelte5/_requirements.json b/...lint-plugin-svelte/tests/fixtures/rules/require-each-key/valid/svelte5/_requirements.json
@@ -0,0 +1,3 @@
+{
+	"svelte": ">=5.0.0-0"
+}
diff --git a/...ts/fixtures/rules/require-each-key/valid/svelte5/each-blocks-without-an-item-input.svelte b/...ts/fixtures/rules/require-each-key/valid/svelte5/each-blocks-without-an-item-input.svelte
@@ -0,0 +1,7 @@
+<div class="chess-board">
+	{#each { length: 8 }, rank}
+		{#each { length: 8 }}
+			{rank}
+		{/each}
+	{/each}
+</div>