eslint-plugin-mpx 0.2.19 → 0.2.20-1

package/lib/configs/flat/base.js

@@ -0,0 +1,22 @@
+/*
+ * IMPORTANT!
+ * This file has been automatically generated,
+ * in order to update its content execute "npm run update"
+ */
+module.exports = [
+  {
+    name: 'mpx/base',
+    plugins: {
+      get mpx() {
+        return require('../../index')
+      }
+    },
+    languageOptions: {
+      parser: require('mpx-eslint-parser'),
+      sourceType: 'module'
+    },
+    rules: {
+      'vue/comment-directive': 'error'
+    }
+  }
+]

package/lib/configs/flat/composition-api-essential.js

@@ -0,0 +1,24 @@
+'use strict'
+const config = require('./base.js')
+
+module.exports = [
+  ...config,
+  {
+    name: 'mpx/composition-api-essential/rules',
+    rules: {
+      'mpx/html-end-tags': 'error',
+      'mpx/no-dupe-wx-elif': 'error',
+      'mpx/no-duplicate-attributes': 'error',
+      'mpx/valid-wx-if': 'error',
+      'mpx/valid-wx-else': 'error',
+      'mpx/valid-wx-elif': 'error',
+      'mpx/valid-wx-model': 'error',
+      // 'mpx/script-setup-uses-vars': 'error',
+      'mpx/valid-initdata': 'warn',
+      'mpx/valid-setup-define-expose': 'error',
+      'mpx/no-deprecated-mpx-createfunction': 'error',
+      'mpx/no-deprecated-watch-second-param': 'error',
+      'mpx/no-deprecated-lifecycle': 'error'
+    }
+  }
+]

package/lib/configs/flat/mpx-essential.js

@@ -0,0 +1,30 @@
+'use strict'
+const config = require('./base.js')
+
+module.exports = [
+  ...config,
+  {
+    name: 'mpx/mpx-essential/rules',
+    rules: {
+      'mpx/html-end-tags': 'error',
+      'mpx/no-arrow-functions-in-watch': 'error',
+      'mpx/no-async-in-computed-properties': 'error',
+      'mpx/no-dupe-keys': 'error',
+      'mpx/no-dupe-wx-elif': 'error',
+      'mpx/no-duplicate-attributes': 'error',
+      'mpx/no-reserved-keys': 'error',
+      'mpx/no-side-effects-in-computed-properties': 'error',
+      'mpx/return-in-computed-property': 'error',
+      'mpx/valid-wx-if': 'error',
+      'mpx/valid-wx-else': 'error',
+      'mpx/valid-wx-elif': 'error',
+      'mpx/valid-wx-model': 'error',
+      'mpx/valid-swiper-item-style': 'error',
+      'mpx/valid-wx-key': 'error',
+      'mpx/valid-attribute-value': 'error',
+      'mpx/valid-template-quote': 'error',
+      'mpx/valid-component-range': 'error',
+      'mpx/valid-properties': 'error'
+    }
+  }
+]

package/lib/index.js

