Skip to content

Commit edb7ec5

Browse files
committed
Update extension rule descriptions
by running `npm install && npm run update`
1 parent 702e362 commit edb7ec5

36 files changed

+105
-105
lines changed

docs/rules/README.md

+35-35
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ For example:
230230
| [vue/no-multiple-objects-in-class](./no-multiple-objects-in-class.md) | disallow to pass multiple objects into array to class | | :hammer: |
231231
| [vue/no-potential-component-option-typo](./no-potential-component-option-typo.md) | disallow a potential typo in your component property | :bulb: | :hammer: |
232232
| [vue/no-ref-object-destructure](./no-ref-object-destructure.md) | disallow destructuring of ref objects that can lead to loss of reactivity | | :warning: |
233-
| [vue/no-required-prop-with-default](./no-required-prop-with-default.md) | enforce props with default values ​​to be optional | :wrench::bulb: | :warning: |
233+
| [vue/no-required-prop-with-default](./no-required-prop-with-default.md) | enforce props with default values to be optional | :wrench::bulb: | :warning: |
234234
| [vue/no-restricted-block](./no-restricted-block.md) | disallow specific block | | :hammer: |
235235
| [vue/no-restricted-call-after-await](./no-restricted-call-after-await.md) | disallow asynchronously called restricted methods | | :hammer: |
236236
| [vue/no-restricted-class](./no-restricted-class.md) | disallow specific classes in Vue components | | :warning: |
@@ -276,42 +276,42 @@ The following rules extend the rules provided by ESLint itself and apply them to
276276

