docs: update

vuejs · Nov 16, 2024 · 3f1ea34 · 3f1ea34
1 parent 235076b
commit 3f1ea34
Showing 1 changed file with 30 additions and 3 deletions.
diff --git a/docs/rules/valid-component-name.md b/docs/rules/valid-component-name.md
@@ -13,21 +13,48 @@ description: enforce consistency in component names
 
 ## :book: Rule Details
 
-This rule ....
+This rule enforces consistency in component names.
 
-<eslint-code-block :rules="{'vue/valid-component-name': ['error']}">
+<eslint-code-block :rules="{ 'vue/valid-component-name': ['error'] }">
 
 ```vue
 <template>
+  <!-- ✓ GOOD -->
+  <button/>
+  <keep-alive></keep-alive>
 
+  <!-- ✗ BAD -->
+  <custom-component />
 </template>
 ```
 
 </eslint-code-block>
 
 ## :wrench: Options
 
-Nothing.
+```json
+{
+  "vue/valid-component-name": ["error", { 
+    "allow": []
+  }]
+}
+```
+
+### `"allow"`
+
+<eslint-code-block :rules="{'vue/valid-component-name': ['error', { 'allow': ['/^custom-/'] }]}">
+
+```vue
+<template>
+  <!-- ✓ GOOD -->
+  <custom-component />
+
+  <!-- ✗ BAD -->
+  <my-component />
+</template>
+```
+
+</eslint-code-block>
 
 ## :mag: Implementation