update docs

ota-meshi · ota-meshi · commit aeb7aedf081a · 2020-07-22T17:44:41.000+09:00
diff --git a/README.md b/README.md
@@ -99,13 +99,13 @@ Enforce all the rules in this category with:
 | Rule ID | Description |    |
 |:--------|:------------|:---|
 | [vue-scoped-css/no-deprecated-deep-combinator](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-deprecated-deep-combinator.html) | disallow using deprecated deep combinators | :wrench: |
-| [vue-scoped-css/no-parsing-error](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-parsing-error.html) | Disallow parsing errors in `<style>` |  |
-| [vue-scoped-css/no-unused-keyframes](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-keyframes.html) | Reports the `@keyframes` is not used in Scoped CSS. |  |
-| [vue-scoped-css/no-unused-selector](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-selector.html) | Reports selectors defined in Scoped CSS not used in `<template>`. |  |
-| [vue-scoped-css/require-scoped](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-scoped.html) | Enforce the `<style>` tags to has the `scoped` attribute. |  |
-| [vue-scoped-css/require-v-deep-argument](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-v-deep-argument.html) | require selector argument to be passed to `::v-deep()`. | :wrench: |
-| [vue-scoped-css/require-v-global-argument](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-v-global-argument.html) | require selector argument to be passed to `::v-global()`. |  |
-| [vue-scoped-css/require-v-slotted-argument](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-v-slotted-argument.html) | require selector argument to be passed to `::v-slotted()`. |  |
+| [vue-scoped-css/no-parsing-error](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-parsing-error.html) | disallow parsing errors in `<style>` |  |
+| [vue-scoped-css/no-unused-keyframes](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-keyframes.html) | disallow `@keyframes` which don't use in Scoped CSS |  |
+| [vue-scoped-css/no-unused-selector](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-selector.html) | disallow selectors defined in Scoped CSS that don't use in `<template>` |  |
+| [vue-scoped-css/require-scoped](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-scoped.html) | enforce the `<style>` tags to has the `scoped` attribute |  |
+| [vue-scoped-css/require-v-deep-argument](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-v-deep-argument.html) | require selector argument to be passed to `::v-deep()` | :wrench: |
+| [vue-scoped-css/require-v-global-argument](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-v-global-argument.html) | require selector argument to be passed to `::v-global()` |  |
+| [vue-scoped-css/require-v-slotted-argument](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-v-slotted-argument.html) | require selector argument to be passed to `::v-slotted()` |  |
 
 ## Recommended for Vue.js 2.x
 
@@ -119,10 +119,10 @@ Enforce all the rules in this category with:
 
 | Rule ID | Description |    |
 |:--------|:------------|:---|
-| [vue-scoped-css/no-parsing-error](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-parsing-error.html) | Disallow parsing errors in `<style>` |  |
-| [vue-scoped-css/no-unused-keyframes](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-keyframes.html) | Reports the `@keyframes` is not used in Scoped CSS. |  |
-| [vue-scoped-css/no-unused-selector](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-selector.html) | Reports selectors defined in Scoped CSS not used in `<template>`. |  |
-| [vue-scoped-css/require-scoped](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-scoped.html) | Enforce the `<style>` tags to has the `scoped` attribute. |  |
+| [vue-scoped-css/no-parsing-error](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-parsing-error.html) | disallow parsing errors in `<style>` |  |
+| [vue-scoped-css/no-unused-keyframes](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-keyframes.html) | disallow `@keyframes` which don't use in Scoped CSS |  |
+| [vue-scoped-css/no-unused-selector](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-selector.html) | disallow selectors defined in Scoped CSS that don't use in `<template>` |  |
+| [vue-scoped-css/require-scoped](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-scoped.html) | enforce the `<style>` tags to has the `scoped` attribute |  |
 
 ## Uncategorized
 
@@ -141,7 +141,7 @@ For example:
 
 | Rule ID | Description |    |
 |:--------|:------------|:---|
-| [vue-scoped-css/require-selector-used-inside](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-selector-used-inside.html) | Reports the defined selectors is not used inside `<template>`. |  |
+| [vue-scoped-css/require-selector-used-inside](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-selector-used-inside.html) | disallow selectors defined that is not used inside `<template>` |  |
 
 <!--RULES_TABLE_END-->
 <!--RULES_SECTION_END-->