277277
| Rule ID | Description | | |
278278
|:--------|:------------|:--:|:--:|
279-
| [vue/array-bracket-newline](./array-bracket-newline.md) | enforce linebreaks after opening and before closing array brackets in `<template>` | :wrench: | :lipstick: |
280-
| [vue/array-bracket-spacing](./array-bracket-spacing.md) | enforce consistent spacing inside array brackets in `<template>` | :wrench: | :lipstick: |
281-
| [vue/arrow-spacing](./arrow-spacing.md) | enforce consistent spacing before and after the arrow in arrow functions in `<template>` | :wrench: | :lipstick: |
282-
| [vue/block-spacing](./block-spacing.md) | disallow or enforce spaces inside of blocks after opening block and before closing block in `<template>` | :wrench: | :lipstick: |
283-
| [vue/brace-style](./brace-style.md) | enforce consistent brace style for blocks in `<template>` | :wrench: | :lipstick: |
284-
| [vue/camelcase](./camelcase.md) | enforce camelcase naming convention in `<template>` | | :hammer: |
285-
| [vue/comma-dangle](./comma-dangle.md) | require or disallow trailing commas in `<template>` | :wrench: | :lipstick: |
286-
| [vue/comma-spacing](./comma-spacing.md) | enforce consistent spacing before and after commas in `<template>` | :wrench: | :lipstick: |
287-
| [vue/comma-style](./comma-style.md) | enforce consistent comma style in `<template>` | :wrench: | :lipstick: |
288-
| [vue/dot-location](./dot-location.md) | enforce consistent newlines before and after dots in `<template>` | :wrench: | :lipstick: |
289-
| [vue/dot-notation](./dot-notation.md) | enforce dot notation whenever possible in `<template>` | :wrench: | :hammer: |
290-
| [vue/eqeqeq](./eqeqeq.md) | require the use of `===` and `!==` in `<template>` | :wrench: | :hammer: |
291-
| [vue/func-call-spacing](./func-call-spacing.md) | require or disallow spacing between function identifiers and their invocations in `<template>` | :wrench: | :lipstick: |
292-
| [vue/key-spacing](./key-spacing.md) | enforce consistent spacing between keys and values in object literal properties in `<template>` | :wrench: | :lipstick: |
293-
| [vue/keyword-spacing](./keyword-spacing.md) | enforce consistent spacing before and after keywords in `<template>` | :wrench: | :lipstick: |
279+
| [vue/array-bracket-newline](./array-bracket-newline.md) | Enforce linebreaks after opening and before closing array brackets in `<template>` | :wrench: | :lipstick: |
280+
| [vue/array-bracket-spacing](./array-bracket-spacing.md) | Enforce consistent spacing inside array brackets in `<template>` | :wrench: | :lipstick: |
281+
| [vue/arrow-spacing](./arrow-spacing.md) | Enforce consistent spacing before and after the arrow in arrow functions in `<template>` | :wrench: | :lipstick: |
282+
| [vue/block-spacing](./block-spacing.md) | Disallow or enforce spaces inside of blocks after opening block and before closing block in `<template>` | :wrench: | :lipstick: |
283+
| [vue/brace-style](./brace-style.md) | Enforce consistent brace style for blocks in `<template>` | :wrench: | :lipstick: |
284+
| [vue/camelcase](./camelcase.md) | Enforce camelcase naming convention in `<template>` | | :hammer: |
285+
| [vue/comma-dangle](./comma-dangle.md) | Require or disallow trailing commas in `<template>` | :wrench: | :lipstick: |
286+
| [vue/comma-spacing](./comma-spacing.md) | Enforce consistent spacing before and after commas in `<template>` | :wrench: | :lipstick: |
287+
| [vue/comma-style](./comma-style.md) | Enforce consistent comma style in `<template>` | :wrench: | :lipstick: |
288+
| [vue/dot-location](./dot-location.md) | Enforce consistent newlines before and after dots in `<template>` | :wrench: | :lipstick: |
289+
| [vue/dot-notation](./dot-notation.md) | Enforce dot notation whenever possible in `<template>` | :wrench: | :hammer: |
290+
| [vue/eqeqeq](./eqeqeq.md) | Require the use of `===` and `!==` in `<template>` | :wrench: | :hammer: |
291+
| [vue/func-call-spacing](./func-call-spacing.md) | Require or disallow spacing between function identifiers and their invocations in `<template>` | :wrench: | :lipstick: |
292+
| [vue/key-spacing](./key-spacing.md) | Enforce consistent spacing between keys and values in object literal properties in `<template>` | :wrench: | :lipstick: |
293+
| [vue/keyword-spacing](./keyword-spacing.md) | Enforce consistent spacing before and after keywords in `<template>` | :wrench: | :lipstick: |
294294
| [vue/max-len](./max-len.md) | enforce a maximum line length in `.vue` files | | :lipstick: |
295-
| [vue/multiline-ternary](./multiline-ternary.md) | enforce newlines between operands of ternary expressions in `<template>` | :wrench: | :lipstick: |
296-
| [vue/no-constant-condition](./no-constant-condition.md) | disallow constant expressions in conditions in `<template>` | | :warning: |
297-
| [vue/no-empty-pattern](./no-empty-pattern.md) | disallow empty destructuring patterns in `<template>` | | :warning: |
298-
| [vue/no-extra-parens](./no-extra-parens.md) | disallow unnecessary parentheses in `<template>` | :wrench: | :lipstick: |
295+
| [vue/multiline-ternary](./multiline-ternary.md) | Enforce newlines between operands of ternary expressions in `<template>` | :wrench: | :lipstick: |
296+
| [vue/no-constant-condition](./no-constant-condition.md) | Disallow constant expressions in conditions in `<template>` | | :warning: |
297+
| [vue/no-empty-pattern](./no-empty-pattern.md) | Disallow empty destructuring patterns in `<template>` | | :warning: |
298+
| [vue/no-extra-parens](./no-extra-parens.md) | Disallow unnecessary parentheses in `<template>` | :wrench: | :lipstick: |
299299
| [vue/no-irregular-whitespace](./no-irregular-whitespace.md) | disallow irregular whitespace in `.vue` files | | :warning: |
300-
| [vue/no-loss-of-precision](./no-loss-of-precision.md) | disallow literal numbers that lose precision in `<template>` | | :warning: |
301-
| [vue/no-restricted-syntax](./no-restricted-syntax.md) | disallow specified syntax in `<template>` | | :hammer: |
302-
| [vue/no-sparse-arrays](./no-sparse-arrays.md) | disallow sparse arrays in `<template>` | | :warning: |
303-
| [vue/no-useless-concat](./no-useless-concat.md) | disallow unnecessary concatenation of literals or template literals in `<template>` | | :hammer: |
304-
| [vue/object-curly-newline](./object-curly-newline.md) | enforce consistent line breaks after opening and before closing braces in `<template>` | :wrench: | :lipstick: |
305-
| [vue/object-curly-spacing](./object-curly-spacing.md) | enforce consistent spacing inside braces in `<template>` | :wrench: | :lipstick: |
306-
| [vue/object-property-newline](./object-property-newline.md) | enforce placing object properties on separate lines in `<template>` | :wrench: | :lipstick: |
307-
| [vue/object-shorthand](./object-shorthand.md) | require or disallow method and property shorthand syntax for object literals in `<template>` | :wrench: | :hammer: |
308-
| [vue/operator-linebreak](./operator-linebreak.md) | enforce consistent linebreak style for operators in `<template>` | :wrench: | :lipstick: |
309-
| [vue/prefer-template](./prefer-template.md) | require template literals instead of string concatenation in `<template>` | :wrench: | :hammer: |
310-
| [vue/quote-props](./quote-props.md) | require quotes around object literal property names in `<template>` | :wrench: | :hammer: |
311-
| [vue/space-in-parens](./space-in-parens.md) | enforce consistent spacing inside parentheses in `<template>` | :wrench: | :lipstick: |
312-
| [vue/space-infix-ops](./space-infix-ops.md) | require spacing around infix operators in `<template>` | :wrench: | :lipstick: |
313-
| [vue/space-unary-ops](./space-unary-ops.md) | enforce consistent spacing before or after unary operators in `<template>` | :wrench: | :lipstick: |
314-
| [vue/template-curly-spacing](./template-curly-spacing.md) | require or disallow spacing around embedded expressions of template strings in `<template>` | :wrench: | :lipstick: |
300+
| [vue/no-loss-of-precision](./no-loss-of-precision.md) | Disallow literal numbers that lose precision in `<template>` | | :warning: |
301+
| [vue/no-restricted-syntax](./no-restricted-syntax.md) | Disallow specified syntax in `<template>` | | :hammer: |
302+
| [vue/no-sparse-arrays](./no-sparse-arrays.md) | Disallow sparse arrays in `<template>` | | :warning: |
303+
| [vue/no-useless-concat](./no-useless-concat.md) | Disallow unnecessary concatenation of literals or template literals in `<template>` | | :hammer: |
304+
| [vue/object-curly-newline](./object-curly-newline.md) | Enforce consistent line breaks after opening and before closing braces in `<template>` | :wrench: | :lipstick: |
305+
| [vue/object-curly-spacing](./object-curly-spacing.md) | Enforce consistent spacing inside braces in `<template>` | :wrench: | :lipstick: |
306+
| [vue/object-property-newline](./object-property-newline.md) | Enforce placing object properties on separate lines in `<template>` | :wrench: | :lipstick: |
307+
| [vue/object-shorthand](./object-shorthand.md) | Require or disallow method and property shorthand syntax for object literals in `<template>` | :wrench: | :hammer: |
308+
| [vue/operator-linebreak](./operator-linebreak.md) | Enforce consistent linebreak style for operators in `<template>` | :wrench: | :lipstick: |
309+
| [vue/prefer-template](./prefer-template.md) | Require template literals instead of string concatenation in `<template>` | :wrench: | :hammer: |
310+
| [vue/quote-props](./quote-props.md) | Require quotes around object literal property names in `<template>` | :wrench: | :hammer: |
311+
| [vue/space-in-parens](./space-in-parens.md) | Enforce consistent spacing inside parentheses in `<template>` | :wrench: | :lipstick: |
312+
| [vue/space-infix-ops](./space-infix-ops.md) | Require spacing around infix operators in `<template>` | :wrench: | :lipstick: |
313+
| [vue/space-unary-ops](./space-unary-ops.md) | Enforce consistent spacing before or after unary operators in `<template>` | :wrench: | :lipstick: |
314+
| [vue/template-curly-spacing](./template-curly-spacing.md) | Require or disallow spacing around embedded expressions of template strings in `<template>` | :wrench: | :lipstick: |
315315

