Skip to content

⚙️Chore: Add related links to rules docs (fixes #439) #524

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
Jul 18, 2018
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
4 changes: 4 additions & 0 deletions docs/rules/attributes-order.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions docs/rules/html-self-closing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions docs/rules/max-attributes-per-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions docs/rules/name-property-casing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
3 changes: 2 additions & 1 deletion docs/rules/no-async-in-computed-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
6 changes: 6 additions & 0 deletions docs/rules/no-confusing-v-for-v-if.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
10 changes: 7 additions & 3 deletions docs/rules/no-reserved-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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:

Expand All @@ -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)
4 changes: 4 additions & 0 deletions docs/rules/no-shared-component-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,7 @@ export default {
## :wrench: Options

Nothing.

## Related links

- [API - data](https://vuejs.org/v2/api/#data)
4 changes: 4 additions & 0 deletions docs/rules/no-textarea-mustache.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
5 changes: 5 additions & 0 deletions docs/rules/no-use-v-if-with-v-for.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/rules/no-v-html.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
4 changes: 4 additions & 0 deletions docs/rules/order-in-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions docs/rules/prop-name-casing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions docs/rules/require-component-is.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions docs/rules/require-default-prop.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,7 @@ props: {
}
}
```

## Related links

- [Style guide - Prop definitions](https://vuejs.org/v2/style-guide/#Prop-definitions-essential)
4 changes: 4 additions & 0 deletions docs/rules/require-prop-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,7 @@ props: {
## :wrench: Options

Nothing.

## Related links

- [Style guide - Prop definitions](https://vuejs.org/v2/style-guide/#Prop-definitions-essential)
7 changes: 5 additions & 2 deletions docs/rules/require-v-for-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions docs/rules/require-valid-default-prop.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,7 @@ props: {
## :wrench: Options

Nothing.

## Related links

- [Guide - Prop Validation](https://vuejs.org/v2/guide/components-props.html#Prop-Validation)
4 changes: 4 additions & 0 deletions docs/rules/v-bind-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions docs/rules/v-on-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)