Skip to content

Commit 742f7c6

Browse files
committed
docs(no-useless-children-snippet): added rule documentation
1 parent 5da3e86 commit 742f7c6

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed
+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
pageClass: 'rule-details'
3+
sidebarDepth: 0
4+
title: 'svelte/no-useless-children-snippet'
5+
description: "disallow explicit children snippet where it's not needed"
6+
---
7+
8+
# svelte/no-useless-children-snippet
9+
10+
> disallow explicit children snippet where it's not needed
11+
12+
- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> **_This rule has not been released yet._** </badge>
13+
14+
## :book: Rule Details
15+
16+
Any content inside component tags that is not a snippet declaration implicitly becomes part of the children snippet. Thus, declaring the children snippet explicitly is only necessary when the snippet has parameters.
17+
18+
<!--eslint-skip-->
19+
20+
```svelte
21+
<script>
22+
/* eslint svelte/no-useless-children-snippet: "error" */
23+
24+
import { Foo } from './Foo.svelte';
25+
</script>
26+
27+
<!-- ✓ GOOD -->
28+
<Foo>
29+
{#snippet bar()}
30+
Hello
31+
{/snippet}
32+
</Foo>
33+
34+
<Foo>
35+
{#snippet children(val)}
36+
Hello {val}
37+
{/snippet}
38+
</Foo>
39+
40+
<Foo>Hello</Foo>
41+
42+
<!-- ✗ BAD -->
43+
<Foo>
44+
{#snippet children()}
45+
Hello
46+
{/snippet}
47+
</Foo>
48+
```
49+
50+
## :wrench: Options
51+
52+
Nothing.
53+
54+
## :mag: Implementation
55+
56+
- [Rule source](https://github.com/sveltejs/eslint-plugin-svelte/blob/main/packages/eslint-plugin-svelte/src/rules/no-useless-children-snippet.ts)
57+
- [Test source](https://github.com/sveltejs/eslint-plugin-svelte/blob/main/packages/eslint-plugin-svelte/tests/src/rules/no-useless-children-snippet.ts)

0 commit comments

Comments
 (0)