316316
</rules-table>
317317

docs/rules/array-bracket-newline.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/array-bracket-newline
5-
description: enforce linebreaks after opening and before closing array brackets in `<template>`
5+
description: Enforce linebreaks after opening and before closing array brackets in `<template>`
66
since: v7.1.0
77
---
88
# vue/array-bracket-newline
99

10-
> enforce linebreaks after opening and before closing array brackets in `<template>`
10+
> Enforce linebreaks after opening and before closing array brackets in `<template>`
1111
1212
- :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.
1313

docs/rules/array-bracket-spacing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/array-bracket-spacing
5-
description: enforce consistent spacing inside array brackets in `<template>`
5+
description: Enforce consistent spacing inside array brackets in `<template>`
66
since: v5.2.0
77
---
88
# vue/array-bracket-spacing
99

10-
> enforce consistent spacing inside array brackets in `<template>`
10+
> Enforce consistent spacing inside array brackets in `<template>`
1111
1212
- :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.
1313

docs/rules/arrow-spacing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/arrow-spacing
5-
description: enforce consistent spacing before and after the arrow in arrow functions in `<template>`
5+
description: Enforce consistent spacing before and after the arrow in arrow functions in `<template>`
66
since: v5.2.0
77
---
88
# vue/arrow-spacing
99

10-
> enforce consistent spacing before and after the arrow in arrow functions in `<template>`
10+
> Enforce consistent spacing before and after the arrow in arrow functions in `<template>`
1111
1212
- :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.
1313

docs/rules/block-spacing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/block-spacing
5-
description: disallow or enforce spaces inside of blocks after opening block and before closing block in `<template>`
5+
description: Disallow or enforce spaces inside of blocks after opening block and before closing block in `<template>`
66
since: v5.2.0
77
---
88
# vue/block-spacing
99

