eslint-plugin-mpx 0.2.19 → 0.2.20-1

package/lib/rules/no-duplicate-attributes.js

@@ -49,7 +49,6 @@ module.exports = {
       url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/no-duplicate-attributes.html'
     },
     fixable: null,
-
     schema: [
       {
         type: 'object',
@@ -62,7 +61,10 @@ module.exports = {
           }
         }
       }
-    ]
+    ],
+    messages: {
+      name: "Duplicate attribute '{{name}}'."
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -93,7 +95,7 @@ module.exports = {
           context.report({
             node,
             loc: node.loc,
-            message: "Duplicate attribute '{{name}}'.",
+            messageId: 'name',
             data: { name }
           })
         }

package/lib/rules/no-parsing-error.js

@@ -67,13 +67,17 @@ module.exports = {
     schema: [
       {
         type: 'object',
+        // eslint-disable-next-line unicorn/no-array-reduce
         properties: Object.keys(DEFAULT_OPTIONS).reduce((ret, code) => {
           ret[code] = { type: 'boolean' }
           return ret
         }, /** @type { { [key: string]: { type: 'boolean' } } } */ ({})),
         additionalProperties: false
       }
-    ]
+    ],
+    messages: {
+      msg: 'Parsing error: {{message}}.'
+    }
   },
   /**
    * @param {RuleContext} context - The rule context.
@@ -97,7 +101,7 @@ module.exports = {
           context.report({
             node,
             loc: { line: error.lineNumber, column: error.column },
-            message: 'Parsing error: {{message}}.',
+            messageId: 'msg',
             data: {
               message: error.message.endsWith('.')
                 ? error.message.slice(0, -1)

package/lib/rules/no-reserved-keys.js

@@ -40,13 +40,20 @@ module.exports = {
         },
         additionalProperties: false
       }
-    ]
+    ],
+    messages: {
+      reserved: "Key '{{name}}' is reserved.",
+      group: "Keys starting with with '_' are reserved in '{{name}}' group."
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
     const options = context.options[0] || {}
-    const reservedKeys = new Set(RESERVED_KEYS.concat(options.reserved || []))
-    const groups = new Set(GROUP_NAMES.concat(options.groups || []))
+    const reservedKeys = new Set([
+      ...RESERVED_KEYS,
+      ...(options.reserved || [])
+    ])
+    const groups = new Set([...GROUP_NAMES, ...(options.groups || [])])
 
     // ----------------------------------------------------------------------
     // Public
@@ -58,8 +65,7 @@ module.exports = {
         if (o.groupName === 'data' && o.name[0] === '_') {
           context.report({
             node: o.node,
-            message:
-              "Keys starting with with '_' are reserved in '{{name}}' group.",
+            messageId: 'group',
             data: {
               name: o.name
             }
@@ -67,7 +73,7 @@ module.exports = {
         } else if (reservedKeys.has(o.name)) {
           context.report({
             node: o.node,
-            message: "Key '{{name}}' is reserved.",
+            messageId: 'reserved',
             data: {
               name: o.name
             }

package/lib/rules/no-side-effects-in-computed-properties.js

@@ -24,7 +24,10 @@ module.exports = {
       url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/no-side-effects-in-computed-properties.html'
     },
     fixable: null,
-    schema: []
+    schema: [],
+    messages: {
+      property: 'Unexpected side effect in "{{key}}" computed property.'
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -74,14 +77,13 @@ module.exports = {
         const targetBody = scopeStack.body
         const computedProperty = /** @type {ComponentComputedProperty[]} */ (
           computedPropertiesMap.get(vueNode)
-        ).find((cp) => {
-          return (
+        ).find(
+          (cp) =>
             cp.value &&
             node.loc.start.line >= cp.value.loc.start.line &&
             node.loc.end.line <= cp.value.loc.end.line &&
             targetBody === cp.value
-          )
-        })
+        )
         if (!computedProperty) {
           return
         }
@@ -98,7 +100,7 @@ module.exports = {
         if (invalid) {
           context.report({
             node: invalid.node,
-            message: 'Unexpected side effect in "{{key}}" computed property.',
+            messageId: 'property',
             data: { key: computedProperty.key || 'Unknown' }
           })
         }

package/lib/rules/return-in-computed-property.js

@@ -34,7 +34,10 @@ module.exports = {
         },
         additionalProperties: false
       }