@@ -6,6 +6,7 @@
 'use strict'
 
 module.exports = {
+  meta: require('./meta'),
   rules: {
     'comment-directive': require('./rules/comment-directive'),
     'component-tags-order': require('./rules/component-tags-order'),
@@ -41,9 +42,13 @@ module.exports = {
   configs: {
     base: require('./configs/base'),
     'mpx-essential': require('./configs/mpx-essential'),
-    'composition-api-essential': require('./configs/composition-api-essential')
+    'composition-api-essential': require('./configs/composition-api-essential'),
+    'flat/base': require('./configs/base'),
+    'flat/mpx-essential': require('./configs/mpx-essential'),
+    'flat/composition-api-essential': require('./configs/composition-api-essential')
   },
   processors: {
-    '.mpx': require('./processor')
+    '.mpx': require('./processor'),
+    mpx: require('./processor')
   }
 }

package/lib/meta.js

@@ -0,0 +1,3 @@
+'use strict'
+const { name, version } = require('../package.json')
+module.exports = { name, version }

package/lib/processor.js

@@ -46,48 +46,58 @@ module.exports = {
         const directiveType = message.messageId
         const data = message.message.split(' ')
         switch (directiveType) {
-          case 'disableBlock':
+          case 'disableBlock': {
             state.block.disableAllKeys.add(data[1])
             break
-          case 'disableLine':
+          }
+          case 'disableLine': {
             state.line.disableAllKeys.add(data[1])
             break
-          case 'enableBlock':
+          }
+          case 'enableBlock': {
             state.block.disableAllKeys.clear()
             break
-          case 'enableLine':
+          }
+          case 'enableLine': {
             state.line.disableAllKeys.clear()
             break
-          case 'disableBlockRule':
+          }
+          case 'disableBlockRule': {
             addDisableRule(state.block.disableRuleKeys, data[1], data[2])
             break
-          case 'disableLineRule':
+          }
+          case 'disableLineRule': {
             addDisableRule(state.line.disableRuleKeys, data[1], data[2])
             break
-          case 'enableBlockRule':
+          }
+          case 'enableBlockRule': {
             state.block.disableRuleKeys.delete(data[1])
             break
-          case 'enableLineRule':
+          }
+          case 'enableLineRule': {
             state.line.disableRuleKeys.delete(data[1])
             break
-          case 'clear':
+          }
+          case 'clear': {
             state.block.disableAllKeys.clear()
             state.block.disableRuleKeys.clear()
             state.line.disableAllKeys.clear()
             state.line.disableRuleKeys.clear()
             break
-          default:
+          }
+          default: {
             // unused eslint-disable comments report
             unusedDisableDirectiveReports.set(messageToKey(message), message)
             break
+          }
         }
         return false
       } else {
         const disableDirectiveKeys = []
-        if (state.block.disableAllKeys.size) {
+        if (state.block.disableAllKeys.size > 0) {
           disableDirectiveKeys.push(...state.block.disableAllKeys)
         }
-        if (state.line.disableAllKeys.size) {
+        if (state.line.disableAllKeys.size > 0) {
           disableDirectiveKeys.push(...state.line.disableAllKeys)
         }
         if (message.ruleId) {
@@ -101,7 +111,7 @@ module.exports = {
           }
         }
 
-        if (disableDirectiveKeys.length) {
+        if (disableDirectiveKeys.length > 0) {
           // Store used eslint-disable comment key
           usedDisableDirectiveKeys.push(...disableDirectiveKeys)
           return false
@@ -111,7 +121,7 @@ module.exports = {
       }
     })
 
-    if (unusedDisableDirectiveReports.size) {
+    if (unusedDisableDirectiveReports.size > 0) {
       for (const key of usedDisableDirectiveKeys) {
         // Remove used eslint-disable comments
         unusedDisableDirectiveReports.delete(key)

package/lib/rules/comment-directive.js

@@ -77,16 +77,16 @@ function parse(pattern, comment) {
  * @returns {void}
  */
 function enable(context, loc, group, rule) {
-  if (!rule) {
+  if (rule) {
     context.report({
       loc,
-      messageId: group === 'block' ? 'enableBlock' : 'enableLine'
+      messageId: group === 'block' ? 'enableBlockRule' : 'enableLineRule',
+      data: { rule }
     })
   } else {
     context.report({
       loc,
-      messageId: group === 'block' ? 'enableBlockRule' : 'enableLineRule',
-      data: { rule }
+      messageId: group === 'block' ? 'enableBlock' : 'enableLine'
     })
   }
 }
@@ -101,17 +101,17 @@ function enable(context, loc, group, rule) {
  * @returns {void}
  */
 function disable(context, loc, group, rule, key) {
-  if (!rule) {
+  if (rule) {
     context.report({
       loc,
-      messageId: group === 'block' ? 'disableBlock' : 'disableLine',
-      data: { key }
+      messageId: group === 'block' ? 'disableBlockRule' : 'disableLineRule',
+      data: { rule, key }
     })
   } else {
     context.report({
       loc,
-      messageId: group === 'block' ? 'disableBlockRule' : 'disableLineRule',
-      data: { rule, key }
+      messageId: group === 'block' ? 'disableBlock' : 'disableLine',
+      data: { key }
     })
   }
 }
@@ -128,7 +128,7 @@ function processBlock(context, comment, reportUnusedDisableDirectives) {
   const parsed = parse(COMMENT_DIRECTIVE_B, comment.value)
   if (parsed != null) {
     if (parsed.type === 'eslint-disable') {
-      if (parsed.rules.length) {
+      if (parsed.rules.length > 0) {
         const rules = reportUnusedDisableDirectives
           ? reportUnusedRules(context, comment, parsed.type, parsed.rules)
           : parsed.rules
@@ -148,7 +148,7 @@ function processBlock(context, comment, reportUnusedDisableDirectives) {
         disable(context, comment.loc.start, 'block', null, key)
       }
     } else {
-      if (parsed.rules.length) {
+      if (parsed.rules.length > 0) {
         for (const rule of parsed.rules) {
           enable(context, comment.loc.start, 'block', rule.ruleId)
         }
@@ -173,7 +173,7 @@ function processLine(context, comment, reportUnusedDisableDirectives) {
     const line =
       comment.loc.start.line + (parsed.type === 'eslint-disable-line' ? 0 : 1)
     const column = -1
-    if (parsed.rules.length) {
+    if (parsed.rules.length > 0) {
       const rules = reportUnusedDisableDirectives
         ? reportUnusedRules(context, comment, parsed.type, parsed.rules)
         : parsed.rules
@@ -285,7 +285,7 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'support comment-directives in `<template>`',
+      description: 'require support comment-directives in `<template>`',
       categories: ['base'],
       url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/comment-directive.html'
     },
@@ -322,11 +322,12 @@ module.exports = {
    */
   create(context) {
     const options = context.options[0] || {}
+    const sourceCode = context.getSourceCode()
     /** @type {boolean} */
     const reportUnusedDisableDirectives = options.reportUnusedDisableDirectives
     const documentFragment =
-      context.parserServices.getDocumentFragment &&
-      context.parserServices.getDocumentFragment()
+      sourceCode.parserServices.getDocumentFragment &&
+      sourceCode.parserServices.getDocumentFragment()
 
     return {
       Program(node) {

package/lib/rules/component-tags-order.js

@@ -58,7 +58,7 @@ module.exports = {
     /** @type {(string|string[])[]} */
     const orderOptions =
       (context.options[0] && context.options[0].order) || DEFAULT_ORDER
-    orderOptions.forEach((nameOrNames, index) => {
+    for (const [index, nameOrNames] of orderOptions.entries()) {
       if (Array.isArray(nameOrNames)) {
         for (const name of nameOrNames) {
           orderMap.set(name, index)
@@ -66,7 +66,7 @@ module.exports = {
       } else {
         orderMap.set(nameOrNames, index)
       }
-    })
+    }
 
     /**
      * @param {string} name
@@ -75,9 +75,10 @@ module.exports = {
       const num = orderMap.get(name)
       return num == null ? -1 : num
     }
+    const sourceCode = context.getSourceCode()
     const documentFragment =
-      context.parserServices.getDocumentFragment &&
-      context.parserServices.getDocumentFragment()
+      sourceCode.parserServices.getDocumentFragment &&
+      sourceCode.parserServices.getDocumentFragment()
 
     function getTopLevelHTMLElements() {
       if (documentFragment) {
@@ -110,10 +111,10 @@ module.exports = {
         }
         const elements = getTopLevelHTMLElements()
 
-        elements.forEach((element, index) => {
+        for (const [index, element] of elements.entries()) {
           const expectedIndex = getOrderPosition(element.name)
           if (expectedIndex < 0) {
-            return
+            continue
           }
           const firstUnordered = elements
             .slice(0, index)
@@ -124,7 +125,7 @@ module.exports = {
           if (firstUnordered) {
             report(element, firstUnordered)
           }
-        })
+        }
       }
     }
   }

package/lib/rules/eqeqeq.js

@@ -1,3 +1,4 @@
+/* eslint-disable internal/no-invalid-meta-docs-categories */
 /**
  * @author Toru Nagashima
  */
@@ -5,7 +6,7 @@
 
 const { wrapCoreRule } = require('../utils')
 
-// eslint-disable-next-line
+// eslint-disable-next-line internal/no-invalid-meta
 module.exports = wrapCoreRule('eqeqeq', {
   applyDocument: true
 })

package/lib/rules/html-end-tags.js

@@ -24,7 +24,10 @@ module.exports = {
       url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/html-end-tags.html'
     },
     fixable: 'code',
-    schema: []
+    schema: [],
+    messages: {
+      endTag: "'<{{name}}>' should have end tag."
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -48,7 +51,7 @@ module.exports = {
             context.report({
               node: node.startTag,
               loc: node.startTag.loc,
-              message: "'<{{name}}>' should have end tag.",
+              messageId: 'endTag',
               data: { name },
               fix: (fixer) => fixer.insertTextAfter(node, `</${name}>`)
             })

package/lib/rules/no-arrow-functions-in-watch.js

@@ -14,7 +14,10 @@ module.exports = {
       url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/no-arrow-functions-in-watch.html'
     },
     fixable: null,
-    schema: []
+    schema: [],
+    messages: {
+      watcher: 'You should not use an arrow function to define a watcher.'
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -34,7 +37,7 @@ module.exports = {
         ) {
           context.report({
             node: property,
-            message: 'You should not use an arrow function to define a watcher.'
+            messageId: 'watcher'
           })
         }
       }

package/lib/rules/no-async-in-computed-properties.js

@@ -11,16 +11,16 @@ const utils = require('../utils')
  * @typedef {import('../utils').ComponentComputedProperty} ComponentComputedProperty
  */
 
-const PROMISE_FUNCTIONS = ['then', 'catch', 'finally']
+const PROMISE_FUNCTIONS = new Set(['then', 'catch', 'finally'])
 
-const PROMISE_METHODS = ['all', 'race', 'reject', 'resolve']
+const PROMISE_METHODS = new Set(['all', 'race', 'reject', 'resolve'])
 
-const TIMED_FUNCTIONS = [
+const TIMED_FUNCTIONS = new Set([
   'setTimeout',
   'setInterval',
   'setImmediate',
   'requestAnimationFrame'
-]
+])
 
 /**
  * @param {CallExpression} node
@@ -30,14 +30,14 @@ function isTimedFunction(node) {
   return (
     ((node.type === 'CallExpression' &&
       callee.type === 'Identifier' &&
-      TIMED_FUNCTIONS.indexOf(callee.name) !== -1) ||
+      TIMED_FUNCTIONS.has(callee.name)) ||
       (node.type === 'CallExpression' &&
         callee.type === 'MemberExpression' &&
         callee.object.type === 'Identifier' &&
         callee.object.name === 'window' &&
         callee.property.type === 'Identifier' &&
-        TIMED_FUNCTIONS.indexOf(callee.property.name) !== -1)) &&
-    node.arguments.length
+        TIMED_FUNCTIONS.has(callee.property.name))) &&
+    node.arguments.length > 0
   )
 }
 
@@ -50,11 +50,11 @@ function isPromise(node) {
     return (
       // hello.PROMISE_FUNCTION()
       (callee.property.type === 'Identifier' &&
-        PROMISE_FUNCTIONS.indexOf(callee.property.name) !== -1) || // Promise.PROMISE_METHOD()
+        PROMISE_FUNCTIONS.has(callee.property.name)) || // Promise.PROMISE_METHOD()
       (callee.object.type === 'Identifier' &&
         callee.object.name === 'Promise' &&
         callee.property.type === 'Identifier' &&
-        PROMISE_METHODS.indexOf(callee.property.name) !== -1)
+        PROMISE_METHODS.has(callee.property.name))
     )
   }
   return false
@@ -73,7 +73,11 @@ module.exports = {
       url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/no-async-in-computed-properties.html'
     },
     fixable: null,
-    schema: []
+    schema: [],
+    messages: {
+      computed:
+        'Unexpected {{expressionName}} in "{{propertyName}}" computed property.'
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -121,7 +125,7 @@ module.exports = {
      * @param {ComponentComputedProperty[]} computedProperties
      */
     function verify(node, targetBody, type, computedProperties = []) {
-      computedProperties.forEach((cp) => {
+      for (const cp of computedProperties) {
         if (
           cp.value &&
           node.loc.start.line >= cp.value.loc.start.line &&
@@ -130,15 +134,14 @@ module.exports = {
         ) {
           context.report({
             node,
-            message:
-              'Unexpected {{expressionName}} in "{{propertyName}}" computed property.',
+            messageId: 'computed',
             data: {
               expressionName: expressionTypes[type],
               propertyName: cp.key || 'unknown'
             }
           })
         }
-      })
+      }
     }
     return utils.defineMpxVisitor(context, {
       onMpxObjectEnter(node) {

package/lib/rules/no-deprecated-lifecycle.js

@@ -10,11 +10,11 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'pageShow/pageHide废弃的生命周期',
+      description: 'disallow pageShow/pageHide废弃的生命周期',
       categories: ['composition-api-essential'],
       url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/no-deprecated-lifecycle.html'
     },
-    fixable: 'code',
+    fixable: null,
     schema: [],
     messages: {
       deprecatedPageShow:

package/lib/rules/no-deprecated-mpx-createfunction.js

@@ -9,12 +9,16 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'mpx.create*调用方式已经被废弃',
+      description: 'disallow mpx.create*调用方式已经被废弃',
       categories: ['composition-api-essential'],
-      url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/no-deprecated-mpx-createfunction'
+      url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/no-deprecated-mpx-createfunction.html'
     },
-    fixable: 'code',
-    schema: []
+    fixable: null,
+    schema: [],
+    messages: {
+      method:
+        'The Mpx object of default export is no longer attached to the {{name}} runtime method.'
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -35,8 +39,7 @@ module.exports = {
         ) {
           context.report({
             node,
-            message:
-              'The Mpx object of default export is no longer attached to the {{name}} runtime method.',
+            messageId: 'method',
             data: { name: node.expression.callee.property.name }
           })
         }

package/lib/rules/no-deprecated-watch-second-param.js

@@ -9,12 +9,16 @@ module.exports = {
   meta: {
     type: 'problem',
     docs: {
-      description: 'watch第二个参数统一为函数，不再提供对象',
+      description: 'require watch第二个参数统一为函数，不再提供对象',
       categories: ['composition-api-essential'],
-      url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/no-deprecated-watch-second-param'
+      url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/no-deprecated-watch-second-param.html'
     },
-    fixable: 'code',
-    schema: []
+    fixable: null,
+    schema: [],
+    messages: {
+      attribute:
+        'The watch API no longer accepts the second parameter as an object with the handler attribute.'
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
@@ -30,8 +34,7 @@ module.exports = {
         ) {
           context.report({
             node,
-            message:
-              'The watch API no longer accepts the second parameter as an object with the handler attribute.'
+            messageId: 'attribute'
           })
         }
       }

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

@@ -35,26 +35,32 @@ module.exports = {
         },
         additionalProperties: false
       }
-    ]
+    ],
+    messages: {
+      name: "Duplicated key '{{name}}'."
+    }
   },
   /** @param {RuleContext} context */
   create(context) {
     const options = context.options[0] || {}
-    const groups = new Set(GROUP_NAMES.concat(options.groups || []))
+    const groups = new Set([...GROUP_NAMES, ...(options.groups || [])])
 
     // ----------------------------------------------------------------------
     // Public
     // ----------------------------------------------------------------------
 
     return utils.executeOnMpx(context, (obj) => {
+      /**
+       * @type {string[]}
+       */
       const usedNames = []
       const properties = utils.iterateProperties(obj, groups)
 
       for (const o of properties) {
-        if (usedNames.indexOf(o.name) !== -1) {
+        if (usedNames.includes(o.name)) {
           context.report({
             node: o.node,
-            message: "Duplicated key '{{name}}'.",
+            messageId: 'name',
             data: {
               name: o.name
             }

package/lib/rules/no-dupe-wx-elif.js

@@ -95,9 +95,10 @@ module.exports = {
   },
   /** @param {RuleContext} context */
   create(context) {
+    const sourceCode = context.getSourceCode()
     const tokenStore =
-      context.parserServices.getTemplateBodyTokenStore &&
-      context.parserServices.getTemplateBodyTokenStore()
+      sourceCode.parserServices.getTemplateBodyTokenStore &&
+      sourceCode.parserServices.getTemplateBodyTokenStore()
     /**
      * Determines whether the two given nodes are considered to be equal. In particular, given that the nodes
      * represent expressions in a boolean context, `||` and `&&` can be considered as commutative operators.
@@ -139,17 +140,19 @@ module.exports = {
         operandsB.operands.some((operandB) => equal(operandA, operandB))
       )
     }
-    const sourceCode = context.getSourceCode()
     return utils.defineTemplateBodyVisitor(context, {
       "VAttribute[directive=true][key.name.name='elif']"(node) {
         const text = sourceCode.getText(node).slice(-3)
         if (
+          // @ts-ignore
           !node.value ||
+          // @ts-ignore
           !node.value.expression ||
           !['}}"', "}}'"].includes(text)
         ) {
           return
         }
+        // @ts-ignore
         const test = node.value.expression
         const conditionsToCheck =
           test.type === 'LogicalExpression' && test.operator === '&&'
@@ -158,6 +161,7 @@ module.exports = {
         const listToCheck = conditionsToCheck.map(buildOrOperands)
 
         /** @type {VElement | null} */
+        // @ts-ignore
         let current = node.parent.parent
         while (current && (current = utils.prevSibling(current))) {
           const vIf = utils.getDirective(current, 'if')
@@ -172,13 +176,12 @@ module.exports = {
 
             for (const condition of listToCheck) {
               const operands = (condition.operands = condition.operands.filter(
-                (orOperand) => {
-                  return !currentOrOperands.operands.some((currentOrOperand) =>
+                (orOperand) =>
+                  !currentOrOperands.operands.some((currentOrOperand) =>
                     isSubset(currentOrOperand, orOperand)
                   )
-                }
               ))
-              if (!operands.length) {
+              if (operands.length === 0) {
                 context.report({
                   node: condition.node,
                   messageId: 'unexpected'