diff --git a/docs/rules/README.md b/docs/rules/README.md
@@ -19,13 +19,13 @@ Enforce all the rules in this category with:
 | Rule ID | Description |    |
 |:--------|:------------|:---|
 | [vue-scoped-css/no-deprecated-deep-combinator](./no-deprecated-deep-combinator.md) | disallow using deprecated deep combinators | :wrench: |
-| [vue-scoped-css/no-parsing-error](./no-parsing-error.md) | Disallow parsing errors in `<style>` |  |
-| [vue-scoped-css/no-unused-keyframes](./no-unused-keyframes.md) | Reports the `@keyframes` is not used in Scoped CSS. |  |
-| [vue-scoped-css/no-unused-selector](./no-unused-selector.md) | Reports selectors defined in Scoped CSS not used in `<template>`. |  |
-| [vue-scoped-css/require-scoped](./require-scoped.md) | Enforce the `<style>` tags to has the `scoped` attribute. |  |
-| [vue-scoped-css/require-v-deep-argument](./require-v-deep-argument.md) | require selector argument to be passed to `::v-deep()`. | :wrench: |
-| [vue-scoped-css/require-v-global-argument](./require-v-global-argument.md) | require selector argument to be passed to `::v-global()`. |  |
-| [vue-scoped-css/require-v-slotted-argument](./require-v-slotted-argument.md) | require selector argument to be passed to `::v-slotted()`. |  |
+| [vue-scoped-css/no-parsing-error](./no-parsing-error.md) | disallow parsing errors in `<style>` |  |
+| [vue-scoped-css/no-unused-keyframes](./no-unused-keyframes.md) | disallow `@keyframes` which don't use in Scoped CSS |  |
+| [vue-scoped-css/no-unused-selector](./no-unused-selector.md) | disallow selectors defined in Scoped CSS that don't use in `<template>` |  |
+| [vue-scoped-css/require-scoped](./require-scoped.md) | enforce the `<style>` tags to has the `scoped` attribute |  |
+| [vue-scoped-css/require-v-deep-argument](./require-v-deep-argument.md) | require selector argument to be passed to `::v-deep()` | :wrench: |
+| [vue-scoped-css/require-v-global-argument](./require-v-global-argument.md) | require selector argument to be passed to `::v-global()` |  |
+| [vue-scoped-css/require-v-slotted-argument](./require-v-slotted-argument.md) | require selector argument to be passed to `::v-slotted()` |  |
 
 ## Recommended for Vue.js 2.x
 
@@ -39,10 +39,10 @@ Enforce all the rules in this category with:
 
 | Rule ID | Description |    |
 |:--------|:------------|:---|
-| [vue-scoped-css/no-parsing-error](./no-parsing-error.md) | Disallow parsing errors in `<style>` |  |
-| [vue-scoped-css/no-unused-keyframes](./no-unused-keyframes.md) | Reports the `@keyframes` is not used in Scoped CSS. |  |
-| [vue-scoped-css/no-unused-selector](./no-unused-selector.md) | Reports selectors defined in Scoped CSS not used in `<template>`. |  |
-| [vue-scoped-css/require-scoped](./require-scoped.md) | Enforce the `<style>` tags to has the `scoped` attribute. |  |
+| [vue-scoped-css/no-parsing-error](./no-parsing-error.md) | disallow parsing errors in `<style>` |  |
+| [vue-scoped-css/no-unused-keyframes](./no-unused-keyframes.md) | disallow `@keyframes` which don't use in Scoped CSS |  |
+| [vue-scoped-css/no-unused-selector](./no-unused-selector.md) | disallow selectors defined in Scoped CSS that don't use in `<template>` |  |
+| [vue-scoped-css/require-scoped](./require-scoped.md) | enforce the `<style>` tags to has the `scoped` attribute |  |
 
 ## Uncategorized
 
@@ -61,4 +61,4 @@ For example:
 
 | Rule ID | Description |    |
 |:--------|:------------|:---|
-| [vue-scoped-css/require-selector-used-inside](./require-selector-used-inside.md) | Reports the defined selectors is not used inside `<template>`. |  |
+| [vue-scoped-css/require-selector-used-inside](./require-selector-used-inside.md) | disallow selectors defined that is not used inside `<template>` |  |
diff --git a/docs/rules/no-parsing-error.md b/docs/rules/no-parsing-error.md
@@ -2,11 +2,11 @@
 pageClass: "rule-details"
 sidebarDepth: 0
 title: "vue-scoped-css/no-parsing-error"
-description: "Disallow parsing errors in `<style>`"
+description: "disallow parsing errors in `<style>`"
 ---
 # vue-scoped-css/no-parsing-error
 
