Skip to content

Commit cd79e7f

Browse files
committed
add missing options
1 parent ea3f24b commit cd79e7f

7 files changed

+74
-7
lines changed

deploy.sh

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#!/usr/bin/env bash
2+
3+
npm run docs:build
4+
5+
# navigate into the build output directory
6+
cd docs/.vuepress/dist
7+
8+
# if you are deploying to a custom domain
9+
# echo 'www.example.com' > CNAME
10+
11+
git init
12+
git add -A
13+
git commit -m 'deploy'
14+
15+
git push -f https://github.com/armano2/eslint-plugin-vue.git master:gh-pages

docs/rules/attribute-hyphenation.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,16 @@
77

88
Default casing is set to `always` with `['data-', 'aria-', 'slot-scope']` set to be ignored
99

10-
```
11-
'vue/attribute-hyphenation': [2, 'always'|'never', { 'ignore': ['custom-prop'] }]
10+
```json
11+
{
12+
"vue/attribute-hyphenation": [2, "always" | "never", {
13+
"ignore": ["custom-prop"]
14+
}}]
15+
}
1216
```
1317

14-
### `["error", "always"]` - Use hyphenated name. (It errors on upper case letters.)
18+
### `["error", "always"]` - Use hyphenated name.
19+
It errors on upper case letters.
1520

1621
<eslint-code-block :rules="{'vue/attribute-hyphenation': ['error', 'always']}">
1722
```
@@ -25,7 +30,8 @@ Default casing is set to `always` with `['data-', 'aria-', 'slot-scope']` set to
2530
```
2631
</eslint-code-block>
2732

28-
### `["error", "never"]` - Don't use hyphenated name. (It errors on hyphens except `data-`, `aria-` and `slot-scope`.)
33+
### `["error", "never"]` - Don't use hyphenated name.
34+
It errors on hyphens except `data-`, `aria-` and `slot-scope`.
2935

3036
<eslint-code-block :rules="{'vue/attribute-hyphenation': ['error', 'never']}">
3137
```

docs/rules/attributes-order.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,28 @@ This rule aims to enforce ordering of component attributes. The default order is
8080
```
8181
</eslint-code-block>
8282

83-
### custom orders
83+
## :wrench: Options
84+
```json
85+
{
86+
"vue/attributes-order": [2, {
87+
"order": [
88+
"DEFINITION",
89+
"LIST_RENDERING",
90+
"CONDITIONALS",
91+
"RENDER_MODIFIERS",
92+
"GLOBAL",
93+
"UNIQUE",
94+
"TWO_WAY_BINDING",
95+
"OTHER_DIRECTIVES",
96+
"OTHER_ATTR",
97+
"EVENTS",
98+
"CONTENT"
99+
]
100+
}]
101+
}
102+
```
103+
104+
### Custom orders
84105

85106
#### `['LIST_RENDERING', 'CONDITIONALS', 'RENDER_MODIFIERS', 'GLOBAL', 'UNIQUE', 'TWO_WAY_BINDING', 'DEFINITION', 'OTHER_DIRECTIVES', 'OTHER_ATTR', 'EVENTS', 'CONTENT']`
86107

docs/rules/html-quotes.md

+8
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ This rule reports the quotes of attributes if it is different to configured quot
3030

3131
## :wrench: Options
3232

33+
Default is set to `double`.
34+
35+
```json
36+
{
37+
"vue/html-quotes": [2, "double" | "single"]
38+
}
39+
```
40+
3341
- `"double"` (default) ... requires double quotes.
3442
- `"single"` ... requires single quotes.
3543

docs/rules/this-in-template.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,11 @@
2424

2525
Default is set to `never`.
2626

27-
```
28-
'vue/this-in-template': [2, 'always'|'never']
27+
```json
28+
{
29+
"vue/this-in-template": [2, "always" | "never"]
30+
}
31+
2932
```
3033

3134
### `"always"` - Always use `this` while accessing properties from Vue

docs/rules/v-bind-style.md

+7
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ This rule enforces `v-bind` directive style which you should use shorthand or lo
3232
```
3333

3434
## :wrench: Options
35+
Default is set to `shorthand`.
36+
37+
```json
38+
{
39+
"vue/v-bind-style": [2, "shorthand" | "longform"]
40+
}
41+
```
3542

3643
- `"shorthand"` (default) ... requires using shorthand.
3744
- `"longform"` ... requires using long form.

docs/rules/v-on-style.md

+7
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ This rule enforces `v-on` directive style which you should use shorthand or long
3232
```
3333

3434
## :wrench: Options
35+
Default is set to `shorthand`.
36+
37+
```json
38+
{
39+
"vue/v-on-style": [2, "shorthand" | "longform"]
40+
}
41+
```
3542

3643
- `"shorthand"` (default) ... requires using shorthand.
3744
- `"longform"` ... requires using long form.

0 commit comments

Comments
 (0)