-    ]
+    ],
+    messages: {
+      returnValue: 'Expected to return a value in "{{name}}" computed property.'
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -64,18 +67,17 @@ module.exports = {
       utils.executeOnFunctionsWithoutReturn(
         treatUndefinedAsUnspecified,
         (node) => {
-          computedProperties.forEach((cp) => {
+          for (const cp of computedProperties) {
             if (cp.value && cp.value.parent === node) {
               context.report({
                 node,
-                message:
-                  'Expected to return a value in "{{name}}" computed property.',
+                messageId: 'returnValue',
                 data: {
                   name: cp.key || 'Unknown'
                 }
               })
             }
-          })
+          }
         }
       )
     )

package/lib/rules/script-indent.js

@@ -11,8 +11,9 @@ module.exports = {
     docs: {
       description: 'enforce consistent indentation in `<script>`',
       categories: undefined,
-      url: ''
+      url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/script-indent.html'
     },
+    // eslint-disable-next-line eslint-plugin/require-meta-fixable
     fixable: 'whitespace',
     schema: [
       {
@@ -29,7 +30,7 @@ module.exports = {
               allOf: [
                 { type: 'string' },
                 { not: { type: 'string', pattern: ':exit$' } },
-                { not: { type: 'string', pattern: '^\\s*$' } }
+                { not: { type: 'string', pattern: String.raw`^\s*$` } }
               ]
             },
             uniqueItems: true,
@@ -38,7 +39,9 @@ module.exports = {
         },
         additionalProperties: false
       }
-    ]
+    ],
+    // eslint-disable-next-line eslint-plugin/prefer-message-ids
+    messages: {}
   },
   /** @param {RuleContext} context */
   create(context) {

package/lib/rules/script-setup-uses-vars.js

@@ -22,10 +22,12 @@ module.exports = {
       description:
         'prevent `<script setup>` variables used in `<template>` to be marked as unused', // eslint-disable-line eslint-plugin/require-meta-docs-description
       categories: undefined,
-      url: 'https://eslint.vuejs.org/rules/script-setup-uses-vars.html'
+      url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/script-setup-uses-vars.html'
     },
     deprecated: true,
-    schema: []
+    schema: [],
+    // eslint-disable-next-line eslint-plugin/prefer-message-ids
+    messages: {}
   },
   /**
    * @param {RuleContext} context - The rule context.

package/lib/rules/syntaxes/slot-attribute.js

@@ -15,6 +15,7 @@ module.exports = {
      * @param {VAttribute} slotAttr node of `slot`
      * @returns {boolean} `true` if the given node can convert to the `v-slot`
      */
