Skip to content

Chores: Add release version of rule to docs #1386

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

Merged
merged 1 commit into from
Dec 24, 2020
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/rules/array-bracket-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce linebreaks after opening and before closing array brackets
since: v7.1.0
---
# vue/array-bracket-newline

> enforce linebreaks after opening and before closing array brackets

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [array-bracket-newline] rule but it applies t

[array-bracket-newline]: https://eslint.org/docs/rules/array-bracket-newline

## :rocket: Version

This rule was introduced in eslint-plugin-vue v7.1.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/array-bracket-newline.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/array-bracket-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce consistent spacing inside array brackets
since: v5.2.0
---
# vue/array-bracket-spacing

> enforce consistent spacing inside array brackets

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [array-bracket-spacing] rule but it applies t

[array-bracket-spacing]: https://eslint.org/docs/rules/array-bracket-spacing

## :rocket: Version

This rule was introduced in eslint-plugin-vue v5.2.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/array-bracket-spacing.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/arrow-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce consistent spacing before and after the arrow in arrow func
since: v5.2.0
---
# vue/arrow-spacing

> enforce consistent spacing before and after the arrow in arrow functions

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [arrow-spacing] rule but it applies to the ex

[arrow-spacing]: https://eslint.org/docs/rules/arrow-spacing

## :rocket: Version

This rule was introduced in eslint-plugin-vue v5.2.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/arrow-spacing.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/attribute-hyphenation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce attribute naming style on custom components in template
since: v3.9.0
---
# vue/attribute-hyphenation

> enforce attribute naming style on custom components in template

- :gear: This rule is included in all of `"plugin:vue/vue3-strongly-recommended"`, `"plugin:vue/strongly-recommended"`, `"plugin:vue/vue3-recommended"` and `"plugin:vue/recommended"`.
Expand Down Expand Up @@ -103,6 +104,10 @@ Don't use hyphenated name but allow custom attributes

</eslint-code-block>

## :rocket: Version

This rule was introduced in eslint-plugin-vue v3.9.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/attribute-hyphenation.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/attributes-order.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce order of attributes
since: v4.3.0
---
# vue/attributes-order

> enforce order of attributes

- :gear: This rule is included in `"plugin:vue/vue3-recommended"` and `"plugin:vue/recommended"`.
Expand Down Expand Up @@ -221,6 +222,10 @@ This rule aims to enforce ordering of component attributes. The default order is
- [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)

## :rocket: Version

This rule was introduced in eslint-plugin-vue v4.3.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/attributes-order.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/block-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: disallow or enforce spaces inside of blocks after opening block and
since: v5.2.0
---
# vue/block-spacing

> disallow or enforce spaces inside of blocks after opening block and before closing block

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [block-spacing] rule but it applies to the ex

[block-spacing]: https://eslint.org/docs/rules/block-spacing

## :rocket: Version

This rule was introduced in eslint-plugin-vue v5.2.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/block-spacing.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/block-tag-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce line breaks after opening and before closing block-level ta
since: v7.1.0
---
# vue/block-tag-newline

> enforce line breaks after opening and before closing block-level tags