10-
> disallow or enforce spaces inside of blocks after opening block and before closing block in `<template>`
10+
> Disallow or enforce spaces inside of blocks after opening block and before closing block in `<template>`
1111
1212
- :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.
1313

docs/rules/brace-style.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/brace-style
5-
description: enforce consistent brace style for blocks in `<template>`
5+
description: Enforce consistent brace style for blocks in `<template>`
66
since: v5.2.0
77
---
88
# vue/brace-style
99

10-
> enforce consistent brace style for blocks in `<template>`
10+
> Enforce consistent brace style for blocks in `<template>`
1111
1212
- :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.
1313

docs/rules/camelcase.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/camelcase
5-
description: enforce camelcase naming convention in `<template>`
5+
description: Enforce camelcase naming convention in `<template>`
66
since: v5.2.0
77
---
88
# vue/camelcase
99

10-
> enforce camelcase naming convention in `<template>`
10+
> Enforce camelcase naming convention in `<template>`
1111
1212
This rule is the same rule as core [camelcase] rule but it applies to the expressions in `<template>`.
1313

docs/rules/comma-dangle.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/comma-dangle
5-
description: require or disallow trailing commas in `<template>`
5+
description: Require or disallow trailing commas in `<template>`
66
since: v5.2.0
77
---
88
# vue/comma-dangle
99

10-
> require or disallow trailing commas in `<template>`
10+
> Require or disallow trailing commas in `<template>`
1111
1212
- :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.
1313

docs/rules/comma-spacing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/comma-spacing
5-
description: enforce consistent spacing before and after commas in `<template>`
5+
description: Enforce consistent spacing before and after commas in `<template>`
66
since: v7.0.0
77
---
88
# vue/comma-spacing
99

10-
> enforce consistent spacing before and after commas in `<template>`
10+
> Enforce consistent spacing before and after commas in `<template>`
1111
1212
- :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.
1313

docs/rules/comma-style.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/comma-style
5-
description: enforce consistent comma style in `<template>`
5+
description: Enforce consistent comma style in `<template>`
66
since: v7.0.0
77
---
88
# vue/comma-style
99

10-
> enforce consistent comma style in `<template>`
10+
> Enforce consistent comma style in `<template>`
1111
1212
- :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.
1313

docs/rules/dot-location.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/dot-location
5-
description: enforce consistent newlines before and after dots in `<template>`
5+
description: Enforce consistent newlines before and after dots in `<template>`
66
since: v6.0.0
77
---
88
# vue/dot-location
99

10-
> enforce consistent newlines before and after dots in `<template>`
10+
> Enforce consistent newlines before and after dots in `<template>`
1111
1212
- :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.
1313

docs/rules/dot-notation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/dot-notation
5-
description: enforce dot notation whenever possible in `<template>`
5+
description: Enforce dot notation whenever possible in `<template>`
66
since: v7.0.0
77
---
88
# vue/dot-notation
99

10-
> enforce dot notation whenever possible in `<template>`
10+
> Enforce dot notation whenever possible in `<template>`
1111
1212
- :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.
1313

docs/rules/eqeqeq.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/eqeqeq
5-
description: require the use of `===` and `!==` in `<template>`
5+
description: Require the use of `===` and `!==` in `<template>`
66
since: v5.2.0
77
---
88
# vue/eqeqeq
99

10-
> require the use of `===` and `!==` in `<template>`
10+
> Require the use of `===` and `!==` in `<template>`
1111
1212
- :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.
1313

docs/rules/func-call-spacing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/func-call-spacing
5-
description: require or disallow spacing between function identifiers and their invocations in `<template>`
5+
description: Require or disallow spacing between function identifiers and their invocations in `<template>`
66
since: v7.0.0
77
---
88
# vue/func-call-spacing
99

10-
> require or disallow spacing between function identifiers and their invocations in `<template>`
10+
> Require or disallow spacing between function identifiers and their invocations in `<template>`
1111
1212
- :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.
1313

docs/rules/key-spacing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
pageClass: rule-details
33
sidebarDepth: 0
44
title: vue/key-spacing
5-
description: enforce consistent spacing between keys and values in object literal properties in `<template>`
5+
description: Enforce consistent spacing between keys and values in object literal properties in `<template>`
66
since: v5.2.0
77
---
88
# vue/key-spacing
99

10-
> enforce consistent spacing between keys and values in object literal properties in `<template>`
10+
> Enforce consistent spacing between keys and values in object literal properties in `<template>`
1111
1212
- :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.
1313

0 commit comments

Comments
 (0)