Skip to content

Commit 3f1ea34

Browse files
committed
docs: update
1 parent 235076b commit 3f1ea34

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

docs/rules/valid-component-name.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,48 @@ description: enforce consistency in component names
1313

1414
## :book: Rule Details
1515

16-
This rule ....
16+
This rule enforces consistency in component names.
1717

18-
<eslint-code-block :rules="{'vue/valid-component-name': ['error']}">
18+
<eslint-code-block :rules="{ 'vue/valid-component-name': ['error'] }">
1919

2020
```vue
2121
<template>
22+
<!-- ✓ GOOD -->
23+
<button/>
24+
<keep-alive></keep-alive>
2225
26+
<!-- ✗ BAD -->
27+
<custom-component />
2328
</template>
2429
```
2530

2631
</eslint-code-block>
2732

2833
## :wrench: Options
2934

30-
Nothing.
35+
```json
36+
{
37+
"vue/valid-component-name": ["error", {
38+
"allow": []
39+
}]
40+
}
41+
```
42+
43+
### `"allow"`
44+
45+
<eslint-code-block :rules="{'vue/valid-component-name': ['error', { 'allow': ['/^custom-/'] }]}">
46+
47+
```vue
48+
<template>
49+
<!-- ✓ GOOD -->
50+
<custom-component />
51+
52+
<!-- ✗ BAD -->
53+
<my-component />
54+
</template>
55+
```
56+
57+
</eslint-code-block>
3158

3259
## :mag: Implementation
3360

0 commit comments

Comments
 (0)