-> Disallow parsing errors in `<style>`
+> disallow parsing errors in `<style>`
 
 - :gear: This rule is included in all of `"plugin:vue-scoped-css/recommended"`, `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 
diff --git a/docs/rules/no-unused-keyframes.md b/docs/rules/no-unused-keyframes.md
@@ -2,11 +2,11 @@
 pageClass: "rule-details"
 sidebarDepth: 0
 title: "vue-scoped-css/no-unused-keyframes"
-description: "Reports the `@keyframes` is not used in Scoped CSS."
+description: "disallow `@keyframes` which don't use in Scoped CSS"
 ---
 # vue-scoped-css/no-unused-keyframes
 
-> Reports the `@keyframes` is not used in Scoped CSS.
+> disallow `@keyframes` which don't use in Scoped CSS
 
 - :gear: This rule is included in all of `"plugin:vue-scoped-css/recommended"`, `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 
diff --git a/docs/rules/no-unused-selector.md b/docs/rules/no-unused-selector.md
@@ -2,11 +2,11 @@
 pageClass: "rule-details"
 sidebarDepth: 0
 title: "vue-scoped-css/no-unused-selector"
-description: "Reports selectors defined in Scoped CSS not used in `<template>`."
+description: "disallow selectors defined in Scoped CSS that don't use in `<template>`"
 ---
 # vue-scoped-css/no-unused-selector
 
-> Reports selectors defined in Scoped CSS not used in `<template>`.
+> disallow selectors defined in Scoped CSS that don't use in `<template>`
 
 - :gear: This rule is included in all of `"plugin:vue-scoped-css/recommended"`, `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 
diff --git a/docs/rules/require-scoped.md b/docs/rules/require-scoped.md
@@ -2,11 +2,11 @@
 pageClass: "rule-details"
 sidebarDepth: 0
 title: "vue-scoped-css/require-scoped"
-description: "Enforce the `<style>` tags to has the `scoped` attribute."
+description: "enforce the `<style>` tags to has the `scoped` attribute"
 ---
 # vue-scoped-css/require-scoped
 
-> Enforce the `<style>` tags to has the `scoped` attribute.
+> enforce the `<style>` tags to has the `scoped` attribute
 
 - :gear: This rule is included in all of `"plugin:vue-scoped-css/recommended"`, `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 
diff --git a/docs/rules/require-selector-used-inside.md b/docs/rules/require-selector-used-inside.md
@@ -2,11 +2,11 @@
 pageClass: "rule-details"
 sidebarDepth: 0
 title: "vue-scoped-css/require-selector-used-inside"
-description: "Reports the defined selectors is not used inside `<template>`."
+description: "disallow selectors defined that is not used inside `<template>`"
 ---
 # vue-scoped-css/require-selector-used-inside
 
-> Reports the defined selectors is not used inside `<template>`.
+> disallow selectors defined that is not used inside `<template>`
 
 - :gear: This rule is included in `"plugin:vue-scoped-css/all"`.
 
diff --git a/docs/rules/require-v-deep-argument.md b/docs/rules/require-v-deep-argument.md
@@ -2,11 +2,11 @@
 pageClass: "rule-details"
 sidebarDepth: 0
 title: "vue-scoped-css/require-v-deep-argument"
-description: "require selector argument to be passed to `::v-deep()`."
+description: "require selector argument to be passed to `::v-deep()`"
 ---
 # vue-scoped-css/require-v-deep-argument
 
-> require selector argument to be passed to `::v-deep()`.
+> require selector argument to be passed to `::v-deep()`
 
 - :gear: This rule is included in `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 - :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.
diff --git a/docs/rules/require-v-global-argument.md b/docs/rules/require-v-global-argument.md
@@ -2,11 +2,11 @@
 pageClass: "rule-details"
 sidebarDepth: 0
 title: "vue-scoped-css/require-v-global-argument"
-description: "require selector argument to be passed to `::v-global()`."
+description: "require selector argument to be passed to `::v-global()`"
 ---
 # vue-scoped-css/require-v-global-argument
 
-> require selector argument to be passed to `::v-global()`.
+> require selector argument to be passed to `::v-global()`
 
 - :gear: This rule is included in `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 
diff --git a/docs/rules/require-v-slotted-argument.md b/docs/rules/require-v-slotted-argument.md
@@ -2,11 +2,11 @@
 pageClass: "rule-details"
 sidebarDepth: 0
 title: "vue-scoped-css/require-v-slotted-argument"
