Fix issues in documentation (#66)

armano2 · michalsnik · commit 9fce35dba388 · 2017-07-04T22:56:48.000+02:00
diff --git a/README.md b/README.md
@@ -79,8 +79,8 @@ The `--fix` option on the command line automatically fixes problems reported by
 |    | Rule ID | Description |
 |:---|:--------|:------------|
 |  | [html-quotes](./docs/rules/html-quotes.md) | enforce quotes style of HTML attributes. |
-| :wrench: | [v-bind-style](./docs/rules/v-bind-style.md) | enforce v-bind directive style. |
-| :wrench: | [v-on-style](./docs/rules/v-on-style.md) | enforce v-on directive style. |
+| :wrench: | [v-bind-style](./docs/rules/v-bind-style.md) | enforce `v-bind` directive style. |
+| :wrench: | [v-on-style](./docs/rules/v-on-style.md) | enforce `v-on` directive style. |
 
 
 ### Variables
@@ -95,21 +95,21 @@ The `--fix` option on the command line automatically fixes problems reported by
 |    | Rule ID | Description |
 |:---|:--------|:------------|
 | :white_check_mark: | [no-invalid-template-root](./docs/rules/no-invalid-template-root.md) | disallow invalid template root. |
-| :white_check_mark: | [no-invalid-v-bind](./docs/rules/no-invalid-v-bind.md) | disallow invalid v-bind directives. |
-| :white_check_mark: | [no-invalid-v-cloak](./docs/rules/no-invalid-v-cloak.md) | disallow invalid v-cloak directives. |
-| :white_check_mark: | [no-invalid-v-else-if](./docs/rules/no-invalid-v-else-if.md) | disallow invalid v-else-if directives. |
-| :white_check_mark: | [no-invalid-v-else](./docs/rules/no-invalid-v-else.md) | disallow invalid v-else directives. |
-| :white_check_mark: | [no-invalid-v-for](./docs/rules/no-invalid-v-for.md) | disallow invalid v-for directives. |
-| :white_check_mark: | [no-invalid-v-html](./docs/rules/no-invalid-v-html.md) | disallow invalid v-html directives. |
-| :white_check_mark: | [no-invalid-v-if](./docs/rules/no-invalid-v-if.md) | disallow invalid v-if directives. |
-| :white_check_mark: | [no-invalid-v-model](./docs/rules/no-invalid-v-model.md) | disallow invalid v-model directives. |
-| :white_check_mark: | [no-invalid-v-on](./docs/rules/no-invalid-v-on.md) | disallow invalid v-on directives. |
-| :white_check_mark: | [no-invalid-v-once](./docs/rules/no-invalid-v-once.md) | disallow invalid v-once directives. |
-| :white_check_mark: | [no-invalid-v-pre](./docs/rules/no-invalid-v-pre.md) | disallow invalid v-pre directives. |
-| :white_check_mark: | [no-invalid-v-show](./docs/rules/no-invalid-v-show.md) | disallow invalid v-show directives. |
-| :white_check_mark: | [no-invalid-v-text](./docs/rules/no-invalid-v-text.md) | disallow invalid v-text directives. |
+| :white_check_mark: | [no-invalid-v-bind](./docs/rules/no-invalid-v-bind.md) | disallow invalid `v-bind` directives. |
+| :white_check_mark: | [no-invalid-v-cloak](./docs/rules/no-invalid-v-cloak.md) | disallow invalid `v-cloak` directives. |
+| :white_check_mark: | [no-invalid-v-else-if](./docs/rules/no-invalid-v-else-if.md) | disallow invalid `v-else-if` directives. |
+| :white_check_mark: | [no-invalid-v-else](./docs/rules/no-invalid-v-else.md) | disallow invalid `v-else` directives. |
+| :white_check_mark: | [no-invalid-v-for](./docs/rules/no-invalid-v-for.md) | disallow invalid `v-for` directives. |
+| :white_check_mark: | [no-invalid-v-html](./docs/rules/no-invalid-v-html.md) | disallow invalid `v-html` directives. |
+| :white_check_mark: | [no-invalid-v-if](./docs/rules/no-invalid-v-if.md) | disallow invalid `v-if` directives. |
+| :white_check_mark: | [no-invalid-v-model](./docs/rules/no-invalid-v-model.md) | disallow invalid `v-model` directives. |
+| :white_check_mark: | [no-invalid-v-on](./docs/rules/no-invalid-v-on.md) | disallow invalid `v-on` directives. |
+| :white_check_mark: | [no-invalid-v-once](./docs/rules/no-invalid-v-once.md) | disallow invalid `v-once` directives. |
+| :white_check_mark: | [no-invalid-v-pre](./docs/rules/no-invalid-v-pre.md) | disallow invalid `v-pre` directives. |
+| :white_check_mark: | [no-invalid-v-show](./docs/rules/no-invalid-v-show.md) | disallow invalid `v-show` directives. |
+| :white_check_mark: | [no-invalid-v-text](./docs/rules/no-invalid-v-text.md) | disallow invalid `v-text` directives. |
 | :white_check_mark: | [no-parsing-error](./docs/rules/no-parsing-error.md) | disallow parsing errors in `<template>`. |
-|  | [no-template-key](./docs/rules/no-template-key.md) | disallow 'key' attribute on '<template>'. |
+|  | [no-template-key](./docs/rules/no-template-key.md) | disallow `key` attribute on `<template>`. |
 
 <!--RULES_TABLE_END-->
 
diff --git a/docs/rules/no-invalid-v-bind.md b/docs/rules/no-invalid-v-bind.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-bind directives (no-invalid-v-bind)
+# Disallow invalid `v-bind` directives (no-invalid-v-bind)
 
 This rule checks whether every `v-bind` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-cloak.md b/docs/rules/no-invalid-v-cloak.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-cloak directives (no-invalid-v-cloak)
+# Disallow invalid `v-cloak` directives (no-invalid-v-cloak)
 
 This rule checks whether every `v-cloak` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-else-if.md b/docs/rules/no-invalid-v-else-if.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-else-if directives (no-invalid-v-else-if)
+# Disallow invalid `v-else-if` directives (no-invalid-v-else-if)
 
 This rule checks whether every `v-else-if` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-else.md b/docs/rules/no-invalid-v-else.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-else directives (no-invalid-v-else)
+# Disallow invalid `v-else` directives (no-invalid-v-else)
 
 This rule checks whether every `v-else` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-for.md b/docs/rules/no-invalid-v-for.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-for directives (no-invalid-v-for)
+# Disallow invalid `v-for` directives (no-invalid-v-for)
 
 This rule checks whether every `v-for` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-html.md b/docs/rules/no-invalid-v-html.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-html directives (no-invalid-v-html)
+# Disallow invalid `v-html` directives (no-invalid-v-html)
 
 This rule checks whether every `v-html` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-if.md b/docs/rules/no-invalid-v-if.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-if directives (no-invalid-v-if)
+# Disallow invalid `v-if` directives (no-invalid-v-if)
 
 This rule checks whether every `v-if` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-model.md b/docs/rules/no-invalid-v-model.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-model directives (no-invalid-v-model)
+# Disallow invalid `v-model` directives (no-invalid-v-model)
 
 This rule checks whether every `v-model` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-on.md b/docs/rules/no-invalid-v-on.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-on directives (no-invalid-v-on)
+# Disallow invalid `v-on` directives (no-invalid-v-on)
 
 This rule checks whether every `v-on` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-once.md b/docs/rules/no-invalid-v-once.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-once directives (no-invalid-v-once)
+# Disallow invalid `v-once` directives (no-invalid-v-once)
 
 This rule checks whether every `v-once` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-pre.md b/docs/rules/no-invalid-v-pre.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-pre directives (no-invalid-v-pre)
+# Disallow invalid `v-pre` directives (no-invalid-v-pre)
 
 This rule checks whether every `v-pre` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-show.md b/docs/rules/no-invalid-v-show.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-show directives (no-invalid-v-show)
+# Disallow invalid `v-show` directives (no-invalid-v-show)
 
 This rule checks whether every `v-show` directive is valid.
 
diff --git a/docs/rules/no-invalid-v-text.md b/docs/rules/no-invalid-v-text.md
@@ -1,4 +1,4 @@
-# Disallow invalid v-text directives (no-invalid-v-text)
+# Disallow invalid `v-text` directives (no-invalid-v-text)
 
 This rule checks whether every `v-text` directive is valid.
 
diff --git a/docs/rules/no-template-key.md b/docs/rules/no-template-key.md
@@ -1,4 +1,4 @@
-# Disallow 'key' attribute on '<template>' (no-template-key)
+# Disallow `key` attribute on `<template>` (no-template-key)
 
 Vue.js disallows `key` attribute on `<template>` elements.
 
diff --git a/docs/rules/order-in-components.md b/docs/rules/order-in-components.md
@@ -1,4 +1,4 @@
-# Keep proper order of properties in your components (order-in-components)
+# Keep proper order of properties in your `components` (order-in-components)
 
 This rule makes sure you keep declared order of properties in components.
 
diff --git a/lib/rules/no-invalid-v-bind.js b/lib/rules/no-invalid-v-bind.js
@@ -58,7 +58,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-bind directives.',
+      description: 'disallow invalid `v-bind` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-cloak.js b/lib/rules/no-invalid-v-cloak.js
@@ -59,7 +59,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-cloak directives.',
+      description: 'disallow invalid `v-cloak` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-else-if.js b/lib/rules/no-invalid-v-else-if.js
@@ -80,7 +80,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-else-if directives.',
+      description: 'disallow invalid `v-else-if` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-else.js b/lib/rules/no-invalid-v-else.js
@@ -80,7 +80,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-else directives.',
+      description: 'disallow invalid `v-else` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-for.js b/lib/rules/no-invalid-v-for.js
@@ -162,7 +162,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-for directives.',
+      description: 'disallow invalid `v-for` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-html.js b/lib/rules/no-invalid-v-html.js
@@ -59,7 +59,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-html directives.',
+      description: 'disallow invalid `v-html` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-if.js b/lib/rules/no-invalid-v-if.js
@@ -73,7 +73,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-if directives.',
+      description: 'disallow invalid `v-if` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-model.js b/lib/rules/no-invalid-v-model.js
@@ -172,7 +172,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-model directives.',
+      description: 'disallow invalid `v-model` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-on.js b/lib/rules/no-invalid-v-on.js
@@ -71,7 +71,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-on directives.',
+      description: 'disallow invalid `v-on` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-once.js b/lib/rules/no-invalid-v-once.js
@@ -59,7 +59,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-once directives.',
+      description: 'disallow invalid `v-once` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-pre.js b/lib/rules/no-invalid-v-pre.js
@@ -59,7 +59,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-pre directives.',
+      description: 'disallow invalid `v-pre` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-show.js b/lib/rules/no-invalid-v-show.js
@@ -59,7 +59,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-show directives.',
+      description: 'disallow invalid `v-show` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-invalid-v-text.js b/lib/rules/no-invalid-v-text.js
@@ -59,7 +59,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'disallow invalid v-text directives.',
+      description: 'disallow invalid `v-text` directives.',
       category: 'Possible Errors',
       recommended: true
     },
