Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links in docs #1803

Merged
merged 5 commits into from Feb 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -3,7 +3,7 @@
[![NPM version](https://img.shields.io/npm/v/eslint-plugin-vue.svg?style=flat)](https://npmjs.org/package/eslint-plugin-vue)
[![NPM downloads](https://img.shields.io/npm/dm/eslint-plugin-vue.svg?style=flat)](https://npmjs.org/package/eslint-plugin-vue)
[![CircleCI](https://img.shields.io/circleci/project/github/vuejs/eslint-plugin-vue/master.svg?style=flat)](https://circleci.com/gh/vuejs/eslint-plugin-vue)
[![License](https://img.shields.io/github/license/vuejs/eslint-plugin-vue.svg?style=flat)](https://github.com/vuejs/eslint-plugin-vue/blob/master/LICENSE.md)
[![License](https://img.shields.io/github/license/vuejs/eslint-plugin-vue.svg?style=flat)](https://github.com/vuejs/eslint-plugin-vue/blob/master/LICENSE)

> Official ESLint plugin for Vue.js

Expand All @@ -29,7 +29,7 @@ Be sure to read the [official ESLint guide](https://eslint.org/docs/developer-gu

To see what an abstract syntax tree (AST) of your code looks like, you may use [AST Explorer](https://astexplorer.net). After opening [AST Explorer](https://astexplorer.net), select `Vue` as the syntax and `vue-eslint-parser` as the parser.

The default JavaScript parser must be replaced because [Vue.js single file components](https://v3.vuejs.org/guide/single-file-component.html#single-file-components) are not plain JavaScript, but a custom file format. [`vue-eslint-parser`](https://github.com/vuejs/vue-eslint-parser) is a replacement parser that generates an enhanced AST with nodes that represent specific parts of the template syntax, as well as the contents of the `<script>` tag.
The default JavaScript parser must be replaced because [Vue.js single file components](https://vuejs.org/guide/scaling-up/sfc.html) are not plain JavaScript, but a custom file format. [`vue-eslint-parser`](https://github.com/vuejs/vue-eslint-parser) is a replacement parser that generates an enhanced AST with nodes that represent specific parts of the template syntax, as well as the contents of the `<script>` tag.

To learn more about certain nodes in a produced AST, see the [ESTree project page](https://github.com/estree/estree) and the [vue-eslint-parser AST documentation](https://github.com/vuejs/vue-eslint-parser/blob/master/docs/ast.md).

Expand All @@ -46,4 +46,4 @@ If you're stuck, remember there are many rules available for reference. If you c

## :lock: License

See the [LICENSE](LICENSE) file for license rights and limitations (MIT).
See the [LICENSE](LICENSE) file for license rights and limitations (MIT).
4 changes: 2 additions & 2 deletions docs/README.md
Expand Up @@ -9,8 +9,8 @@ Official ESLint plugin for Vue.js.
This plugin allows us to check the `<template>` and `<script>` of `.vue` files with ESLint, as well as Vue code in `.js` files.

- Finds syntax errors.
- Finds the wrong use of [Vue.js Directives](https://v3.vuejs.org/api/directives.html).
- Finds the violation for [Vue.js Style Guide](https://v3.vuejs.org/style-guide/).
- Finds the wrong use of [Vue.js Directives](https://vuejs.org/api/built-in-directives.html).
- Finds the violation for [Vue.js Style Guide](https://vuejs.org/style-guide/).

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

Expand Down
6 changes: 3 additions & 3 deletions docs/rules/attributes-order.md
Expand Up @@ -14,7 +14,7 @@ since: v4.3.0

## :book: Rule Details

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:
This rule aims to enforce ordering of component attributes. The default order is specified in the [Vue.js Style Guide](https://vuejs.org/style-guide/rules-recommended.html#element-attribute-order) and is:

- `DEFINITION`
e.g. 'is', 'v-is'
Expand Down Expand Up @@ -247,8 +247,8 @@ Note that `v-bind="object"` syntax is considered to be the same as the next or p

## :books: Further Reading

- [Style guide - Element attribute order](https://v3.vuejs.org/style-guide/#element-attribute-order-recommended)
- [Style guide (for v2) - Element attribute order](https://vuejs.org/v2/style-guide/#Element-attribute-order-recommended)
- [Style guide - Element attribute order](https://vuejs.org/style-guide/rules-recommended.html#element-attribute-order)
- [Style guide (for v2) - Element attribute order](https://v2.vuejs.org/v2/style-guide/#Element-attribute-order-recommended)

## :rocket: Version

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/component-api-style.md
Expand Up @@ -79,8 +79,8 @@ export default {
```

- Array options ... Defines the API styles you want to allow. Default is `["script-setup", "composition"]`. You can use the following values.
- `"script-setup"` ... If set, allows [`<script setup>`](https://v3.vuejs.org/api/sfc-script-setup.html).
- `"composition"` ... If set, allows [Composition API](https://v3.vuejs.org/api/composition-api.html) (not `<script setup>`).
- `"script-setup"` ... If set, allows [`<script setup>`](https://vuejs.org/api/sfc-script-setup.html).
- `"composition"` ... If set, allows [Composition API](https://vuejs.org/api/#composition-api) (not `<script setup>`).
- `"composition-vue2"` ... If set, allows [Composition API for Vue 2](https://github.com/vuejs/composition-api) (not `<script setup>`). In particular, it allows `render`, `renderTracked` and `renderTriggered` alongside `setup`.
- `"options"` ... If set, allows Options API.

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/component-definition-name-casing.md
Expand Up @@ -121,7 +121,7 @@ Vue.component('MyComponent', {

## :books: Further Reading

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

## :rocket: Version

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/component-name-in-template-casing.md
Expand Up @@ -143,7 +143,7 @@ export default {

## :books: Further Reading

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

## :rocket: Version

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/component-tags-order.md
Expand Up @@ -114,7 +114,7 @@ This rule warns about the order of the `<script>`, `<template>` & `<style>` tags

## :books: Further Reading

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

## :rocket: Version

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/custom-event-name-casing.md
Expand Up @@ -168,8 +168,8 @@ export default {
- [Guide - Custom Events]
- [Guide (for v2) - Custom Events]

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

## :couple: Related Rules

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/first-attribute-linebreak.md
Expand Up @@ -156,7 +156,7 @@ This rule aims to enforce a consistent location for the first attribute.

## :books: Further Reading

- [Style guide - Multi attribute elements](https://v3.vuejs.org/style-guide/#multi-attribute-elements-strongly-recommended)
- [Style guide - Multi attribute elements](https://vuejs.org/style-guide/rules-strongly-recommended.html#multi-attribute-elements)

## :rocket: Version

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/html-quotes.md
Expand Up @@ -94,7 +94,7 @@ Object option:

## :books: Further Reading

- [Style guide - Quoted attribute values](https://v3.vuejs.org/style-guide/#Quoted-attribute-values-strongly-recommended)
- [Style guide - Quoted attribute values](https://vuejs.org/style-guide/rules-strongly-recommended.html#quoted-attribute-values)

## :rocket: Version

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/html-self-closing.md
Expand Up @@ -95,7 +95,7 @@ Every option can be set to one of the following values:

## :books: Further Reading

- [Style guide - Self closing components](https://v3.vuejs.org/style-guide/#Self-closing-components-strongly-recommended)
- [Style guide - Self closing components](https://vuejs.org/style-guide/rules-strongly-recommended.html#self-closing-components)

## :rocket: Version

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/match-component-file-name.md
Expand Up @@ -308,7 +308,7 @@ export default {

## :books: Further Reading

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

## :rocket: Version

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/max-attributes-per-line.md
Expand Up @@ -114,7 +114,7 @@ There is a configurable number of attributes that are acceptable in one-line cas

## :books: Further Reading

- [Style guide - Multi attribute elements](https://v3.vuejs.org/style-guide/#multi-attribute-elements-strongly-recommended)
- [Style guide - Multi attribute elements](https://vuejs.org/style-guide/rules-strongly-recommended.html#multi-attribute-elements)

## :rocket: Version

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/multi-word-component-names.md
Expand Up @@ -118,7 +118,7 @@ export default {

## :books: Further Reading

- [Style guide - Multi-word component names](https://v3.vuejs.org/style-guide/#multi-word-component-names-essential)
- [Style guide - Multi-word component names](https://vuejs.org/style-guide/rules-essential.html#use-multi-word-component-names)

## :rocket: Version

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/name-property-casing.md
Expand Up @@ -83,7 +83,7 @@ This rule aims at enforcing the style for the `name` property casing for consist

## :books: Further Reading

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

## :rocket: Version

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/new-line-between-multi-line-property.md
Expand Up @@ -89,7 +89,7 @@ export default {

## :books: Further Reading

- [Style guide - Empty lines in component/instance options](https://v3.vuejs.org/style-guide/#empty-lines-in-component-instance-options-recommended)
- [Style guide - Empty lines in component/instance options](https://vuejs.org/style-guide/rules-recommended.html#empty-lines-in-component-instance-options)

## :rocket: Version

Expand Down
10 changes: 5 additions & 5 deletions docs/rules/next-tick-style.md
Expand Up @@ -91,11 +91,11 @@ export default {

## :books: Further Reading

- [`Vue.nextTick` API in Vue 2](https://vuejs.org/v2/api/#Vue-nextTick)
- [`vm.$nextTick` API in Vue 2](https://vuejs.org/v2/api/#vm-nextTick)
- [Global API Treeshaking](https://v3.vuejs.org/guide/migration/global-api-treeshaking.html)
- [Global `nextTick` API in Vue 3](https://v3.vuejs.org/api/global-api.html#nexttick)
- [Instance `$nextTick` API in Vue 3](https://v3.vuejs.org/api/instance-methods.html#nexttick)
- [`Vue.nextTick` API in Vue 2](https://v2.vuejs.org/v2/api/#Vue-nextTick)
- [`vm.$nextTick` API in Vue 2](https://v2.vuejs.org/v2/api/#vm-nextTick)
- [Global API Treeshaking](https://v3-migration.vuejs.org/breaking-changes/global-api-treeshaking.html)
- [Global `nextTick` API in Vue 3](https://vuejs.org/api/general.html#nexttick)
- [Instance `$nextTick` API in Vue 3](https://vuejs.org/api/component-instance.html#nexttick)

## :rocket: Version

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-arrow-functions-in-watch.md
Expand Up @@ -13,7 +13,7 @@ since: v7.0.0

## :book: Rule Details

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))
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/api/options-state.html#watch))

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

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-child-content.md
Expand Up @@ -44,8 +44,8 @@ This rule reports child content of elements that have a directive which overwrit

## :books: Further Reading

- [`v-html` directive](https://v3.vuejs.org/api/directives.html#v-html)
- [`v-text` directive](https://v3.vuejs.org/api/directives.html#v-text)
- [`v-html` directive](https://vuejs.org/api/built-in-directives.html#v-html)
- [`v-text` directive](https://vuejs.org/api/built-in-directives.html#v-text)

## :rocket: Version

Expand Down
8 changes: 4 additions & 4 deletions docs/rules/no-confusing-v-for-v-if.md
Expand Up @@ -50,7 +50,7 @@ In that case, the `v-if` should be written on the wrapper element.
::: warning Note
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.

[https://v3.vuejs.org/guide/list.html#v-for-with-v-if](https://v3.vuejs.org/guide/list.html#v-for-with-v-if)
[https://vuejs.org/guide/essentials/list.html#v-for-with-v-if](https://vuejs.org/guide/essentials/list.html#v-for-with-v-if)
:::

## :wrench: Options
Expand All @@ -59,9 +59,9 @@ Nothing.

## :books: Further Reading

- [Style guide - Avoid v-if with v-for](https://v3.vuejs.org/style-guide/#avoid-v-if-with-v-for-essential)
- [Guide - Conditional Rendering / v-if with v-for](https://v3.vuejs.org/guide/conditional.html#v-if-with-v-for)
- [Guide - List Rendering / v-for with v-if](https://v3.vuejs.org/guide/list.html#v-for-with-v-if)
- [Style guide - Avoid v-if with v-for](https://vuejs.org/style-guide/rules-essential.html#avoid-v-if-with-v-for)
- [Guide - Conditional Rendering / v-if with v-for](https://vuejs.org/guide/essentials/conditional.html#v-if-with-v-for)
- [Guide - List Rendering / v-for with v-if](https://vuejs.org/guide/essentials/list.html#v-for-with-v-if)

## :rocket: Version

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-deprecated-data-object-declaration.md
Expand Up @@ -17,7 +17,7 @@ since: v7.0.0
This rule reports use of deprecated object declaration on `data` property (in Vue.js 3.0.0+).
The different from `vue/no-shared-component-data` is the root instance being also disallowed.

See [Migration Guide - Data Option](https://v3.vuejs.org/guide/migration/data-option.html) for more details.
See [Migration Guide - Data Option](https://v3-migration.vuejs.org/breaking-changes/data-option.html) for more details.

<eslint-code-block fix :rules="{'vue/no-deprecated-data-object-declaration': ['error']}" language="javascript" filename="example.js">

Expand Down Expand Up @@ -79,7 +79,7 @@ Nothing.

## :books: Further Reading

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

## :rocket: Version
Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-deprecated-dollar-scopedslots-api.md
Expand Up @@ -16,7 +16,7 @@ since: v7.0.0

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

See [Migration Guide - Slots Unification](https://v3.vuejs.org/guide/migration/slots-unification.html) for more details.
See [Migration Guide - Slots Unification](https://v3-migration.vuejs.org/breaking-changes/slots-unification.html) for more details.

<eslint-code-block fix :rules="{'vue/no-deprecated-dollar-scopedslots-api': ['error']}">

Expand All @@ -43,7 +43,7 @@ Nothing.

## :books: Further Reading

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

## :rocket: Version
Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-deprecated-events-api.md
Expand Up @@ -15,7 +15,7 @@ since: v7.0.0

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

See [Migration Guide - Events API](https://v3.vuejs.org/guide/migration/events-api.html) for more details.
See [Migration Guide - Events API](https://v3-migration.vuejs.org/breaking-changes/events-api.html) for more details.

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

Expand Down Expand Up @@ -61,7 +61,7 @@ Nothing.

## :books: Further Reading

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

## :rocket: Version
Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-deprecated-filter.md
Expand Up @@ -15,7 +15,7 @@ since: v7.0.0

This rule reports deprecated `filters` syntax (removed in Vue.js v3.0.0+).

See [Migration Guide - Filters](https://v3.vuejs.org/guide/migration/filters.html) for more details.
See [Migration Guide - Filters](https://v3-migration.vuejs.org/breaking-changes/filters.html) for more details.

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

Expand Down Expand Up @@ -63,7 +63,7 @@ Nothing.

## :books: Further Reading

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

## :rocket: Version
Expand Down
6 changes: 3 additions & 3 deletions docs/rules/no-deprecated-functional-template.md
Expand Up @@ -15,7 +15,7 @@ since: v7.0.0

This rule reports deprecated the `functional` template (in Vue.js 3.0.0+).

See [Migration Guide - Functional Components](https://v3.vuejs.org/guide/migration/functional-components.html) for more details.
See [Migration Guide - Functional Components](https://v3-migration.vuejs.org/breaking-changes/functional-components.html) for more details.

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

Expand All @@ -34,9 +34,9 @@ Nothing.

## :books: Further Reading

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

## :rocket: Version

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-deprecated-html-element-is.md
Expand Up @@ -15,7 +15,7 @@ since: v7.0.0

This rule reports deprecated the `is` attribute on HTML elements (removed in Vue.js v3.0.0+).

See [Migration Guide - Custom Elements Interop](https://v3.vuejs.org/guide/migration/custom-elements-interop.html#customized-built-in-elements) for more details.
See [Migration Guide - Custom Elements Interop](https://v3-migration.vuejs.org/breaking-changes/custom-elements-interop.html#customized-built-in-elements) for more details.

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

Expand All @@ -39,7 +39,7 @@ Nothing.

## :books: Further Reading

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

## :rocket: Version
Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-deprecated-inline-template.md
Expand Up @@ -15,7 +15,7 @@ since: v7.0.0

This rule reports deprecated `inline-template` attributes (removed in Vue.js v3.0.0+).

See [Migration Guide - Inline Template Attribute](https://v3.vuejs.org/guide/migration/inline-template-attribute.html) for more details.
See [Migration Guide - Inline Template Attribute](https://v3-migration.vuejs.org/breaking-changes/inline-template-attribute.html) for more details.

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

Expand All @@ -42,7 +42,7 @@ Nothing.

## :books: Further Reading

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

## :rocket: Version
Expand Down