(Chore) Add related links to rules docs (#524)

vuejs · Jul 18, 2018 · 4b130cb · 4b130cb
1 parent b989b6d
commit 4b130cb
Show file tree

Hide file tree

Showing 20 changed files with 83 additions and 8 deletions.
diff --git a/docs/rules/attributes-order.md b/docs/rules/attributes-order.md
@@ -115,3 +115,7 @@ Specify custom order of attribute groups
  is="header">
 </div>
 ```
+
+## Related links
+
+- [Style guide - Element attribute order](https://vuejs.org/v2/style-guide/#Element-attribute-order-recommended)
diff --git a/docs/rules/html-self-closing.md b/docs/rules/html-self-closing.md
@@ -61,3 +61,7 @@ Every option can be set to one of the following values:
 <MyComponent/>
 <svg><path d=""/></svg>
 ```
+
+## Related links
+
+- [Style guide - Self closing components](https://vuejs.org/v2/style-guide/#Self-closing-components-strongly-recommended)
diff --git a/docs/rules/max-attributes-per-line.md b/docs/rules/max-attributes-per-line.md
@@ -125,3 +125,7 @@ Number of maximum attributes per line when a tag is in multiple lines. (Default
 ## When Not To Use It
 
 If you do not want to check the number of attributes declared per line you can disable this rule.
+
+## Related links
+
+- [Style guide - Multi attribute elements](https://vuejs.org/v2/style-guide/#Multi-attribute-elements-strongly-recommended)
diff --git a/docs/rules/name-property-casing.md b/docs/rules/name-property-casing.md
@@ -30,3 +30,7 @@ Default casing is set to `PascalCase`.
 ```
 "vue/name-property-casing": ["error", "PascalCase|kebab-case"]
 ```
+
+## Related links
+
+- [Style guide - Component name casing in JS/JSX](https://vuejs.org/v2/style-guide/#Component-name-casing-in-JS-JSX-strongly-recommended)
diff --git a/docs/rules/no-async-in-computed-properties.md b/docs/rules/no-async-in-computed-properties.md
@@ -55,5 +55,6 @@ computed: {
 
 Nothing.
 
+## Related links
 
-[vue-async-computed]: https://github.com/foxbenjaminfox/vue-async-computed
+- [vue-async-computed](https://github.com/foxbenjaminfox/vue-async-computed)
diff --git a/docs/rules/no-confusing-v-for-v-if.md b/docs/rules/no-confusing-v-for-v-if.md
@@ -48,3 +48,9 @@ In that case, the `v-if` should be written on the wrapper element.
 ## :wrench: Options
 
 Nothing.
+
+## Related links
+
+- [Style guide - Avoid v-if with v-for](https://vuejs.org/v2/style-guide/#Avoid-v-if-with-v-for-essential)
+- [Guide - Conditional / v-if with v-for](https://vuejs.org/v2/guide/conditional.html#v-if-with-v-for)
+- [Guide - List / v-for with v-if](https://vuejs.org/v2/guide/list.html#v-for-with-v-if)
diff --git a/docs/rules/no-reserved-keys.md b/docs/rules/no-reserved-keys.md
@@ -2,7 +2,7 @@
 
 - :gear: This rule is included in all of `"plugin:vue/essential"`, `"plugin:vue/strongly-recommended"` and `"plugin:vue/recommended"`.
 
-This rule prevents to use reserved names from to avoid conflicts and unexpected behavior.
+This rule prevents to use [reserved names](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/utils/vue-reserved.json) to avoid conflicts and unexpected behavior.
 
 ## Rule Details
 
@@ -31,9 +31,9 @@ export default {
 
 This rule has an object option:
 
-`"reserved"`: [] (default) array of dissalowed names inside `groups`.
+`"reserved"`: [] (default) array of additional restricted attributes inside `groups`.
 
-`"groups"`: [] (default) array of additional groups to search for duplicates.
+`"groups"`: [] (default) array of additional group names to search for duplicates in.
 
 ### Example:
 
@@ -56,3 +56,7 @@ export default {
  }
 }
 ```
+
+## Related links
+
+- [List of reserved keys](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/utils/vue-reserved.json)
diff --git a/docs/rules/no-shared-component-data.md b/docs/rules/no-shared-component-data.md
@@ -52,3 +52,7 @@ export default {
 ## :wrench: Options
 
 Nothing.
+
+## Related links
+
+- [API - data](https://vuejs.org/v2/api/#data)
diff --git a/docs/rules/no-textarea-mustache.md b/docs/rules/no-textarea-mustache.md
@@ -25,3 +25,7 @@ This rule reports mustaches in `<textarea>`.
 ## :wrench: Options
 
 Nothing.
+
+## Related links
+
+- [Guide - Forms / Multiline text](https://vuejs.org/v2/guide/forms.html#Multiline-text)
diff --git a/docs/rules/no-use-v-if-with-v-for.md b/docs/rules/no-use-v-if-with-v-for.md
@@ -96,3 +96,8 @@ computed: {
 />
 ```
 
+## Related links
+
+- [Style guide - Avoid v-if with v-for](https://vuejs.org/v2/style-guide/#Avoid-v-if-with-v-for-essential)
+- [Guide - Conditional / v-if with v-for](https://vuejs.org/v2/guide/conditional.html#v-if-with-v-for)
+- [Guide - List / v-for with v-if](https://vuejs.org/v2/guide/list.html#v-for-with-v-if)
diff --git a/docs/rules/no-v-html.md b/docs/rules/no-v-html.md
@@ -32,6 +32,6 @@ Nothing.
 
 If you are certain the content passed `to v-html` is sanitized HTML you can disable this rule.
 
-## Further Reading
+## Related links
 
-* (XSS in Vue.js)[https://blog.sqreen.io/xss-in-vue-js/]
+- [XSS in Vue.js](https://blog.sqreen.io/xss-in-vue-js/)
diff --git a/docs/rules/order-in-components.md b/docs/rules/order-in-components.md
@@ -71,3 +71,7 @@ If you want you can change the order providing the optional configuration in you
 ```
 
 If you want some of properties to be treated equally in order you can group them into arrays, like we did with `delimiters` and `comments`.
+
+## Related links
+
+- [Style guide - Component/instance options order](https://vuejs.org/v2/style-guide/#Component-instance-options-order-recommended)
diff --git a/docs/rules/prop-name-casing.md b/docs/rules/prop-name-casing.md
@@ -35,3 +35,7 @@ Default casing is set to `camelCase`.
 ```
 "vue/prop-name-casing": ["error", "camelCase|snake_case"]
 ```
+
+## Related links
+
+- [Style guide - Prop name casing](https://vuejs.org/v2/style-guide/#Prop-name-casing-strongly-recommended)
diff --git a/docs/rules/require-component-is.md b/docs/rules/require-component-is.md
@@ -27,3 +27,7 @@ This rule reports the `<component>` elements which do not have `v-bind:is` attri
 ## :wrench: Options
 
 Nothing.
+
+## Related links
+
+- [Guide - Dynamic Components](https://vuejs.org/v2/guide/components.html#Dynamic-Components)
diff --git a/docs/rules/require-default-prop.md b/docs/rules/require-default-prop.md
@@ -41,3 +41,7 @@ props: {
  }
 }
 ```
+
+## Related links
+
+- [Style guide - Prop definitions](https://vuejs.org/v2/style-guide/#Prop-definitions-essential)
diff --git a/docs/rules/require-prop-types.md b/docs/rules/require-prop-types.md
@@ -37,3 +37,7 @@ props: {
 ## :wrench: Options
 
 Nothing.
+
+## Related links
+
+- [Style guide - Prop definitions](https://vuejs.org/v2/style-guide/#Prop-definitions-essential)
diff --git a/docs/rules/require-v-for-key.md b/docs/rules/require-v-for-key.md
@@ -33,6 +33,9 @@ Nothing.
 
 ## :couple: Related rules
 
-- [valid-v-for]
+- [valid-v-for](./valid-v-for.md)
 
-[valid-v-for]: ./valid-v-for.md
+## Related links
+
+- [Style guide - Keyed v-for](https://vuejs.org/v2/style-guide/#Keyed-v-for-essential)
+- [Guide - v-for with a Component](https://vuejs.org/v2/guide/list.html#v-for-with-a-Component)
diff --git a/docs/rules/require-valid-default-prop.md b/docs/rules/require-valid-default-prop.md
@@ -59,3 +59,7 @@ props: {
 ## :wrench: Options
 
 Nothing.
+
+## Related links
+
+- [Guide - Prop Validation](https://vuejs.org/v2/guide/components-props.html#Prop-Validation)
diff --git a/docs/rules/v-bind-style.md b/docs/rules/v-bind-style.md
@@ -35,3 +35,7 @@ This rule enforces `v-bind` directive style which you should use shorthand or lo
 
 - `"shorthand"` (default) ... requires using shorthand.
 - `"longform"` ... requires using long form.
+
+## Related links
+
+- [Style guide - Directive shorthands](https://vuejs.org/v2/style-guide/#Directive-shorthands-strongly-recommended)
diff --git a/docs/rules/v-on-style.md b/docs/rules/v-on-style.md
@@ -35,3 +35,7 @@ This rule enforces `v-on` directive style which you should use shorthand or long
 
 - `"shorthand"` (default) ... requires using shorthand.
 - `"longform"` ... requires using long form.
+
+## Related links
+
+- [Style guide - Directive shorthands](https://vuejs.org/v2/style-guide/#Directive-shorthands-strongly-recommended)