Update docs to clarify rules that extend ESlint core rules. (#1174)

Author: ota-meshi

docs/.vuepress/config.js

@@ -7,7 +7,16 @@
 const rules = require('../../tools/lib/rules')
 
 const uncategorizedRules = rules.filter(
-  (rule) => !rule.meta.docs.categories && !rule.meta.deprecated
+  (rule) =>
+    !rule.meta.docs.categories &&
+    !rule.meta.docs.extensionRule &&
+    !rule.meta.deprecated
+)
+const uncategorizedExtensionRule = rules.filter(
+  (rule) =>
+    !rule.meta.docs.categories &&
+    rule.meta.docs.extensionRule &&
+    !rule.meta.deprecated
 )
 const deprecatedRules = rules.filter((rule) => rule.meta.deprecated)
 
@@ -87,6 +96,16 @@ if (uncategorizedRules.length > 0) {
     ])
   })
 }
+if (uncategorizedExtensionRule.length > 0) {
+  extraCategories.push({
+    title: 'Extension Rules',
+    collapsable: false,
+    children: uncategorizedExtensionRule.map(({ ruleId, name }) => [
+      `/rules/${name}`,
+      ruleId
+    ])
+  })
+}
 if (deprecatedRules.length > 0) {
   extraCategories.push({
     title: 'Deprecated',

docs/rules/README.md

@@ -266,11 +266,40 @@ For example:
 ```json
 {
   "rules": {
-    "vue/array-bracket-spacing": "error"
+    "vue/component-name-in-template-casing": "error"
   }
 }
 ```
 
+| Rule ID | Description |    |
+|:--------|:------------|:---|
+| [vue/component-name-in-template-casing](./component-name-in-template-casing.md) | enforce specific casing for the component naming style in template | :wrench: |
+| [vue/html-comment-content-newline](./html-comment-content-newline.md) | enforce unified line brake in HTML comments | :wrench: |
+| [vue/html-comment-content-spacing](./html-comment-content-spacing.md) | enforce unified spacing in HTML comments | :wrench: |
+| [vue/html-comment-indent](./html-comment-indent.md) | enforce consistent indentation in HTML comments | :wrench: |
+| [vue/match-component-file-name](./match-component-file-name.md) | require component name property to match its file name |  |
+| [vue/no-boolean-default](./no-boolean-default.md) | disallow boolean defaults | :wrench: |
+| [vue/no-duplicate-attr-inheritance](./no-duplicate-attr-inheritance.md) | enforce `inheritAttrs` to be set to `false` when using `v-bind="$attrs"` |  |
+| [vue/no-potential-component-option-typo](./no-potential-component-option-typo.md) | disallow a potential typo in your component property |  |
+| [vue/no-reserved-component-names](./no-reserved-component-names.md) | disallow the use of reserved names in component definitions |  |
+| [vue/no-static-inline-styles](./no-static-inline-styles.md) | disallow static inline `style` attributes |  |
+| [vue/no-template-target-blank](./no-template-target-blank.md) | disallow target="_blank" attribute without rel="noopener noreferrer" |  |
+| [vue/no-unregistered-components](./no-unregistered-components.md) | disallow using components that are not registered inside templates |  |
+| [vue/no-unsupported-features](./no-unsupported-features.md) | disallow unsupported Vue.js syntax on the specified version | :wrench: |
+| [vue/no-unused-properties](./no-unused-properties.md) | disallow unused properties |  |
+| [vue/padding-line-between-blocks](./padding-line-between-blocks.md) | require or disallow padding lines between blocks | :wrench: |
+| [vue/require-direct-export](./require-direct-export.md) | require the component to be directly exported |  |
+| [vue/require-explicit-emits](./require-explicit-emits.md) | require `emits` option with name triggered by `$emit()` |  |
+| [vue/require-name-property](./require-name-property.md) | require a name property in Vue components |  |
+| [vue/script-indent](./script-indent.md) | enforce consistent indentation in `<script>` | :wrench: |
+| [vue/sort-keys](./sort-keys.md) | enforce sort-keys in a manner that is compatible with order-in-components |  |
+| [vue/static-class-names-order](./static-class-names-order.md) | enforce static class names order | :wrench: |
+| [vue/v-on-function-call](./v-on-function-call.md) | enforce or forbid parentheses after method calls without arguments in `v-on` directives | :wrench: |
+
+### Extension Rules
+
+The following rules extend the rules provided by ESLint itself and apply them to the expressions in the `<template>`.
+
 | Rule ID | Description |    |
 |:--------|:------------|:---|
 | [vue/array-bracket-spacing](./array-bracket-spacing.md) | enforce consistent spacing inside array brackets | :wrench: |
@@ -281,45 +310,23 @@ For example:
 | [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/component-name-in-template-casing](./component-name-in-template-casing.md) | enforce specific casing for the component naming style in template | :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/html-comment-content-newline](./html-comment-content-newline.md) | enforce unified line brake in HTML comments | :wrench: |
-| [vue/html-comment-content-spacing](./html-comment-content-spacing.md) | enforce unified spacing in HTML comments | :wrench: |
-| [vue/html-comment-indent](./html-comment-indent.md) | enforce consistent indentation in HTML comments | :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/match-component-file-name](./match-component-file-name.md) | require component name property to match its file name |  |
 | [vue/max-len](./max-len.md) | enforce a maximum line length |  |
-| [vue/no-boolean-default](./no-boolean-default.md) | disallow boolean defaults | :wrench: |
-| [vue/no-duplicate-attr-inheritance](./no-duplicate-attr-inheritance.md) | enforce `inheritAttrs` to be set to `false` when using `v-bind="$attrs"` |  |
 | [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-potential-component-option-typo](./no-potential-component-option-typo.md) | disallow a potential typo in your component property |  |
-| [vue/no-reserved-component-names](./no-reserved-component-names.md) | disallow the use of reserved names in component definitions |  |
 | [vue/no-restricted-syntax](./no-restricted-syntax.md) | disallow specified syntax |  |
-| [vue/no-static-inline-styles](./no-static-inline-styles.md) | disallow static inline `style` attributes |  |
-| [vue/no-template-target-blank](./no-template-target-blank.md) | disallow target="_blank" attribute without rel="noopener noreferrer" |  |
-| [vue/no-unregistered-components](./no-unregistered-components.md) | disallow using components that are not registered inside templates |  |
-| [vue/no-unsupported-features](./no-unsupported-features.md) | disallow unsupported Vue.js syntax on the specified version | :wrench: |
-| [vue/no-unused-properties](./no-unused-properties.md) | disallow unused properties |  |
 | [vue/no-useless-concat](./no-useless-concat.md) | disallow unnecessary concatenation of literals or template literals |  |
 | [vue/object-curly-spacing](./object-curly-spacing.md) | enforce consistent spacing inside braces | :wrench: |
-| [vue/padding-line-between-blocks](./padding-line-between-blocks.md) | require or disallow padding lines between blocks | :wrench: |
 | [vue/prefer-template](./prefer-template.md) | require template literals instead of string concatenation | :wrench: |
-| [vue/require-direct-export](./require-direct-export.md) | require the component to be directly exported |  |
-| [vue/require-explicit-emits](./require-explicit-emits.md) | require `emits` option with name triggered by `$emit()` |  |
-| [vue/require-name-property](./require-name-property.md) | require a name property in Vue components |  |
-| [vue/script-indent](./script-indent.md) | enforce consistent indentation in `<script>` | :wrench: |
-| [vue/sort-keys](./sort-keys.md) | enforce sort-keys in a manner that is compatible with order-in-components |  |
 | [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/static-class-names-order](./static-class-names-order.md) | enforce static class names order | :wrench: |
 | [vue/template-curly-spacing](./template-curly-spacing.md) | require or disallow spacing around embedded expressions of template strings | :wrench: |
-| [vue/v-on-function-call](./v-on-function-call.md) | enforce or forbid parentheses after method calls without arguments in `v-on` directives | :wrench: |
 
 ## Deprecated
 

docs/rules/array-bracket-spacing.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [array-bracket-spacing] rule but it applies t
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/array-bracket-spacing.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/array-bracket-spacing.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/array-bracket-spacing)</sup>

