Skip to content

Commit d4cd35e

Browse files
ota-meshiota-meshi
authored
Update docs (#1252)
- Change link to documentation to v3. - Add links to the v3 documentation in the rules for v3. - format.
1 parent ce38da7 commit d4cd35e

File tree

125 files changed

+276
-273
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+276
-273
lines changed

‎docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Official ESLint plugin for Vue.js.
99
This plugin allows us to check the `<template>` and `<script>` of `.vue` files with ESLint.
1010

1111
- Finds syntax errors.
12-
- Finds the wrong use of [Vue.js Directives](https://vuejs.org/v2/api/#Directives).
13-
- Finds the violation for [Vue.js Style Guide](https://vuejs.org/v2/style-guide/).
12+
- Finds the wrong use of [Vue.js Directives](https://v3.vuejs.org/api/directives.html).
13+
- Finds the violation for [Vue.js Style Guide](https://v3.vuejs.org/style-guide/).
1414

1515
ESLint editor integrations are useful to check your code in real-time.
1616

‎docs/rules/array-bracket-spacing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: enforce consistent spacing inside array brackets
1111

1212
This rule is the same rule as core [array-bracket-spacing] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [array-bracket-spacing]
1717

‎docs/rules/arrow-spacing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: enforce consistent spacing before and after the arrow in arrow func
1111

1212
This rule is the same rule as core [arrow-spacing] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [arrow-spacing]
1717

‎docs/rules/attributes-order.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ description: enforce order of attributes
1212

1313
## :book: Rule Details
1414

15-
This rule aims to enforce ordering of component attributes. The default order is specified in the [Vue styleguide](https://vuejs.org/v2/style-guide/#Element-attribute-order-recommended) and is:
15+
This rule aims to enforce ordering of component attributes. The default order is specified in the [Vue styleguide](https://v3.vuejs.org/style-guide/#element-attribute-order-recommended) and is:
1616

1717
- `DEFINITION`
1818
e.g. 'is'
@@ -215,9 +215,10 @@ This rule aims to enforce ordering of component attributes. The default order is
215215

216216
</eslint-code-block>
217217

218-
## :books: Further reading
218+
## :books: Further Reading
219219

220-
- [Style guide - Element attribute order](https://vuejs.org/v2/style-guide/#Element-attribute-order-recommended)
220+
- [Style guide - Element attribute order](https://v3.vuejs.org/style-guide/#element-attribute-order-recommended)
221+
- [Style guide (for v2) - Element attribute order](https://vuejs.org/v2/style-guide/#Element-attribute-order-recommended)
221222

222223
## :mag: Implementation
223224

‎docs/rules/block-spacing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: disallow or enforce spaces inside of blocks after opening block and
1111

1212
This rule is the same rule as core [block-spacing] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [block-spacing]
1717

‎docs/rules/brace-style.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: enforce consistent brace style for blocks
1111

1212
This rule is the same rule as core [brace-style] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [brace-style]
1717

‎docs/rules/camelcase.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: enforce camelcase naming convention
99
1010
This rule is the same rule as core [camelcase] rule but it applies to the expressions in `<template>`.
1111

12-
## :books: Further reading
12+
## :books: Further Reading
1313

1414
- [camelcase]
1515

‎docs/rules/comma-dangle.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: require or disallow trailing commas
1111

1212
This rule is the same rule as core [comma-dangle] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [comma-dangle]
1717

‎docs/rules/comma-spacing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: enforce consistent spacing before and after commas
1111

1212
This rule is the same rule as core [comma-spacing] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [comma-spacing]
1717

‎docs/rules/comma-style.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: enforce consistent comma style
1111

1212
This rule is the same rule as core [comma-style] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [comma-style]
1717

‎docs/rules/comment-directive.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ The `eslint-disable`-like comments can include descriptions to explain why the c
121121
Unused reports cannot be suppressed with `eslint-disable` HTML comments.
122122
:::
123123

124-
## :books: Further reading
124+
## :books: Further Reading
125125

126126
- [Disabling rules with inline comments]
127127

‎docs/rules/component-definition-name-casing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,9 @@ Vue.component('MyComponent', {
117117

118118
</eslint-code-block>
119119

120-
## :books: Further reading
120+
## :books: Further Reading
121121

122-
- [Style guide - Component name casing in JS/JSX](https://vuejs.org/v2/style-guide/#Component-name-casing-in-JS-JSX-strongly-recommended)
122+
- [Style guide - Component name casing in JS/JSX](https://v3.vuejs.org/style-guide/#component-name-casing-in-js-jsx-strongly-recommended)
123123

124124
## :mag: Implementation
125125

‎docs/rules/component-name-in-template-casing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,9 @@ export default {
139139

140140
</eslint-code-block>
141141

142-
## :books: Further reading
142+
## :books: Further Reading
143143

144-
- [Style guide - Component name casing in templates](https://vuejs.org/v2/style-guide/#Component-name-casing-in-templates-strongly-recommended)
144+
- [Style guide - Component name casing in templates](https://v3.vuejs.org/style-guide/#component-name-casing-in-templates-strongly-recommended)
145145

146146
## :mag: Implementation
147147

‎docs/rules/component-tags-order.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ This rule warns about the order of the `<script>`, `<template>` & `<style>` tags
110110

111111
</eslint-code-block>
112112

113-
## :books: Further reading
113+
## :books: Further Reading
114114

115-
- [Style guide - Single-file component top-level element order](https://vuejs.org/v2/style-guide/#Single-file-component-top-level-element-order-recommended)
115+
- [Style guide - Single-file component top-level element order](https://v3.vuejs.org/style-guide/#single-file-component-top-level-element-order-recommended)
116116

117117
## :mag: Implementation
118118

‎docs/rules/custom-event-name-casing.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ Nothing.
5555

5656
- [Guide - Custom Events]
5757

58-
[Guide - Custom Events]: https://vuejs.org/v2/guide/components-custom-events.html
58+
[Guide - Custom Events]: https://v3.vuejs.org/guide/component-custom-events.html
59+
[Guide (for v2) - Custom Events]: https://vuejs.org/v2/guide/components-custom-events.html
5960

6061
## :mag: Implementation
6162

‎docs/rules/dot-location.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: enforce consistent newlines before and after dots
1111

1212
This rule is the same rule as core [dot-location] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [dot-location]
1717

‎docs/rules/dot-notation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: enforce dot notation whenever possible
1111

1212
This rule is the same rule as core [dot-notation] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [dot-notation]
1717

‎docs/rules/eqeqeq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: require the use of `===` and `!==`
1111

1212
This rule is the same rule as core [eqeqeq] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [eqeqeq]
1717

‎docs/rules/func-call-spacing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: require or disallow spacing between function identifiers and their
1111

1212
This rule is the same rule as core [func-call-spacing] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [func-call-spacing]
1717

‎docs/rules/html-closing-bracket-spacing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ This rule aims to enforce consistent spacing style before closing brackets `>` o
8181

8282
</eslint-code-block>
8383

84-
## :couple: Related rules
84+
## :couple: Related Rules
8585

8686
- [vue/no-multi-spaces](./no-multi-spaces.md)
8787
- [vue/html-closing-bracket-newline](./html-closing-bracket-newline.md)

‎docs/rules/html-comment-content-newline.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ This rule will enforce consistency of line break after the `<!--` and before the
217217

218218
</eslint-code-block>
219219

220-
## :couple: Related rules
220+
## :couple: Related Rules
221221

222222
- [vue/html-comment-indent](./html-comment-indent.md)
223223
- [vue/html-comment-content-spacing](./html-comment-content-spacing.md)

‎docs/rules/html-comment-content-spacing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Whitespace after the `<!--` and before the `-->` makes it easier to read text in
104104

105105
</eslint-code-block>
106106

107-
## :couple: Related rules
107+
## :couple: Related Rules
108108

109109
- [spaced-comment](https://eslint.org/docs/rules/spaced-comment)
110110
- [vue/html-comment-content-newline](./html-comment-content-newline.md)

‎docs/rules/html-quotes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,9 @@ Object option:
9090

9191
</eslint-code-block>
9292

93-
## :books: Further reading
93+
## :books: Further Reading
9494

95-
- [Style guide - Quoted attribute values](https://vuejs.org/v2/style-guide/#Quoted-attribute-values-strongly-recommended)
95+
- [Style guide - Quoted attribute values](https://v3.vuejs.org/style-guide/#Quoted-attribute-values-strongly-recommended)
9696

9797
## :mag: Implementation
9898

‎docs/rules/html-self-closing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,9 @@ Every option can be set to one of the following values:
9191

9292
</eslint-code-block>
9393

94-
## :books: Further reading
94+
## :books: Further Reading
9595

96-
- [Style guide - Self closing components](https://vuejs.org/v2/style-guide/#Self-closing-components-strongly-recommended)
96+
- [Style guide - Self closing components](https://v3.vuejs.org/style-guide/#Self-closing-components-strongly-recommended)
9797

9898
## :mag: Implementation
9999

‎docs/rules/key-spacing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: enforce consistent spacing between keys and values in object litera
1111

1212
This rule is the same rule as core [key-spacing] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [key-spacing]
1717

‎docs/rules/keyword-spacing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: enforce consistent spacing before and after keywords
1111

1212
This rule is the same rule as core [keyword-spacing] rule but it applies to the expressions in `<template>`.
1313

14-
## :books: Further reading
14+
## :books: Further Reading
1515

1616
- [keyword-spacing]
1717

‎docs/rules/match-component-file-name.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -304,9 +304,9 @@ export default {
304304

305305
</eslint-code-block>
306306

307-
## :books: Further reading
307+
## :books: Further Reading
308308

309-
- [Style guide - Single-file component filename casing](https://vuejs.org/v2/style-guide/#Single-file-component-filename-casing-strongly-recommended)
309+
- [Style guide - Single-file component filename casing](https://v3.vuejs.org/style-guide/#single-file-component-filename-casing-strongly-recommended)
310310

311311
## :mag: Implementation
312312

‎docs/rules/max-attributes-per-line.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,9 @@ There is a configurable number of attributes that are acceptable in one-line cas
122122

123123
</eslint-code-block>
124124

125-
## :books: Further reading
125+
## :books: Further Reading
126126

127-
- [Style guide - Multi attribute elements](https://vuejs.org/v2/style-guide/#Multi-attribute-elements-strongly-recommended)
127+
- [Style guide - Multi attribute elements](https://v3.vuejs.org/style-guide/#multi-attribute-elements-strongly-recommended)
128128

129129
## :mag: Implementation
130130

‎docs/rules/max-len.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ var longRegExpLiteral = /this is a really really really really really long regul
317317

318318
</eslint-code-block>
319319

320-
## :books: Further reading
320+
## :books: Further Reading
321321

322322
- [max-len]
323323

‎docs/rules/multiline-html-element-content-newline.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ This rule enforces a line break before and after the contents of a multiline ele
140140

141141
</eslint-code-block>
142142

143-
## :books: Further reading
143+
## :books: Further Reading
144144

145145
- [no-multiple-empty-lines]
146146

‎docs/rules/name-property-casing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ This rule aims at enforcing the style for the `name` property casing for consist
7979

8080
</eslint-code-block>
8181

82-
## :books: Further reading
82+
## :books: Further Reading
8383

84-
- [Style guide - Component name casing in JS/JSX](https://vuejs.org/v2/style-guide/#Component-name-casing-in-JS-JSX-strongly-recommended)
84+
- [Style guide - Component name casing in JS/JSX](https://v3.vuejs.org/style-guide/#component-name-casing-in-js-jsx-strongly-recommended)
8585

8686
## :mag: Implementation
8787

‎docs/rules/no-arrow-functions-in-watch.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: disallow using arrow functions to define watcher
1111

1212
## :book: Rule Details
1313

14-
This rules disallows using arrow functions to defined watcher.The reason is arrow functions bind the parent context, so `this` will not be the Vue instance as you expect.([see here for more details](https://vuejs.org/v2/api/#watch))
14+
This rules disallows using arrow functions to defined watcher.The reason is arrow functions bind the parent context, so `this` will not be the Vue instance as you expect.([see here for more details](https://v3.vuejs.org/api/options-data.html#watch))
1515

1616
<eslint-code-block :rules="{'vue/no-arrow-functions-in-watch': ['error']}">
1717

‎docs/rules/no-async-in-computed-properties.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ export default {
6464

6565
Nothing.
6666

67-
## :books: Further reading
67+
## :books: Further Reading
6868

6969
- [vue-async-computed](https://github.com/foxbenjaminfox/vue-async-computed)
7070

‎docs/rules/no-bare-strings-in-template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ If you want to report these string literals, enable the [vue/no-useless-v-bind]
7474
- `attributes` ... An object whose keys are tag name or patterns and value is an array of attributes to check for that tag name.
7575
- `directives` ... An array of directive names to check literal value.
7676

77-
## :couple: Related rules
77+
## :couple: Related Rules
7878

7979
- [vue/no-useless-v-bind]
8080
- [vue/no-useless-mustaches]

‎docs/rules/no-confusing-v-for-v-if.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -48,18 +48,18 @@ In that case, the `v-if` should be written on the wrapper element.
4848
::: warning Note
4949
When they exist on the same node, `v-for` has a higher priority than `v-if`. That means the `v-if` will be run on each iteration of the loop separately.
5050

51-
[https://vuejs.org/v2/guide/list.html#v-for-with-v-if](https://vuejs.org/v2/guide/list.html#v-for-with-v-if)
51+
[https://v3.vuejs.org/guide/list.html#v-for-with-v-if](https://v3.vuejs.org/guide/list.html#v-for-with-v-if)
5252
:::
5353

5454
## :wrench: Options
5555

5656
Nothing.
5757

58-
## :books: Further reading
58+
## :books: Further Reading
5959

60-
- [Style guide - Avoid v-if with v-for](https://vuejs.org/v2/style-guide/#Avoid-v-if-with-v-for-essential)
61-
- [Guide - Conditional / v-if with v-for](https://vuejs.org/v2/guide/conditional.html#v-if-with-v-for)
62-
- [Guide - List / v-for with v-if](https://vuejs.org/v2/guide/list.html#v-for-with-v-if)
60+
- [Style guide - Avoid v-if with v-for](https://v3.vuejs.org/style-guide/#avoid-v-if-with-v-for-essential)
61+
- [Guide - Conditional Rendering / v-if with v-for](https://v3.vuejs.org/guide/conditional.html#v-if-with-v-for)
62+
- [Guide - List Rendering / v-for with v-if](https://v3.vuejs.org/guide/list.html#v-for-with-v-if)
6363

6464
## :mag: Implementation
6565

‎docs/rules/no-custom-modifiers-on-v-model.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: disallow custom modifiers on v-model used on the component
1111

1212
This rule checks whether `v-model `used on the component do not have custom modifiers.
1313

14-
## Rule Details
14+
## :book: Rule Details
1515

1616
This rule reports `v-model` directives in the following cases:
1717

@@ -37,15 +37,15 @@ This rule reports `v-model` directives in the following cases:
3737

3838
</eslint-code-block>
3939

40-
### Options
40+
## :wrench: Options
4141

4242
Nothing.
4343

44-
## :couple: Related rules
44+
## :couple: Related Rules
4545

46-
- [valid-v-model]
46+
- [vue/valid-v-model]
4747

48-
[valid-v-model]: valid-v-model.md
48+
[vue/valid-v-model]: ./valid-v-model.md
4949

5050
## :mag: Implementation
5151

0 commit comments

Comments
 (0)