diff --git a/lib/rules/no-template-key.js b/lib/rules/no-template-key.js
@@ -45,7 +45,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: "disallow 'key' attribute on '<template>'.",
+      description: 'disallow `key` attribute on `<template>`.',
       category: 'Possible Errors',
       recommended: false
     },
diff --git a/lib/rules/v-bind-style.js b/lib/rules/v-bind-style.js
@@ -54,7 +54,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'enforce v-bind directive style.',
+      description: 'enforce `v-bind` directive style.',
       category: 'Stylistic Issues',
       recommended: false
     },
diff --git a/lib/rules/v-on-style.js b/lib/rules/v-on-style.js
@@ -55,7 +55,7 @@ module.exports = {
   create,
   meta: {
     docs: {
-      description: 'enforce v-on directive style.',
+      description: 'enforce `v-on` directive style.',
       category: 'Stylistic Issues',
       recommended: false
     },
diff --git a/package-lock.json b/package-lock.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Disallow invalid v-bind directives (no-invalid-v-bind)`
	`1`	+# Disallow invalid `v-bind` directives (no-invalid-v-bind)
`2`	`2`
`3`	`3`	This rule checks whether every `v-bind` directive is valid.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Disallow invalid v-cloak directives (no-invalid-v-cloak)`
	`1`	+# Disallow invalid `v-cloak` directives (no-invalid-v-cloak)
`2`	`2`
`3`	`3`	This rule checks whether every `v-cloak` directive is valid.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Disallow invalid v-else-if directives (no-invalid-v-else-if)`
	`1`	+# Disallow invalid `v-else-if` directives (no-invalid-v-else-if)
`2`	`2`
`3`	`3`	This rule checks whether every `v-else-if` directive is valid.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Disallow invalid v-else directives (no-invalid-v-else)`
	`1`	+# Disallow invalid `v-else` directives (no-invalid-v-else)
`2`	`2`
`3`	`3`	This rule checks whether every `v-else` directive is valid.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Disallow invalid v-for directives (no-invalid-v-for)`
	`1`	+# Disallow invalid `v-for` directives (no-invalid-v-for)
`2`	`2`
`3`	`3`	This rule checks whether every `v-for` directive is valid.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Disallow invalid v-html directives (no-invalid-v-html)`
	`1`	+# Disallow invalid `v-html` directives (no-invalid-v-html)
`2`	`2`
`3`	`3`	This rule checks whether every `v-html` directive is valid.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Disallow invalid v-if directives (no-invalid-v-if)`
	`1`	+# Disallow invalid `v-if` directives (no-invalid-v-if)
`2`	`2`
`3`	`3`	This rule checks whether every `v-if` directive is valid.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Disallow invalid v-model directives (no-invalid-v-model)`
	`1`	+# Disallow invalid `v-model` directives (no-invalid-v-model)
`2`	`2`
`3`	`3`	This rule checks whether every `v-model` directive is valid.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Disallow invalid v-on directives (no-invalid-v-on)`
	`1`	+# Disallow invalid `v-on` directives (no-invalid-v-on)
`2`	`2`
`3`	`3`	This rule checks whether every `v-on` directive is valid.
`4`	`4`