docs/rules/arrow-spacing.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [arrow-spacing] rule but it applies to the ex
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/arrow-spacing.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/arrow-spacing.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/arrow-spacing)</sup>

docs/rules/block-spacing.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [block-spacing] rule but it applies to the ex
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/block-spacing.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/block-spacing.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/block-spacing)</sup>

docs/rules/brace-style.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [brace-style] rule but it applies to the expr
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/brace-style.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/brace-style.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/brace-style)</sup>

docs/rules/camelcase.md

@@ -19,3 +19,5 @@ This rule is the same rule as core [camelcase] rule but it applies to the expres
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/camelcase.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/camelcase.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/camelcase)</sup>

docs/rules/comma-dangle.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [comma-dangle] rule but it applies to the exp
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/comma-dangle.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/comma-dangle.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/comma-dangle)</sup>

docs/rules/comma-spacing.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [comma-spacing] rule but it applies to the ex
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/comma-spacing.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/comma-spacing.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/comma-spacing)</sup>

docs/rules/comma-style.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [comma-style] rule but it applies to the expr
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/comma-style.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/comma-style.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/comma-style)</sup>

docs/rules/dot-location.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [dot-location] rule but it applies to the exp
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/dot-location.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/dot-location.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/dot-location)</sup>

docs/rules/dot-notation.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [dot-notation] rule but it applies to the exp
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/dot-notation.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/dot-notation.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/dot-notation)</sup>

