Skip to content

Commit 309cace

Browse files
authored
Improve vue/multi-word-component-names rule docs (#1871)
1 parent 635c338 commit 309cace

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

Diff for: docs/rules/multi-word-component-names.md

+53
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,47 @@ export default {
7676

7777
</eslint-code-block>
7878

79+
<eslint-code-block filename="src/Todo.vue" :rules="{'vue/multi-word-component-names': ['error']}">
80+
81+
```vue
82+
<!-- filename: Todo.vue -->
83+
<!-- ✗ BAD -->
84+
<script setup>
85+
// ...
86+
</script>
87+
```
88+
89+
</eslint-code-block>
90+
91+
<eslint-code-block filename="src/TodoItem.js" :rules="{'vue/multi-word-component-names': ['error']}">
92+
93+
```vue
94+
<!-- filename: TodoItem.vue -->
95+
<!-- ✓ GOOD -->
96+
<script setup>
97+
// ...
98+
</script>
99+
```
100+
101+
</eslint-code-block>
102+
103+
<eslint-code-block filename="src/Todo.vue" :rules="{'vue/multi-word-component-names': ['error']}">
104+
105+
```vue
106+
<!-- filename: Todo.vue -->
107+
<!-- ✓ GOOD -->
108+
<script setup>
109+
// ...
110+
</script>
111+
<script>
112+
export default {
113+
name: 'TodoItem'
114+
}
115+
</script>
116+
```
117+
118+
</eslint-code-block>
119+
79120
## :wrench: Options
80121

81122
```json
@@ -116,6 +157,18 @@ export default {
116157

117158
</eslint-code-block>
118159

160+
<eslint-code-block filename="src/Todo.vue" :rules="{'vue/multi-word-component-names': ['error', {ignores: ['Todo']}]}">
161+
162+
```vue
163+
<!-- filename: Todo.vue -->
164+
<!-- ✓ GOOD -->
165+
<script setup>
166+
// ...
167+
</script>
168+
```
169+
170+
</eslint-code-block>
171+
119172
## :books: Further Reading
120173

121174
- [Style guide - Multi-word component names](https://vuejs.org/style-guide/rules-essential.html#use-multi-word-component-names)

0 commit comments

Comments
 (0)