-description: "require selector argument to be passed to `::v-slotted()`."
+description: "require selector argument to be passed to `::v-slotted()`"
 ---
 # vue-scoped-css/require-v-slotted-argument
 
-> require selector argument to be passed to `::v-slotted()`.
+> require selector argument to be passed to `::v-slotted()`
 
 - :gear: This rule is included in `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 
diff --git a/lib/rules/no-parsing-error.ts b/lib/rules/no-parsing-error.ts
@@ -13,7 +13,7 @@ declare const module: {
 module.exports = {
     meta: {
         docs: {
-            description: "Disallow parsing errors in `<style>`",
+            description: "disallow parsing errors in `<style>`",
             categories: ["recommended", "vue3-recommended"],
             default: "warn",
             url:
diff --git a/lib/rules/no-unused-keyframes.ts b/lib/rules/no-unused-keyframes.ts
@@ -15,7 +15,7 @@ declare const module: {
 module.exports = {
     meta: {
         docs: {
-            description: "Reports the `@keyframes` is not used in Scoped CSS.",
+            description: "disallow `@keyframes` which don't use in Scoped CSS",
             categories: ["recommended", "vue3-recommended"],
             default: "warn",
             url:
diff --git a/lib/rules/no-unused-selector.ts b/lib/rules/no-unused-selector.ts
@@ -96,7 +96,7 @@ module.exports = {
     meta: {
         docs: {
             description:
-                "Reports selectors defined in Scoped CSS not used in `<template>`.",
+                "disallow selectors defined in Scoped CSS that don't use in `<template>`",
             categories: ["recommended", "vue3-recommended"],
             default: "warn",
             url:
diff --git a/lib/rules/require-scoped.ts b/lib/rules/require-scoped.ts
@@ -13,7 +13,7 @@ module.exports = {
     meta: {
         docs: {
             description:
-                "Enforce the `<style>` tags to has the `scoped` attribute.",
+                "enforce the `<style>` tags to has the `scoped` attribute",
             categories: ["recommended", "vue3-recommended"],
             default: "warn",
             url:
diff --git a/lib/rules/require-selector-used-inside.ts b/lib/rules/require-selector-used-inside.ts
@@ -74,7 +74,7 @@ module.exports = {
     meta: {
         docs: {
             description:
-                "Reports the defined selectors is not used inside `<template>`.",
+                "disallow selectors defined that is not used inside `<template>`",
             categories: [],
             default: "warn",
             url:
diff --git a/lib/rules/require-v-deep-argument.ts b/lib/rules/require-v-deep-argument.ts
@@ -27,7 +27,7 @@ module.exports = {
     meta: {
         docs: {
             description:
-                "require selector argument to be passed to `::v-deep()`.",
+                "require selector argument to be passed to `::v-deep()`",
             categories: ["vue3-recommended"],
             default: "warn",
             url:
diff --git a/lib/rules/require-v-global-argument.ts b/lib/rules/require-v-global-argument.ts
@@ -19,7 +19,7 @@ module.exports = {
     meta: {
         docs: {
             description:
-                "require selector argument to be passed to `::v-global()`.",
+                "require selector argument to be passed to `::v-global()`",
             categories: ["vue3-recommended"],
             default: "warn",
             url:
diff --git a/lib/rules/require-v-slotted-argument.ts b/lib/rules/require-v-slotted-argument.ts
@@ -19,7 +19,7 @@ module.exports = {
     meta: {
         docs: {
             description:
-                "require selector argument to be passed to `::v-slotted()`.",
+                "require selector argument to be passed to `::v-slotted()`",
             categories: ["vue3-recommended"],
             default: "warn",
             url:
diff --git a/tests/lib/rules/no-deprecated-deep-combinator.ts b/tests/lib/rules/no-deprecated-deep-combinator.ts
@@ -1,5 +1,5 @@
 import { RuleTester } from "eslint"
-const rule = require("../../../lib/rules/no-deprecated-deep-combinator")
+import rule = require("../../../lib/rules/no-deprecated-deep-combinator")
 
 const tester = new RuleTester({
     parser: require.resolve("vue-eslint-parser"),
@@ -9,7 +9,7 @@ const tester = new RuleTester({
     },
 })
 
-tester.run("no-deprecated-deep-combinator", rule, {
+tester.run("no-deprecated-deep-combinator", rule as any, {
     valid: [
         `
         <template><div class="item">sample</div></template>
