Skip to content

Commit

Permalink
Improve documentation (#1768)
Browse files Browse the repository at this point in the history
* Improve wording in `vue/no-expose-after-await` docs

* Improve descriptions of core extension rules

* Improve example data in docs
  • Loading branch information
FloEdelmann committed Jan 20, 2022
1 parent 9c2c15f commit 32d1fb7
Show file tree
Hide file tree
Showing 40 changed files with 115 additions and 108 deletions.
68 changes: 34 additions & 34 deletions docs/rules/README.md
Expand Up @@ -369,40 +369,40 @@ The following rules extend the rules provided by ESLint itself and apply them to

| Rule ID | Description | |
|:--------|:------------|:---|
| [vue/array-bracket-newline](./array-bracket-newline.md) | enforce linebreaks after opening and before closing array brackets | :wrench: |
| [vue/array-bracket-spacing](./array-bracket-spacing.md) | enforce consistent spacing inside array brackets | :wrench: |
| [vue/arrow-spacing](./arrow-spacing.md) | enforce consistent spacing before and after the arrow in arrow functions | :wrench: |
| [vue/block-spacing](./block-spacing.md) | disallow or enforce spaces inside of blocks after opening block and before closing block | :wrench: |
| [vue/brace-style](./brace-style.md) | enforce consistent brace style for blocks | :wrench: |
| [vue/camelcase](./camelcase.md) | enforce camelcase naming convention | |
| [vue/comma-dangle](./comma-dangle.md) | require or disallow trailing commas | :wrench: |
| [vue/comma-spacing](./comma-spacing.md) | enforce consistent spacing before and after commas | :wrench: |
| [vue/comma-style](./comma-style.md) | enforce consistent comma style | :wrench: |
| [vue/dot-location](./dot-location.md) | enforce consistent newlines before and after dots | :wrench: |
| [vue/dot-notation](./dot-notation.md) | enforce dot notation whenever possible | :wrench: |
| [vue/eqeqeq](./eqeqeq.md) | require the use of `===` and `!==` | :wrench: |
| [vue/func-call-spacing](./func-call-spacing.md) | require or disallow spacing between function identifiers and their invocations | :wrench: |
| [vue/key-spacing](./key-spacing.md) | enforce consistent spacing between keys and values in object literal properties | :wrench: |
| [vue/keyword-spacing](./keyword-spacing.md) | enforce consistent spacing before and after keywords | :wrench: |
| [vue/max-len](./max-len.md) | enforce a maximum line length | |
| [vue/no-constant-condition](./no-constant-condition.md) | disallow constant expressions in conditions | |
| [vue/no-empty-pattern](./no-empty-pattern.md) | disallow empty destructuring patterns | |
| [vue/no-extra-parens](./no-extra-parens.md) | disallow unnecessary parentheses | :wrench: |
| [vue/no-irregular-whitespace](./no-irregular-whitespace.md) | disallow irregular whitespace | |
| [vue/no-loss-of-precision](./no-loss-of-precision.md) | disallow literal numbers that lose precision | |
| [vue/no-restricted-syntax](./no-restricted-syntax.md) | disallow specified syntax | |
| [vue/no-sparse-arrays](./no-sparse-arrays.md) | disallow sparse arrays | |
| [vue/no-useless-concat](./no-useless-concat.md) | disallow unnecessary concatenation of literals or template literals | |
| [vue/object-curly-newline](./object-curly-newline.md) | enforce consistent line breaks after opening and before closing braces | :wrench: |
| [vue/object-curly-spacing](./object-curly-spacing.md) | enforce consistent spacing inside braces | :wrench: |
| [vue/object-property-newline](./object-property-newline.md) | enforce placing object properties on separate lines | :wrench: |
| [vue/object-shorthand](./object-shorthand.md) | require or disallow method and property shorthand syntax for object literals | :wrench: |
| [vue/operator-linebreak](./operator-linebreak.md) | enforce consistent linebreak style for operators | :wrench: |
| [vue/prefer-template](./prefer-template.md) | require template literals instead of string concatenation | :wrench: |
| [vue/space-in-parens](./space-in-parens.md) | enforce consistent spacing inside parentheses | :wrench: |
| [vue/space-infix-ops](./space-infix-ops.md) | require spacing around infix operators | :wrench: |
| [vue/space-unary-ops](./space-unary-ops.md) | enforce consistent spacing before or after unary operators | :wrench: |
| [vue/template-curly-spacing](./template-curly-spacing.md) | require or disallow spacing around embedded expressions of template strings | :wrench: |
| [vue/array-bracket-newline](./array-bracket-newline.md) | enforce linebreaks after opening and before closing array brackets in `<template>` | :wrench: |
| [vue/array-bracket-spacing](./array-bracket-spacing.md) | enforce consistent spacing inside array brackets in `<template>` | :wrench: |
| [vue/arrow-spacing](./arrow-spacing.md) | enforce consistent spacing before and after the arrow in arrow functions in `<template>` | :wrench: |
| [vue/block-spacing](./block-spacing.md) | disallow or enforce spaces inside of blocks after opening block and before closing block in `<template>` | :wrench: |
| [vue/brace-style](./brace-style.md) | enforce consistent brace style for blocks in `<template>` | :wrench: |
| [vue/camelcase](./camelcase.md) | enforce camelcase naming convention in `<template>` | |
| [vue/comma-dangle](./comma-dangle.md) | require or disallow trailing commas in `<template>` | :wrench: |
| [vue/comma-spacing](./comma-spacing.md) | enforce consistent spacing before and after commas in `<template>` | :wrench: |
| [vue/comma-style](./comma-style.md) | enforce consistent comma style in `<template>` | :wrench: |
| [vue/dot-location](./dot-location.md) | enforce consistent newlines before and after dots in `<template>` | :wrench: |
| [vue/dot-notation](./dot-notation.md) | enforce dot notation whenever possible in `<template>` | :wrench: |
| [vue/eqeqeq](./eqeqeq.md) | require the use of `===` and `!==` in `<template>` | :wrench: |
| [vue/func-call-spacing](./func-call-spacing.md) | require or disallow spacing between function identifiers and their invocations in `<template>` | :wrench: |
| [vue/key-spacing](./key-spacing.md) | enforce consistent spacing between keys and values in object literal properties in `<template>` | :wrench: |
| [vue/keyword-spacing](./keyword-spacing.md) | enforce consistent spacing before and after keywords in `<template>` | :wrench: |
| [vue/max-len](./max-len.md) | enforce a maximum line length in `.vue` files | |
| [vue/no-constant-condition](./no-constant-condition.md) | disallow constant expressions in conditions in `<template>` | |
| [vue/no-empty-pattern](./no-empty-pattern.md) | disallow empty destructuring patterns in `<template>` | |
| [vue/no-extra-parens](./no-extra-parens.md) | disallow unnecessary parentheses in `<template>` | :wrench: |
| [vue/no-irregular-whitespace](./no-irregular-whitespace.md) | disallow irregular whitespace in `.vue` files | |
| [vue/no-loss-of-precision](./no-loss-of-precision.md) | disallow literal numbers that lose precision in `<template>` | |
| [vue/no-restricted-syntax](./no-restricted-syntax.md) | disallow specified syntax in `<template>` | |
| [vue/no-sparse-arrays](./no-sparse-arrays.md) | disallow sparse arrays in `<template>` | |
| [vue/no-useless-concat](./no-useless-concat.md) | disallow unnecessary concatenation of literals or template literals in `<template>` | |
| [vue/object-curly-newline](./object-curly-newline.md) | enforce consistent line breaks after opening and before closing braces in `<template>` | :wrench: |
| [vue/object-curly-spacing](./object-curly-spacing.md) | enforce consistent spacing inside braces in `<template>` | :wrench: |
| [vue/object-property-newline](./object-property-newline.md) | enforce placing object properties on separate lines in `<template>` | :wrench: |
| [vue/object-shorthand](./object-shorthand.md) | require or disallow method and property shorthand syntax for object literals in `<template>` | :wrench: |
| [vue/operator-linebreak](./operator-linebreak.md) | enforce consistent linebreak style for operators in `<template>` | :wrench: |
| [vue/prefer-template](./prefer-template.md) | require template literals instead of string concatenation in `<template>` | :wrench: |
| [vue/space-in-parens](./space-in-parens.md) | enforce consistent spacing inside parentheses in `<template>` | :wrench: |
| [vue/space-infix-ops](./space-infix-ops.md) | require spacing around infix operators in `<template>` | :wrench: |
| [vue/space-unary-ops](./space-unary-ops.md) | enforce consistent spacing before or after unary operators in `<template>` | :wrench: |
| [vue/template-curly-spacing](./template-curly-spacing.md) | require or disallow spacing around embedded expressions of template strings in `<template>` | :wrench: |

## Deprecated

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/array-bracket-newline.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/array-bracket-newline
description: enforce linebreaks after opening and before closing array brackets
description: enforce linebreaks after opening and before closing array brackets in `<template>`
since: v7.1.0
---
# vue/array-bracket-newline

> enforce linebreaks after opening and before closing array brackets
> enforce linebreaks after opening and before closing array brackets 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
4 changes: 2 additions & 2 deletions docs/rules/array-bracket-spacing.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/array-bracket-spacing
description: enforce consistent spacing inside array brackets
description: enforce consistent spacing inside array brackets in `<template>`
since: v5.2.0
---
# vue/array-bracket-spacing

> enforce consistent spacing inside array brackets
> enforce consistent spacing inside array brackets 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
4 changes: 2 additions & 2 deletions docs/rules/arrow-spacing.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/arrow-spacing
description: enforce consistent spacing before and after the arrow in arrow functions
description: enforce consistent spacing before and after the arrow in arrow functions in `<template>`
since: v5.2.0
---
# vue/arrow-spacing

> enforce consistent spacing before and after the arrow in arrow functions
> enforce consistent spacing before and after the arrow in arrow functions 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
4 changes: 2 additions & 2 deletions docs/rules/block-spacing.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/block-spacing
description: disallow or enforce spaces inside of blocks after opening block and before closing block
description: disallow or enforce spaces inside of blocks after opening block and before closing block in `<template>`
since: v5.2.0
---
# vue/block-spacing

> disallow or enforce spaces inside of blocks after opening block and before closing block
> disallow or enforce spaces inside of blocks after opening block and before closing block 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
4 changes: 2 additions & 2 deletions docs/rules/brace-style.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/brace-style
description: enforce consistent brace style for blocks
description: enforce consistent brace style for blocks in `<template>`
since: v5.2.0
---
# vue/brace-style

> enforce consistent brace style for blocks
> enforce consistent brace style for blocks 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
4 changes: 2 additions & 2 deletions docs/rules/camelcase.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/camelcase
description: enforce camelcase naming convention
description: enforce camelcase naming convention in `<template>`
since: v5.2.0
---
# vue/camelcase

> enforce camelcase naming convention
> enforce camelcase naming convention in `<template>`
This rule is the same rule as core [camelcase] rule but it applies to the expressions in `<template>`.

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/comma-dangle.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/comma-dangle
description: require or disallow trailing commas
description: require or disallow trailing commas in `<template>`
since: v5.2.0
---
# vue/comma-dangle

> require or disallow trailing commas
> require or disallow trailing commas 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
4 changes: 2 additions & 2 deletions docs/rules/comma-spacing.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/comma-spacing
description: enforce consistent spacing before and after commas
description: enforce consistent spacing before and after commas in `<template>`
since: v7.0.0
---
# vue/comma-spacing

> enforce consistent spacing before and after commas
> enforce consistent spacing before and after commas 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
4 changes: 2 additions & 2 deletions docs/rules/comma-style.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/comma-style
description: enforce consistent comma style
description: enforce consistent comma style in `<template>`
since: v7.0.0
---
# vue/comma-style

> enforce consistent comma style
> enforce consistent comma 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
4 changes: 2 additions & 2 deletions docs/rules/component-tags-order.md
Expand Up @@ -92,7 +92,7 @@ This rule warns about the order of the `<script>`, `<template>` & `<style>` tags

```vue
<!-- ✓ GOOD -->
<docs> documents </docs>
<docs> documentation </docs>
<template>...</template>
<script>/* ... */</script>
<style>/* ... */</style>
Expand All @@ -106,7 +106,7 @@ This rule warns about the order of the `<script>`, `<template>` & `<style>` tags
<!-- ✗ BAD -->
<template>...</template>
<script>/* ... */</script>
<docs> documents </docs>
<docs> documentation </docs>
<style>/* ... */</style>
```

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/dot-location.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/dot-location
description: enforce consistent newlines before and after dots
description: enforce consistent newlines before and after dots in `<template>`
since: v6.0.0
---
# vue/dot-location

> enforce consistent newlines before and after dots
> enforce consistent newlines before and after dots 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
4 changes: 2 additions & 2 deletions docs/rules/dot-notation.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/dot-notation
description: enforce dot notation whenever possible
description: enforce dot notation whenever possible in `<template>`
since: v7.0.0
---
# vue/dot-notation

> enforce dot notation whenever possible
> enforce dot notation whenever possible 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
4 changes: 2 additions & 2 deletions docs/rules/eqeqeq.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/eqeqeq
description: require the use of `===` and `!==`
description: require the use of `===` and `!==` in `<template>`
since: v5.2.0
---
# vue/eqeqeq

> require the use of `===` and `!==`
> require the use of `===` and `!==` 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
4 changes: 2 additions & 2 deletions docs/rules/func-call-spacing.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/func-call-spacing
description: require or disallow spacing between function identifiers and their invocations
description: require or disallow spacing between function identifiers and their invocations in `<template>`
since: v7.0.0
---
# vue/func-call-spacing

> require or disallow spacing between function identifiers and their invocations
> require or disallow spacing between function identifiers and their invocations 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
4 changes: 2 additions & 2 deletions docs/rules/key-spacing.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/key-spacing
description: enforce consistent spacing between keys and values in object literal properties
description: enforce consistent spacing between keys and values in object literal properties in `<template>`
since: v5.2.0
---
# vue/key-spacing

> enforce consistent spacing between keys and values in object literal properties
> enforce consistent spacing between keys and values in object literal properties 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
4 changes: 2 additions & 2 deletions docs/rules/keyword-spacing.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/keyword-spacing
description: enforce consistent spacing before and after keywords
description: enforce consistent spacing before and after keywords in `<template>`
since: v6.0.0
---
# vue/keyword-spacing

> enforce consistent spacing before and after keywords
> enforce consistent spacing before and after keywords 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
4 changes: 2 additions & 2 deletions docs/rules/max-len.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/max-len
description: enforce a maximum line length
description: enforce a maximum line length in `.vue` files
since: v6.1.0
---
# vue/max-len

> enforce a maximum line length
> enforce a maximum line length in `.vue` files
## :book: Rule Details

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-constant-condition.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/no-constant-condition
description: disallow constant expressions in conditions
description: disallow constant expressions in conditions in `<template>`
since: v7.5.0
---
# vue/no-constant-condition

> disallow constant expressions in conditions
> disallow constant expressions in conditions in `<template>`
This rule is the same rule as core [no-constant-condition] rule but it applies to the expressions in `<template>`.

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-empty-pattern.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/no-empty-pattern
description: disallow empty destructuring patterns
description: disallow empty destructuring patterns in `<template>`
since: v6.0.0
---
# vue/no-empty-pattern

> disallow empty destructuring patterns
> disallow empty destructuring patterns in `<template>`
This rule is the same rule as core [no-empty-pattern] rule but it applies to the expressions in `<template>`.

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-expose-after-await.md
Expand Up @@ -11,8 +11,8 @@ since: v8.1.0
## :book: Rule Details

This rule reports the `expose()` after `await` expression.
In `setup()` function, `expose()` should be registered synchronously.
This rule reports usages of `expose()` after an `await` expression.
In the `setup()` function, `expose()` should be registered synchronously.

<eslint-code-block :rules="{'vue/no-expose-after-await': ['error']}">

Expand Down
4 changes: 2 additions & 2 deletions docs/rules/no-extra-parens.md
Expand Up @@ -2,12 +2,12 @@
pageClass: rule-details
sidebarDepth: 0
title: vue/no-extra-parens
description: disallow unnecessary parentheses
description: disallow unnecessary parentheses in `<template>`
since: v7.0.0
---
# vue/no-extra-parens

> disallow unnecessary parentheses
> disallow unnecessary parentheses 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

0 comments on commit 32d1fb7

Please sign in to comment.