Skip to content

Commit f478d65

Browse files
authored
Update documents (#1301)
* Update documentations * updatte * update docs
1 parent 990e13e commit f478d65

20 files changed

+82
-108
lines changed

Diff for: README.md

-8
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,6 @@
1111

1212
See [the official website](https://eslint.vuejs.org).
1313

14-
> :exclamation: Attention - this is documentation for version `7.x` :exclamation:
15-
>
16-
> This branch contains `eslint-plugin-vue@next` which is a pre-released `7.0`, but it's not the default version that you get with `npm install eslint-plugin-vue`. In order to install this you need to specify either `"eslint-plugin-vue": "next"` in `package.json` or do `npm install eslint-plugin-vue@next`.
17-
>
18-
> Please try it and report any issues that you might have encountered.
19-
>
20-
> If you want to check previous releases [go here](https://github.com/vuejs/eslint-plugin-vue/releases).
21-
2214
## :anchor: Versioning Policy
2315

2416
This plugin is following [Semantic Versioning](https://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).

Diff for: docs/.vuepress/theme/index.js

-3
This file was deleted.

Diff for: docs/.vuepress/theme/layouts/Layout.vue

-77
This file was deleted.

Diff for: docs/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ This plugin allows us to check the `<template>` and `<script>` of `.vue` files w
1414

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

17+
:::warning Status of Vue.js 3.x supports
18+
This plugin supports the basic syntax of Vue.js 3.0, but the Vue.js 3.0 experimental features `<script setup>` and `<style vars>` are not yet supported. Follow [#1248](https://github.com/vuejs/eslint-plugin-vue/issues/1248) for more details.
19+
:::
20+
1721
## :traffic_light: Versioning policy
1822

1923
This plugin is following [Semantic Versioning](https://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).

Diff for: docs/rules/attributes-order.md

+1-1
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://v3.vuejs.org/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.js Style Guide](https://v3.vuejs.org/style-guide/#element-attribute-order-recommended) and is:
1616

1717
- `DEFINITION`
1818
e.g. 'is', 'v-is'

Diff for: docs/rules/match-component-file-name.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ export default {
306306

307307
## :books: Further Reading
308308

309-
- [Style guide - Single-file component filename casing](https://v3.vuejs.org/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

Diff for: docs/rules/no-deprecated-data-object-declaration.md

+3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ description: disallow using deprecated object declaration on data (in Vue.js 3.0
1515
This rule reports use of deprecated object declaration on `data` property (in Vue.js 3.0.0+).
1616
The different from `vue/no-shared-component-data` is the root instance being also disallowed.
1717

18+
See [Migration Guide - Data Option](https://v3.vuejs.org/guide/migration/data-option.html) for more details.
19+
1820
<eslint-code-block fix :rules="{'vue/no-deprecated-data-object-declaration': ['error']}" language="javascript" filename="example.js">
1921

2022
```js
@@ -75,6 +77,7 @@ Nothing.
7577

7678
## :books: Further Reading
7779

80+
- [Migration Guide - Data Option](https://v3.vuejs.org/guide/migration/data-option.html)
7881
- [Vue RFCs - 0019-remove-data-object-declaration](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0019-remove-data-object-declaration.md)
7982

8083
## :mag: Implementation

Diff for: docs/rules/no-deprecated-dollar-scopedslots-api.md

+3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ description: disallow using deprecated `$scopedSlots` (in Vue.js 3.0.0+)
1414

1515
This rule reports use of deprecated `$scopedSlots`. (in Vue.js 3.0.0+).
1616

17+
See [Migration Guide - Slots Unification](https://v3.vuejs.org/guide/migration/slots-unification.html) for more details.
18+
1719
<eslint-code-block fix :rules="{'vue/no-deprecated-dollar-scopedslots-api': ['error']}">
1820

1921
```vue
@@ -39,6 +41,7 @@ Nothing.
3941

4042
## :books: Further Reading
4143

44+
- [Migration Guide - Slots Unification](https://v3.vuejs.org/guide/migration/slots-unification.html)
4245
- [Vue RFCs - 0006-slots-unification](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0006-slots-unification.md)
4346

4447
## :mag: Implementation

Diff for: docs/rules/no-deprecated-events-api.md

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ description: disallow using deprecated events api (in Vue.js 3.0.0+)
1313

1414
This rule reports use of deprecated `$on`, `$off` `$once` api. (in Vue.js 3.0.0+).
1515

16+
See [Migration Guide - Events API](https://v3.vuejs.org/guide/migration/events-api.html) for more details.
17+
1618
<eslint-code-block :rules="{'vue/no-deprecated-events-api': ['error']}">
1719

1820
```vue
@@ -57,6 +59,7 @@ Nothing.
5759

5860
## :books: Further Reading
5961

62+
- [Migration Guide - Events API](https://v3.vuejs.org/guide/migration/events-api.html)
6063
- [Vue RFCs - 0020-events-api-change](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0020-events-api-change.md)
6164

6265
## :mag: Implementation

Diff for: docs/rules/no-deprecated-filter.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ description: disallow using deprecated filters syntax (in Vue.js 3.0.0+)
1111

1212
## :book: Rule Details
1313

14-
This rule reports deprecated `filters` syntax (removed in Vue.js v3.0.0+)
14+
This rule reports deprecated `filters` syntax (removed in Vue.js v3.0.0+).
15+
16+
See [Migration Guide - Filters](https://v3.vuejs.org/guide/migration/filters.html) for more details.
1517

1618
<eslint-code-block :rules="{'vue/no-deprecated-filter': ['error']}">
1719

@@ -43,6 +45,7 @@ Nothing.
4345

4446
## :books: Further Reading
4547

48+
- [Migration Guide - Filters](https://v3.vuejs.org/guide/migration/filters.html)
4649
- [Vue RFCs - 0015-remove-filters](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0015-remove-filters.md)
4750

4851
## :mag: Implementation

Diff for: docs/rules/no-deprecated-functional-template.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ description: disallow using deprecated the `functional` template (in Vue.js 3.0.
1111

1212
## :book: Rule Details
1313

14-
This rule reports deprecated the `functional` template (in Vue.js 3.0.0+)
14+
This rule reports deprecated the `functional` template (in Vue.js 3.0.0+).
15+
16+
See [Migration Guide - Functional Components](https://v3.vuejs.org/guide/migration/functional-components.html) for more details.
1517

1618
<eslint-code-block :rules="{'vue/no-deprecated-functional-template': ['error']}">
1719

@@ -30,6 +32,7 @@ Nothing.
3032

3133
## :books: Further Reading
3234

35+
- [Migration Guide - Functional Components](https://v3.vuejs.org/guide/migration/functional-components.html)
3336
- [Vue RFCs - 0007-functional-async-api-change](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0007-functional-async-api-change.md)
3437
- [Guide - Functional Components](https://vuejs.org/v2/guide/render-function.html#Functional-Components)
3538

Diff for: docs/rules/no-deprecated-html-element-is.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ description: disallow using deprecated the `is` attribute on HTML elements (in V
1111

1212
## :book: Rule Details
1313

14-
This rule reports deprecated the `is` attribute on HTML elements (removed in Vue.js v3.0.0+)
14+
This rule reports deprecated the `is` attribute on HTML elements (removed in Vue.js v3.0.0+).
15+
16+
See [Migration Guide - Custom Elements Interop](https://v3.vuejs.org/guide/migration/custom-elements-interop.html#customized-built-in-elements) for more details.
1517

1618
<eslint-code-block :rules="{'vue/no-deprecated-html-element-is': ['error']}">
1719

@@ -35,6 +37,7 @@ Nothing.
3537

3638
## :books: Further Reading
3739

40+
- [Migration Guide - Custom Elements Interop](https://v3.vuejs.org/guide/migration/custom-elements-interop.html#customized-built-in-elements)
3841
- [Vue RFCs - 0027-custom-elements-interop](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0027-custom-elements-interop.md)
3942

4043
## :mag: Implementation

Diff for: docs/rules/no-deprecated-inline-template.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ description: disallow using deprecated `inline-template` attribute (in Vue.js 3.
1111

1212
## :book: Rule Details
1313

14-
This rule reports deprecated `inline-template` attributes (removed in Vue.js v3.0.0+)
14+
This rule reports deprecated `inline-template` attributes (removed in Vue.js v3.0.0+).
15+
16+
See [Migration Guide - Inline Template Attribute](https://v3.vuejs.org/guide/migration/inline-template-attribute.html) for more details.
1517

1618
<eslint-code-block :rules="{'vue/no-deprecated-inline-template': ['error']}">
1719

@@ -38,6 +40,7 @@ Nothing.
3840

3941
## :books: Further Reading
4042

43+
- [Migration Guide - Inline Template Attribute](https://v3.vuejs.org/guide/migration/inline-template-attribute.html)
4144
- [Vue RFCs - 0016-remove-inline-templates](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0016-remove-inline-templates.md)
4245

4346
## :mag: Implementation

Diff for: docs/rules/no-deprecated-v-bind-sync.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ description: disallow use of deprecated `.sync` modifier on `v-bind` directive (
1212

1313
## :book: Rule Details
1414

15-
This rule reports use of deprecated `.sync` modifier on `v-bind` directive (in Vue.js 3.0.0+)
15+
This rule reports use of deprecated `.sync` modifier on `v-bind` directive (in Vue.js 3.0.0+).
16+
17+
See [Migration Guide - `v-model`](https://v3.vuejs.org/guide/migration/v-model.html) for more details.
1618

1719
<eslint-code-block fix :rules="{'vue/no-deprecated-v-bind-sync': ['error']}">
1820

@@ -45,6 +47,7 @@ Nothing.
4547

4648
## :books: Further Reading
4749

50+
- [Migration Guide - `v-model`](https://v3.vuejs.org/guide/migration/v-model.html)
4851
- [Vue RFCs - 0005-replace-v-bind-sync-with-v-model-argument](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0005-replace-v-bind-sync-with-v-model-argument.md)
4952

5053
## :mag: Implementation

Diff for: docs/rules/no-deprecated-v-on-number-modifiers.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ description: disallow using deprecated number (keycode) modifiers (in Vue.js 3.0
1212

1313
## :book: Rule Details
1414

15-
This rule reports use of deprecated `KeyboardEvent.keyCode` modifier on `v-on` directive (in Vue.js 3.0.0+)
15+
This rule reports use of deprecated `KeyboardEvent.keyCode` modifier on `v-on` directive (in Vue.js 3.0.0+).
16+
17+
See [Migration Guide - KeyCode Modifiers](https://v3.vuejs.org/guide/migration/keycode-modifiers.html) for more details.
1618

1719
<eslint-code-block fix :rules="{'vue/no-deprecated-v-on-number-modifiers': ['error']}">
1820

@@ -44,6 +46,7 @@ Nothing.
4446

4547
## :books: Further Reading
4648

49+
- [Migration Guide - KeyCode Modifiers](https://v3.vuejs.org/guide/migration/keycode-modifiers.html)
4750
- [Vue RFCs - 0014-drop-keycode-support](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0014-drop-keycode-support.md)
4851

4952
## :mag: Implementation

Diff for: docs/rules/no-deprecated-vue-config-keycodes.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ description: disallow using deprecated `Vue.config.keyCodes` (in Vue.js 3.0.0+)
1111

1212
## :book: Rule Details
1313

14-
This rule reports use of deprecated `Vue.config.keyCodes` (in Vue.js 3.0.0+)
14+
This rule reports use of deprecated `Vue.config.keyCodes` (in Vue.js 3.0.0+).
15+
16+
See [Migration Guide - KeyCode Modifiers](https://v3.vuejs.org/guide/migration/keycode-modifiers.html) for more details.
1517

1618
<eslint-code-block filename="a.js" language="javascript" :rules="{'vue/no-deprecated-vue-config-keycodes': ['error']}">
1719

@@ -36,9 +38,11 @@ Nothing.
3638

3739
## :books: Further Reading
3840

41+
- [Migration Guide - KeyCode Modifiers]
3942
- [Vue RFCs - 0014-drop-keycode-support]
4043
- [API - Global Config - keyCodes]
4144

45+
[Migration Guide - KeyCode Modifiers]: https://v3.vuejs.org/guide/migration/keycode-modifiers.html
4246
[Vue RFCs - 0014-drop-keycode-support]: https://github.com/vuejs/rfcs/blob/master/active-rfcs/0014-drop-keycode-support.md
4347
[API - Global Config - keyCodes]: https://vuejs.org/v2/api/#keyCodes
4448

Diff for: docs/rules/no-shared-component-data.md

-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ Nothing.
6868

6969
## :books: Further Reading
7070

71-
7271
- [Style guide (for v2) - Component data](https://vuejs.org/v2/style-guide/#Component-data-essential)
7372
- [API - data](https://v3.vuejs.org/api/options-data.html#data-2)
7473
- [API (for v2) - data](https://v3.vuejs.org/api/options-data.html#data-2)

Diff for: docs/rules/no-v-for-template-key-on-child.md

+6
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ This rule reports the key of the `<template v-for>` placed on the child elements
1515

1616
In Vue.js 3.x, with the support for fragments, the `<template v-for>` key can be placed on the `<template>` tag.
1717

18+
See [Migration Guide - `key` attribute > With `<template v-for>`](https://v3.vuejs.org/guide/migration/key-attribute.html#with-template-v-for) for more details.
19+
1820
::: warning Note
1921
Do not use with the [vue/no-v-for-template-key] rule for Vue.js 2.x.
2022
This rule conflicts with the [vue/no-v-for-template-key] rule.
@@ -48,6 +50,10 @@ Nothing.
4850

4951
[vue/no-v-for-template-key]: ./no-v-for-template-key.md
5052

53+
## :books: Further Reading
54+
55+
- [Migration Guide - `key` attribute > With `<template v-for>`](https://v3.vuejs.org/guide/migration/key-attribute.html#with-template-v-for)
56+
5157
## :mag: Implementation
5258

5359
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-v-for-template-key-on-child.js)

0 commit comments

Comments
 (0)