diff --git a/tests/lib/rules/no-parsing-error.ts b/tests/lib/rules/no-parsing-error.ts
@@ -1,6 +1,6 @@
 import { RuleTester } from "eslint"
 import semver from "semver"
-const rule = require("../../../lib/rules/no-parsing-error")
+import rule = require("../../../lib/rules/no-parsing-error")
 const parserVersion = require("vue-eslint-parser/package.json").version
 
 const tester = new RuleTester({
@@ -11,7 +11,7 @@ const tester = new RuleTester({
     },
 })
 
-tester.run("no-parsing-error", rule, {
+tester.run("no-parsing-error", rule as any, {
     valid: [
         `
         <template><!-- When using vue-eslint-parser@5, a template tag is required.  --></template>
diff --git a/tests/lib/rules/no-unused-keyframes.ts b/tests/lib/rules/no-unused-keyframes.ts
@@ -1,5 +1,5 @@
 import { RuleTester } from "eslint"
-const rule = require("../../../lib/rules/no-unused-keyframes")
+import rule = require("../../../lib/rules/no-unused-keyframes")
 
 const tester = new RuleTester({
     parser: require.resolve("vue-eslint-parser"),
@@ -9,7 +9,7 @@ const tester = new RuleTester({
     },
 })
 
-tester.run("no-unused-keyframes", rule, {
+tester.run("no-unused-keyframes", rule as any, {
     valid: [
         `
         <template><!-- When using vue-eslint-parser@5, a template tag is required.  --></template>
diff --git a/tests/lib/rules/no-unused-selector.ts b/tests/lib/rules/no-unused-selector.ts
@@ -1,5 +1,5 @@
 import { RuleTester } from "eslint"
-const rule = require("../../../lib/rules/no-unused-selector")
+import rule = require("../../../lib/rules/no-unused-selector")
 
 const tester = new RuleTester({
     parser: require.resolve("vue-eslint-parser"),
@@ -9,7 +9,7 @@ const tester = new RuleTester({
     },
 })
 
-tester.run("no-unused-selector", rule, {
+tester.run("no-unused-selector", rule as any, {
     valid: [
         `
         <template>
diff --git a/tests/lib/rules/require-scoped.ts b/tests/lib/rules/require-scoped.ts
@@ -1,6 +1,6 @@
 import { RuleTester } from "eslint"
 import semver from "semver"
-const rule = require("../../../lib/rules/require-scoped")
+import rule = require("../../../lib/rules/require-scoped")
 
 const parserVersion = require("vue-eslint-parser/package.json").version
 
@@ -12,7 +12,7 @@ const tester = new RuleTester({
     },
 })
 
-tester.run("require-scoped", rule, {
+tester.run("require-scoped", rule as any, {
     valid: [
         `
         <template>
diff --git a/tests/lib/rules/require-selector-used-inside.ts b/tests/lib/rules/require-selector-used-inside.ts
@@ -1,5 +1,5 @@
 import { RuleTester } from "eslint"
-const rule = require("../../../lib/rules/require-selector-used-inside")
+import rule = require("../../../lib/rules/require-selector-used-inside")
 
 const tester = new RuleTester({
     parser: require.resolve("vue-eslint-parser"),
@@ -9,7 +9,7 @@ const tester = new RuleTester({
     },
 })
 
-tester.run("require-selector-used-inside", rule, {
+tester.run("require-selector-used-inside", rule as any, {
     valid: [
         `
         <template>
diff --git a/tests/lib/rules/require-v-deep-argument.ts b/tests/lib/rules/require-v-deep-argument.ts
@@ -1,5 +1,5 @@
 import { RuleTester } from "eslint"
-const rule = require("../../../lib/rules/require-v-deep-argument")
+import rule = require("../../../lib/rules/require-v-deep-argument")
 
 const tester = new RuleTester({
     parser: require.resolve("vue-eslint-parser"),
@@ -9,7 +9,7 @@ const tester = new RuleTester({
     },
 })
 
-tester.run("require-v-deep-argument", rule, {
+tester.run("require-v-deep-argument", rule as any, {
     valid: [
         `
         <template><div class="item">sample</div></template>
diff --git a/tests/lib/rules/require-v-global-argument.ts b/tests/lib/rules/require-v-global-argument.ts
diff --git a/tests/lib/rules/require-v-slotted-argument.ts b/tests/lib/rules/require-v-slotted-argument.ts
diff --git a/tools/new-rule.ts b/tools/new-rule.ts