docs/rules/eqeqeq.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [eqeqeq] rule but it applies to the expressio
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/eqeqeq.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/eqeqeq.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/eqeqeq)</sup>

docs/rules/key-spacing.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [key-spacing] rule but it applies to the expr
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/key-spacing.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/key-spacing.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/key-spacing)</sup>

docs/rules/keyword-spacing.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [keyword-spacing] rule but it applies to the
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/keyword-spacing.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/keyword-spacing.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/keyword-spacing)</sup>

docs/rules/max-len.md

@@ -327,3 +327,5 @@ var longRegExpLiteral = /this is a really really really really really long regul
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/max-len.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/max-len.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/max-len)</sup>

docs/rules/no-empty-pattern.md

@@ -19,3 +19,5 @@ This rule is the same rule as core [no-empty-pattern] rule but it applies to the
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-empty-pattern.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-empty-pattern.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/no-empty-pattern)</sup>

docs/rules/no-extra-parens.md

@@ -43,3 +43,5 @@ This rule extends the core [no-extra-parens] rule and applies it to the `<templa
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-extra-parens.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-extra-parens.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/no-extra-parens)</sup>

docs/rules/no-irregular-whitespace.md

@@ -167,3 +167,5 @@ var foo = ``
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-irregular-whitespace.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-irregular-whitespace.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/no-irregular-whitespace)</sup>

docs/rules/no-restricted-syntax.md

@@ -53,3 +53,5 @@ Forbids call expressions inside mustache interpolation.
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-restricted-syntax.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-restricted-syntax.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/no-restricted-syntax)</sup>

docs/rules/no-useless-concat.md

@@ -19,3 +19,5 @@ This rule is the same rule as core [no-useless-concat] rule but it applies to th
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-useless-concat.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-useless-concat.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/no-useless-concat)</sup>

docs/rules/object-curly-spacing.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [object-curly-spacing] rule but it applies to
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/object-curly-spacing.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/object-curly-spacing.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/object-curly-spacing)</sup>

docs/rules/prefer-template.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [prefer-template] rule but it applies to the
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/prefer-template.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/prefer-template.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/prefer-template)</sup>

docs/rules/space-in-parens.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [space-in-parens] rule but it applies to the
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/space-in-parens.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/space-in-parens.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/space-in-parens)</sup>

docs/rules/space-infix-ops.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [space-infix-ops] rule but it applies to the
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/space-infix-ops.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/space-infix-ops.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/space-infix-ops)</sup>

docs/rules/space-unary-ops.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [space-unary-ops] rule but it applies to the
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/space-unary-ops.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/space-unary-ops.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/space-unary-ops)</sup>

docs/rules/template-curly-spacing.md

@@ -21,3 +21,5 @@ This rule is the same rule as core [template-curly-spacing] rule but it applies
 
 - [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/template-curly-spacing.js)
 - [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/template-curly-spacing.js)
+
+<sup>Taken with ❤️ [from ESLint core](https://eslint.org/docs/rules/template-curly-spacing)</sup>

lib/rules/max-len.js

@@ -192,7 +192,9 @@ module.exports = {
     docs: {
       description: 'enforce a maximum line length',
       categories: undefined,
-      url: 'https://eslint.vuejs.org/rules/max-len.html'
+      url: 'https://eslint.vuejs.org/rules/max-len.html',
+      extensionRule: true,
+      coreRuleUrl: 'https://eslint.org/docs/rules/max-len'
     },
 
     schema: [

lib/rules/no-irregular-whitespace.js

@@ -30,7 +30,9 @@ module.exports = {
     docs: {
       description: 'disallow irregular whitespace',
       categories: undefined,
-      url: 'https://eslint.vuejs.org/rules/no-irregular-whitespace.html'
+      url: 'https://eslint.vuejs.org/rules/no-irregular-whitespace.html',
+      extensionRule: true,
+      coreRuleUrl: 'https://eslint.org/docs/rules/no-irregular-whitespace'
     },
 
     schema: [