+    // eslint-disable-next-line unicorn/consistent-function-scoping
     function canConvertFromSlotToVSlot(slotAttr) {
       if (slotAttr.parent.parent.name !== 'template') {
         return false

package/lib/rules/syntaxes/slot-scope-attribute.js

@@ -20,6 +20,7 @@ module.exports = {
      * @param {VStartTag} startTag node of `<element v-slot ... >`
      * @returns {boolean} `true` if the given node can convert to the `v-slot`
      */
+    // eslint-disable-next-line unicorn/consistent-function-scoping
     function canConvertToVSlot(startTag) {
       if (startTag.parent.name !== 'template') {
         return false

package/lib/rules/syntaxes/v-slot.js

@@ -14,6 +14,7 @@ module.exports = {
      * @param {VDirective} vSlotAttr node of `v-slot`
      * @returns {boolean} `true` if the given node can convert to the `slot`
      */
+    // eslint-disable-next-line unicorn/consistent-function-scoping
     function canConvertToSlot(vSlotAttr) {
       if (vSlotAttr.parent.parent.name !== 'template') {
         return false
@@ -28,7 +29,7 @@ module.exports = {
      */
     function fixVSlotToSlot(fixer, vSlotAttr) {
       const key = vSlotAttr.key
-      if (key.modifiers.length) {
+      if (key.modifiers.length > 0) {
         // unknown modifiers
         return null
       }
@@ -54,7 +55,7 @@ module.exports = {
       if (scopedValueNode) {
         attrs.push(`slot-scope=${sourceCode.getText(scopedValueNode)}`)
       }
-      if (!attrs.length) {
+      if (attrs.length === 0) {
         attrs.push('slot') // useless
       }
       return fixer.replaceText(vSlotAttr, attrs.join(' '))

package/lib/rules/valid-attribute-value.js

@@ -23,8 +23,12 @@ module.exports = {
       categories: ['mpx-essential'],
       url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/valid-attribute-value.html'
     },
-    fixable: 'code',
-    schema: []
+    fixable: null,
+    schema: [],
+    messages: {
+      requireValue: "'{{value}}' attribute expression require valid value.",
+      requireAttribute: "'{{value}}' directive require that attribute value."
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -40,18 +44,19 @@ module.exports = {
           context.report({
             node,
             loc: node.loc,
-            message: "'{{value}}' attribute expression require valid value.",
+            messageId: 'requireValue',
             data: {
               value: sourceCode.getText(node)
             }
           })
         } else if (node.directive) {
           // 若为指令，继续判断是否为空值
-          if (utils.isEmptyValueDirective(node, context)) {
+          const isEmpty = utils.isEmptyValueDirective(node, context)
+          if (isEmpty) {
             context.report({
               node,
               loc: node.loc,
-              message: "'{{value}}' directive require that attribute value.",
+              messageId: 'requireAttribute',
               data: {
                 value: sourceCode.getText(node)
               }

package/lib/rules/valid-component-range.js

@@ -19,12 +19,19 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: '强制 component 添加 range 范围',
+      description: 'require 强制 component 添加 range 范围',
       categories: ['mpx-essential'],
       url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/valid-component-range.html'
     },
     fixable: null,
-    schema: []
+    schema: [],
+    messages: {
+      elementRequire: "'component' element require 'is' attribute.",
+      elementRange: "'component' element require 'range' for backup.",
+      elementScope:
+        "'component' element require 'range' attribute to set the scope.",
+      componentRequire: "'component' attribute '{{key}}' require valid value."
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -38,37 +45,36 @@ module.exports = {
           return context.report({
             node,
             loc: node.loc,
-            message: "'component' element require 'is' attribute."
+            messageId: 'elementRequire'
           })
-        } else if (!rangeNode.length) {
-          context.report({
-            node,
-            loc: node.loc,
-            message:
-              "'component' element require 'range' attribute to set the scope."
-          })
-        } else {
+        } else if (rangeNode.length > 0) {
           // 最好有个兜底range
           if (!utils.getAttribute(node, 'range')) {
             context.report({
               node,
               loc: node.loc,
-              message: "'component' element require 'range' for backup."
+              messageId: 'elementRange'
             })
           }
+        } else {
+          context.report({
+            node,
+            loc: node.loc,
+            messageId: 'elementScope'
+          })
         }
-        ;[isNode, ...rangeNode].forEach((keyNode) => {
+        for (const keyNode of [isNode, ...rangeNode]) {
           if (keyNode && (!keyNode.value || !keyNode.value.value)) {
             context.report({
               node,
               loc: node.loc,
-              message: "'component' attribute '{{key}}' require valid value.",
+              messageId: 'componentRequire',
               data: {
                 key: keyNode.key.name
               }
             })
           }
-        })
+        }
       }
     })
   }

package/lib/rules/valid-initdata.js

@@ -11,7 +11,7 @@
 const utils = require('../utils')
 function commonFunction(value, list) {
   const props = value.properties
-  props.forEach((item) => {
+  for (const item of props) {
     if (
       item.type === 'SpreadElement' &&
       item.argument &&
@@ -26,24 +26,24 @@ function commonFunction(value, list) {
         if (item.argument.arguments.arguments) {
           const elements = item.argument.arguments.arguments.elements
           if (elements) {
-            elements.forEach((row) => {
+            for (const row of elements) {
               if (row.type === 'ArrayExpression') {
                 args = row.elements
               }
-            })
+            }
           }
         }
       }
-      args.forEach((item) => {
+      for (const item of args) {
         list.add(item.value)
-      })
+      }
     } else {
       list.add(item.key.name)
     }
-  })
+  }
 }
 function handleInitData(current, propsSet, parentName) {
-  current.forEach((item) => {
+  for (const item of current) {
     const currentName = item.key.name
     if (currentName) {
       let name = currentName
@@ -59,7 +59,7 @@ function handleInitData(current, propsSet, parentName) {
       }
       handleInitData(item.value.properties, propsSet, pre)
     }
-  })
+  }
 }
 
 function checkInInitData(
@@ -112,9 +112,10 @@ module.exports = {
   meta: {
     type: 'suggestion', // `problem`, `suggestion`, or `layout`
     docs: {
-      description: 'initData检测',
+      description: 'require initData检测',
       recommended: false,
-      url: null // URL to the documentation page for this rule
+      categories: ['mpx-essential', 'composition-api-essential'],
+      url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/valid-initdata.html' // URL to the documentation page for this rule
     },
     fixable: null, // Or `code` or `whitespace`
     schema: [], // Add a schema if the rule has options
@@ -131,7 +132,7 @@ module.exports = {
     // 收集computed属性
     const computedSet = new Set([])
     // 忽略的标签类型
-    const ignoreElementTypes = [
+    const ignoreElementTypes = new Set([
       'view',
       'text',
       'image',
@@ -154,8 +155,8 @@ module.exports = {
       'radio',
       'radio-group',
       'switch'
-    ]
-    const ignoreAttributeTypes = [
+    ])
+    const ignoreAttributeTypes = new Set([
       'wx:if',
       'wx:else',
       'bindtap',
@@ -168,7 +169,7 @@ module.exports = {
       'style',
       'hover-class',
       'src'
-    ]
+    ])
     // 全局是否有initData 初始值：0 ，存在： 1，不存在： 2
     let hasInitData = 0
     return utils.defineTemplateBodyVisitor(
@@ -177,13 +178,13 @@ module.exports = {
         // VExpressionContainer(node) {},
         VAttribute(node) {
           const parent = node.parent
-          if (!ignoreElementTypes.includes(parent.name)) {
-            if (
-              !ignoreAttributeTypes.includes(node.key.name) &&
+          if (!ignoreElementTypes.has(parent.name)) {
+            const isattr =
+              !ignoreAttributeTypes.has(node.key.name) &&
               node.value &&
               node.value.value &&
               node.value.value.startsWith('{{')
-            ) {
+            if (isattr) {
               const reg = /(?<={{).*?(?=}})/
               checkInInitData(
                 computedSet,
@@ -210,7 +211,7 @@ module.exports = {
           if (!utils.isScriptSetup(context)) return
           const body = node.body
           if (body) {
-            body.forEach((item) => {
+            for (const item of body) {
               if (
                 item.type === 'ExpressionStatement' &&
                 item.expression &&
@@ -218,15 +219,15 @@ module.exports = {
                 item.expression.callee.name === 'defineOptions' &&
                 item.expression.arguments
               ) {
-                item.expression.arguments.forEach((sub) => {
+                for (const sub of item.expression.arguments) {
                   if (sub.type === 'ObjectExpression' && sub.properties) {
-                    sub.properties.forEach((val) => {
+                    for (const val of sub.properties) {
                       if (val.key.name === 'initData') {
                         hasInitData = 1
                       }
-                    })
+                    }
                   }
-                })
+                }
                 if (hasInitData === 0) {
                   hasInitData = 2
                 }
@@ -235,7 +236,7 @@ module.exports = {
                   hasInitData = 2
                 }
               }
-            })
+            }
           }
         },
         CallExpression(node) {
@@ -248,11 +249,11 @@ module.exports = {
             if (node.callee.name !== 'createComponent') return
             const properties = node.arguments[0].properties
             if (!properties) return
-            properties.forEach((element) => {
+            for (const element of properties) {
               if (element.key.name === 'initData') {
                 hasInitData = 1
               }
-            })
+            }
             if (hasInitData === 0) {
               hasInitData = 2
             }
@@ -260,14 +261,16 @@ module.exports = {
         },
         ObjectExpression(node) {
           const parent = node.parent
-          if (parent && parent.type === 'CallExpression') {
-            if (parent.callee.name === 'defineOptions') {
-              if (node.properties && Array.isArray(node.properties)) {
-                node.properties.forEach((item) => {
-                  if (item.key.name === 'initData') {
-                    handleInitData(item.value.properties, propsSet)
-                  }
-                })
+          const isinit =
+            parent &&
+            parent.type === 'CallExpression' &&
+            parent.callee.name === 'defineOptions' &&
+            node.properties &&
+            Array.isArray(node.properties)
+          if (isinit) {
+            for (const item of node.properties) {
+              if (item.key.name === 'initData') {
+                handleInitData(item.value.properties, propsSet)
               }
             }
           }
@@ -277,10 +280,10 @@ module.exports = {
             commonFunction(node.value, computedSet)
           }
           if (node.key.name === 'initData') {
-            if (
+            const isCreate =
               node.parent.parent.callee &&
               node.parent.parent.callee.name === 'createComponent'
-            ) {
+            if (isCreate) {
               handleInitData(node.value.properties, propsSet)
             }
           }

package/lib/rules/valid-properties.js

@@ -47,7 +47,7 @@ function validProp(node, context, allowKeys) {
     })
   }
   if (node.value.type === 'ObjectExpression') {
-    if (!node.value.properties.length) {
+    if (node.value.properties.length === 0) {
       return context.report({
         node: node.value,
         message: "The value of '{{propName}}' cannot be empty object.",
@@ -57,8 +57,8 @@ function validProp(node, context, allowKeys) {
       })
     }
     let hasType = 0
-    node.value.properties.forEach((item) => {
-      if (item.type !== 'Property') return
+    for (const item of node.value.properties) {
+      if (item.type !== 'Property') continue
       const keyName = sourceCode.getText(item.key)
       if (!allowKeys.includes(keyName)) {
         context.report({
@@ -72,7 +72,7 @@ function validProp(node, context, allowKeys) {
       } else if (keyName === 'type') {
         hasType = 1
       }
-    })
+    }
     if (!hasType) {
       context.report({
         node: node.value,
@@ -113,7 +113,9 @@ module.exports = {
           }
         }
       }
-    ]
+    ],
+    // eslint-disable-next-line eslint-plugin/prefer-message-ids
+    messages: {}
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -125,6 +127,7 @@ module.exports = {
     // Public
     // ----------------------------------------------------------------------
 
+    // eslint-disable-next-line unicorn/prefer-ternary
     if (isScriptSetup) {
       return utils.defineTemplateBodyVisitor(
         context,