- :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.
Expand Down Expand Up @@ -156,6 +157,10 @@ export default {

</eslint-code-block>

## :rocket: Version

This rule was introduced in eslint-plugin-vue v7.1.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/block-tag-newline.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/brace-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce consistent brace style for blocks
since: v5.2.0
---
# vue/brace-style

> enforce consistent brace style for blocks

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [brace-style] rule but it applies to the expr

[brace-style]: https://eslint.org/docs/rules/brace-style

## :rocket: Version

This rule was introduced in eslint-plugin-vue v5.2.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/brace-style.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/camelcase.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce camelcase naming convention
since: v5.2.0
---
# vue/camelcase

> enforce camelcase naming convention

This rule is the same rule as core [camelcase] rule but it applies to the expressions in `<template>`.
Expand All @@ -16,6 +17,10 @@ This rule is the same rule as core [camelcase] rule but it applies to the expres

[camelcase]: https://eslint.org/docs/rules/camelcase

## :rocket: Version

This rule was introduced in eslint-plugin-vue v5.2.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/camelcase.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/comma-dangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: require or disallow trailing commas
since: v5.2.0
---
# vue/comma-dangle

> require or disallow trailing commas

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [comma-dangle] rule but it applies to the exp

[comma-dangle]: https://eslint.org/docs/rules/comma-dangle

## :rocket: Version

This rule was introduced in eslint-plugin-vue v5.2.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/comma-dangle.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/comma-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce consistent spacing before and after commas
since: v7.0.0
---
# vue/comma-spacing

> enforce consistent spacing before and after commas

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [comma-spacing] rule but it applies to the ex

[comma-spacing]: https://eslint.org/docs/rules/comma-spacing

## :rocket: Version

This rule was introduced in eslint-plugin-vue v7.0.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/comma-spacing.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/comma-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce consistent comma style
since: v7.0.0
---
# vue/comma-style

> enforce consistent comma style

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [comma-style] rule but it applies to the expr

[comma-style]: https://eslint.org/docs/rules/comma-style

## :rocket: Version

This rule was introduced in eslint-plugin-vue v7.0.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/comma-style.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/comment-directive.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: support comment-directives in `<template>`
since: v4.1.0
---
# vue/comment-directive

> support comment-directives in `<template>`

- :gear: This rule is included in all of `"plugin:vue/base"`, `"plugin:vue/essential"`, `"plugin:vue/vue3-essential"`, `"plugin:vue/strongly-recommended"`, `"plugin:vue/vue3-strongly-recommended"`, `"plugin:vue/recommended"` and `"plugin:vue/vue3-recommended"`.
Expand Down Expand Up @@ -128,6 +129,10 @@ Unused reports cannot be suppressed with `eslint-disable` HTML comments.

[Disabling rules with inline comments]: https://eslint.org/docs/user-guide/configuring#disabling-rules-with-inline-comments

## :rocket: Version

This rule was introduced in eslint-plugin-vue v4.1.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/comment-directive.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/component-definition-name-casing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce specific casing for component definition name
since: v7.0.0
---
# vue/component-definition-name-casing

> enforce specific casing for component definition name

- :gear: This rule is included in all of `"plugin:vue/vue3-strongly-recommended"`, `"plugin:vue/strongly-recommended"`, `"plugin:vue/vue3-recommended"` and `"plugin:vue/recommended"`.
Expand Down Expand Up @@ -122,6 +123,10 @@ Vue.component('MyComponent', {

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

## :rocket: Version

This rule was introduced in eslint-plugin-vue v7.0.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/component-definition-name-casing.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/component-name-in-template-casing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce specific casing for the component naming style in template
since: v5.0.0
---
# vue/component-name-in-template-casing

> enforce specific casing for the component naming style in template

- :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.
Expand Down Expand Up @@ -144,6 +145,10 @@ export default {

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

## :rocket: Version

This rule was introduced in eslint-plugin-vue v5.0.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/component-name-in-template-casing.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/component-tags-order.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce order of component top-level elements
since: v6.1.0
---
# vue/component-tags-order

> enforce order of component top-level elements

- :gear: This rule is included in `"plugin:vue/vue3-recommended"` and `"plugin:vue/recommended"`.
Expand Down Expand Up @@ -115,6 +116,10 @@ This rule warns about the order of the `<script>`, `<template>` & `<style>` tags

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

## :rocket: Version

This rule was introduced in eslint-plugin-vue v6.1.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/component-tags-order.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/custom-event-name-casing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce specific casing for custom event name
since: v7.0.0
---
# vue/custom-event-name-casing

> enforce specific casing for custom event name

Define a style for custom event name casing for consistency purposes.
Expand Down Expand Up @@ -170,6 +171,10 @@ export default {
[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

## :rocket: Version

This rule was introduced in eslint-plugin-vue v7.0.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/custom-event-name-casing.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/dot-location.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce consistent newlines before and after dots
since: v6.0.0
---
# vue/dot-location

> enforce consistent newlines before and after dots

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [dot-location] rule but it applies to the exp

[dot-location]: https://eslint.org/docs/rules/dot-location

## :rocket: Version

This rule was introduced in eslint-plugin-vue v6.0.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/dot-location.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/dot-notation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: enforce dot notation whenever possible
since: v7.0.0
---
# vue/dot-notation

> enforce dot notation whenever possible

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [dot-notation] rule but it applies to the exp

[dot-notation]: https://eslint.org/docs/rules/dot-notation

## :rocket: Version

This rule was introduced in eslint-plugin-vue v7.0.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/dot-notation.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/eqeqeq.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: require the use of `===` and `!==`
since: v5.2.0
---
# vue/eqeqeq

> require the use of `===` and `!==`

- :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.
Expand All @@ -18,6 +19,10 @@ This rule is the same rule as core [eqeqeq] rule but it applies to the expressio

[eqeqeq]: https://eslint.org/docs/rules/eqeqeq

## :rocket: Version

This rule was introduced in eslint-plugin-vue v5.2.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/eqeqeq.js)
Expand Down
5 changes: 5 additions & 0 deletions docs/rules/experimental-script-setup-vars.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: prevent variables defined in `<script setup>` to be marked as undef
since: v7.0.0
---
# vue/experimental-script-setup-vars

> prevent variables defined in `<script setup>` to be marked as undefined

- :gear: This rule is included in all of `"plugin:vue/base"`, `"plugin:vue/essential"`, `"plugin:vue/vue3-essential"`, `"plugin:vue/strongly-recommended"`, `"plugin:vue/vue3-strongly-recommended"`, `"plugin:vue/recommended"` and `"plugin:vue/vue3-recommended"`.
Expand Down Expand Up @@ -37,6 +38,10 @@ emit('foo')

After turning on, `props` and `emit` are being marked as defined and `no-undef` rule doesn't report an issue.

## :rocket: Version

This rule was introduced in eslint-plugin-vue v7.0.0

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/experimental-script-setup-vars.js)
Expand Down
Loading