Add meta.docs.url to rules (#285)

Author: ota-meshi

docs/rules/key-format-style.md

@@ -41,7 +41,7 @@ Also, the following localization key definitions are reported as errors, because
 
 </eslint-code-block>
 
-## Options
+## :gear: Options
 
 ```json
 {

docs/rules/keys-order.md

@@ -44,7 +44,7 @@ This rule is useful to provide browsability of localization keys.
 
 </eslint-code-block>
 
-## Options
+## :gear: Options
 
 ```json
 {

docs/rules/no-missing-keys-in-other-locales.md

@@ -68,7 +68,7 @@ locale messages:
 
 </resource-group>
 
-## Options
+## :gear: Options
 
 ```json
 {

lib/rules/key-format-style.ts

@@ -9,6 +9,7 @@ import debugBuilder from 'debug'
 import type { RuleContext, RuleListener } from '../types'
 import { getCasingChecker } from '../utils/casing'
 import type { LocaleMessage } from '../utils/locale-messages'
+import { createRule } from '../utils/rule'
 const debug = debugBuilder('eslint-plugin-vue-i18n:key-format-style')
 
 const allowedCaseOptions = [
@@ -212,18 +213,19 @@ function create(context: RuleContext): RuleListener {
   }
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'layout',
     docs: {
       description: 'enforce specific casing for localization keys',
       category: 'Best Practices',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/key-format-style.html',
       recommended: false
     },
     fixable: null,
     schema: [
       {
-        enum: allowedCaseOptions
+        enum: [...allowedCaseOptions]
       },
       {
         type: 'object',
@@ -237,4 +239,4 @@ export = {
     ]
   },
   create
-}
+})

lib/rules/no-deprecated-i18n-component.ts

@@ -4,6 +4,7 @@
 import { defineTemplateBodyVisitor } from '../utils/index'
 import type { RuleContext, RuleListener } from '../types'
 import type { AST as VAST } from 'vue-eslint-parser'
+import { createRule } from '../utils/rule'
 
 function create(context: RuleContext): RuleListener {
   return defineTemplateBodyVisitor(context, {
@@ -81,13 +82,14 @@ function create(context: RuleContext): RuleListener {
   })
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'problem',
     docs: {
       description:
         'disallow using deprecated `<i18n>` components (in Vue I18n 9.0.0+)',
       category: 'Recommended',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-deprecated-i18n-component.html',
       recommended: false
     },
     fixable: 'code',
@@ -98,4 +100,4 @@ export = {
     }
   },
   create
-}
+})

lib/rules/no-deprecated-i18n-place-attr.ts

@@ -8,6 +8,7 @@ import {
 } from '../utils/index'
 import type { RuleContext, RuleListener } from '../types'
 import type { AST as VAST } from 'vue-eslint-parser'
+import { createRule } from '../utils/rule'
 
 function create(context: RuleContext): RuleListener {
   return defineTemplateBodyVisitor(context, {
@@ -32,13 +33,14 @@ function create(context: RuleContext): RuleListener {
   })
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'problem',
     docs: {
       description:
         'disallow using deprecated `place` attribute (Removed in Vue I18n 9.0.0+)',
       category: 'Recommended',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-deprecated-i18n-place-attr.html',
       recommended: false
     },
     fixable: null,
@@ -48,4 +50,4 @@ export = {
     }
   },
   create
-}
+})

lib/rules/no-deprecated-i18n-places-prop.ts

@@ -8,6 +8,7 @@ import {
 } from '../utils/index'
 import type { RuleContext, RuleListener } from '../types'
 import type { AST as VAST } from 'vue-eslint-parser'
+import { createRule } from '../utils/rule'
 
 function create(context: RuleContext): RuleListener {
   return defineTemplateBodyVisitor(context, {
@@ -27,13 +28,14 @@ function create(context: RuleContext): RuleListener {
   })
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'problem',
     docs: {
       description:
         'disallow using deprecated `places` prop (Removed in Vue I18n 9.0.0+)',
       category: 'Recommended',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-deprecated-i18n-places-prop.html',
       recommended: false
     },
     fixable: null,
@@ -43,4 +45,4 @@ export = {
     }
   },
   create
-}
+})

lib/rules/no-duplicate-keys-in-locale.ts

@@ -15,6 +15,7 @@ import type {
 } from '../types'
 import { joinPath } from '../utils/key-path'
 import { getCwd } from '../utils/get-cwd'
+import { createRule } from '../utils/rule'
 const debug = debugBuilder('eslint-plugin-vue-i18n:no-duplicate-keys-in-locale')
 
 interface DictData {
@@ -371,13 +372,14 @@ function create(context: RuleContext): RuleListener {
   }
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'problem',
     docs: {
       description:
         'disallow duplicate localization keys within the same locale',
       category: 'Best Practices',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-duplicate-keys-in-locale.html',
       recommended: false
     },
     fixable: null,
@@ -394,4 +396,4 @@ export = {
     ]
   },
   create
-}
+})

lib/rules/no-dynamic-keys.ts

@@ -4,6 +4,7 @@
 import { defineTemplateBodyVisitor } from '../utils/index'
 import type { RuleContext, RuleListener } from '../types'
 import type { AST as VAST } from 'vue-eslint-parser'
+import { createRule } from '../utils/rule'
 
 function isStatic(
   node:
@@ -138,16 +139,17 @@ function create(context: RuleContext): RuleListener {
   )
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'suggestion',
     docs: {
       description: 'disallow localization dynamic keys at localization methods',
       category: 'Best Practices',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-dynamic-keys.html',
       recommended: false
     },
     fixable: null,
     schema: []
   },
   create
-}
+})

lib/rules/no-html-messages.ts

@@ -8,6 +8,7 @@ import debugBuilder from 'debug'
 import type { AST as JSONAST } from 'jsonc-eslint-parser'
 import type { AST as YAMLAST } from 'yaml-eslint-parser'
 import type { RuleContext, RuleListener } from '../types'
+import { createRule } from '../utils/rule'
 
 const debug = debugBuilder('eslint-plugin-vue-i18n:no-html-messages')
 
@@ -115,16 +116,17 @@ function create(context: RuleContext): RuleListener {
   }
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'problem',
     docs: {
       description: 'disallow use HTML localization messages',
       category: 'Recommended',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-html-messages.html',
       recommended: true
     },
     fixable: null,
     schema: []
   },
   create
-}
+})

lib/rules/no-i18n-t-path-prop.ts

@@ -8,6 +8,7 @@ import {
 } from '../utils/index'
 import type { RuleContext, RuleListener } from '../types'
 import type { AST as VAST } from 'vue-eslint-parser'
+import { createRule } from '../utils/rule'
 
 function create(context: RuleContext): RuleListener {
   return defineTemplateBodyVisitor(context, {
@@ -34,12 +35,13 @@ function create(context: RuleContext): RuleListener {
   })
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'problem',
     docs: {
       description: 'disallow using `path` prop with `<i18n-t>`',
       category: 'Recommended',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-i18n-t-path-prop.html',
       recommended: false
     },
     fixable: 'code',
@@ -50,4 +52,4 @@ export = {
     }
   },
   create
-}
+})

lib/rules/no-missing-keys-in-other-locales.ts

@@ -13,6 +13,7 @@ import type {
 } from '../types'
 import type { LocaleMessage, LocaleMessages } from '../utils/locale-messages'
 import { joinPath } from '../utils/key-path'
+import { createRule } from '../utils/rule'
 const debug = debugBuilder(
   'eslint-plugin-vue-i18n:no-missing-keys-in-other-locales'
 )
@@ -326,12 +327,13 @@ function create(context: RuleContext): RuleListener {
   }
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'layout',
     docs: {
       description: 'disallow missing locale message keys in other locales',
       category: 'Best Practices',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-missing-keys-in-other-locales.html',
       recommended: false
     },
     fixable: null,
@@ -349,4 +351,4 @@ export = {
     ]
   },
   create
-}
+})

lib/rules/no-missing-keys.ts

@@ -4,6 +4,7 @@
 import { defineTemplateBodyVisitor, getLocaleMessages } from '../utils/index'
 import type { AST as VAST } from 'vue-eslint-parser'
 import type { RuleContext, RuleListener } from '../types'
+import { createRule } from '../utils/rule'
 
 function create(context: RuleContext): RuleListener {
   return defineTemplateBodyVisitor(
@@ -126,13 +127,14 @@ function checkCallExpression(
   }
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'problem',
     docs: {
       description:
         'disallow missing locale message key at localization methods',
       category: 'Recommended',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-missing-keys.html',
       recommended: true
     },
     fixable: null,
@@ -142,4 +144,4 @@ export = {
     }
   },
   create
-}
+})

lib/rules/no-raw-text.ts

@@ -24,6 +24,7 @@ import type {
   Range
 } from '../types'
 import { isKebabCase, pascalCase } from '../utils/casing'
+import { createRule } from '../utils/rule'
 
 type LiteralValue = VAST.ESLintLiteral['value']
 type StaticTemplateLiteral = VAST.ESLintTemplateLiteral & {
@@ -859,12 +860,13 @@ function create(context: RuleContext): RuleListener {
   })
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'suggestion',
     docs: {
       description: 'disallow to string literal in template or JSX',
       category: 'Recommended',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-raw-text.html',
       recommended: true
     },
     fixable: null,
@@ -898,4 +900,4 @@ export = {
     ]
   },
   create
-}
+})

lib/rules/no-unused-keys.ts

@@ -22,6 +22,7 @@ import type {
 } from '../types'
 import { joinPath, parsePath } from '../utils/key-path'
 import { getCwd } from '../utils/get-cwd'
+import { createRule } from '../utils/rule'
 const debug = debugBuilder('eslint-plugin-vue-i18n:no-unused-keys')
 
 type UsedKeys = {
@@ -554,12 +555,13 @@ function create(context: RuleContext): RuleListener {
   }
 }
 
-export = {
+export = createRule({
   meta: {
     type: 'suggestion',
     docs: {
       description: 'disallow unused localization keys',
       category: 'Best Practices',
+      url: 'https://eslint-plugin-vue-i18n.intlify.dev/rules/no-unused-keys.html',
       recommended: false
     },
     fixable: 'code',
@@ -585,4 +587,4 @@ export = {
     ]
   },
   create
-}
+})