Skip to content

Commit dead35e

Browse files
committed
update name-property-casing
1 parent f6d7fb4 commit dead35e

File tree

1 file changed

+50
-15
lines changed

1 file changed

+50
-15
lines changed

docs/rules/name-property-casing.md

Lines changed: 50 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,70 @@
33
- :gear: This rule is included in `"plugin:vue/strongly-recommended"` and `"plugin:vue/recommended"`.
44
- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
55

6-
Define a style for the `name` property casing for consistency purposes.
7-
86
## :book: Rule Details
97

10-
:+1: Examples of **correct** code for `PascalCase`:
8+
This rule aims at enforcing the style for the `name` property casing for consistency purposes.
9+
10+
## :wrench: Options
1111

12-
```js
13-
export default {
14-
name: 'MyComponent'
12+
```json
13+
{
14+
"vue/name-property-casing": ["error", "PascalCase" | "kebab-case"]
1515
}
1616
```
1717

18-
:+1: Examples of **correct** code for `kebab-case`:
18+
- `"PascalCase"` (default) ... Enforce the `name` property to Pascal case.
19+
- `"kebab-case"` ... Enforce the `name` property to kebab case.
1920

20-
```js
21-
export default {
22-
name: 'my-component'
23-
}
21+
### `"PascalCase"`
22+
23+
<eslint-code-block :rules="{'vue/name-property-casing': ['error']}">
24+
```
25+
<script>
26+
/* ✓ GOOD */
27+
export default {
28+
name: 'MyComponent'
29+
}
30+
</script>
2431
```
32+
</eslint-code-block>
2533

26-
## :wrench: Options
34+
<eslint-code-block :rules="{'vue/name-property-casing': ['error']}">
35+
```
36+
<script>
37+
/* ✗ BAD */
38+
export default {
39+
name: 'my-component'
40+
}
41+
</script>
42+
```
43+
</eslint-code-block>
2744

28-
Default casing is set to `PascalCase`.
45+
### `"kebab-case"`
46+
47+
<eslint-code-block :rules="{'vue/name-property-casing': ['error', 'kebab-case']}">
48+
```
49+
<script>
50+
/* ✓ GOOD */
51+
export default {
52+
name: 'my-component'
53+
}
54+
</script>
55+
```
56+
</eslint-code-block>
2957

58+
<eslint-code-block :rules="{'vue/name-property-casing': ['error', 'kebab-case']}">
3059
```
31-
"vue/name-property-casing": ["error", "PascalCase|kebab-case"]
60+
<script>
61+
/* ✗ BAD */
62+
export default {
63+
name: 'MyComponent'
64+
}
65+
</script>
3266
```
67+
</eslint-code-block>
3368

34-
## Related links
69+
## :books: Further reading
3570

3671
- [Style guide - Component name casing in JS/JSX](https://vuejs.org/v2/style-guide/#Component-name-casing-in-JS-JSX-strongly-recommended)
3772

0 commit comments

Comments
 (0)