eslint-plugin-mpx 0.2.16 → 0.2.18

package/lib/configs/mpx-essential.js

@@ -23,6 +23,7 @@ module.exports = {
     'mpx/valid-wx-key': 'error',
     'mpx/valid-attribute-value': 'error',
     'mpx/valid-template-quote': 'error',
-    'mpx/valid-component-range': 'error'
+    'mpx/valid-component-range': 'error',
+    'mpx/valid-properties': 'error'
   }
 }

package/lib/index.js

@@ -35,7 +35,8 @@ module.exports = {
     'valid-initdata': require('./rules/valid-initdata'),
     'no-deprecated-lifecycle': require('./rules/no-deprecated-lifecycle'),
     'no-deprecated-mpx-createfunction': require('./rules/no-deprecated-mpx-createfunction'),
-    'no-deprecated-watch-second-param': require('./rules/no-deprecated-watch-second-param')
+    'no-deprecated-watch-second-param': require('./rules/no-deprecated-watch-second-param'),
+    'valid-properties': require('./rules/valid-properties')
   },
   configs: {
     base: require('./configs/base'),

package/lib/rules/valid-properties.js

@@ -0,0 +1,151 @@
+/**
+ * @author pagnkelly
+ * @copyright 2020 pagnkelly. All rights reserved.
+ * See LICENSE file in root directory for full license.
+ */
+'use strict'
+
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+
+const utils = require('../utils')
+
+/**
+ * @typedef {import("../utils").ComponentObjectProp} ComponentObjectProp
+ */
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+// 校验properties是否符合预期
+/** 默认允许的key */
+const DEFAULT_KEYS = ['type', 'value', 'optionalTypes', 'observer']
+/**
+ * check prop
+ * @param {Property} node
+ * @returns
+ */
+/**
+ *
+ * @param {Property} node
+ * @param {RuleContext} context
+ * @param {string[]} allowKeys
+ * @returns
+ */
+function validProp(node, context, allowKeys) {
+  if (!node) return
+  const sourceCode = context.getSourceCode()
+  const propName = sourceCode.getText(node.key)
+  if (!node.value) {
+    return context.report({
+      node,
+      message: "The value of '{{propName}}' cannot be empty.",
+      data: {
+        propName
+      }
+    })
+  }
+  if (node.value.type === 'ObjectExpression') {
+    if (!node.value.properties.length) {
+      return context.report({
+        node: node.value,
+        message: "The value of '{{propName}}' cannot be empty object.",
+        data: {
+          propName
+        }
+      })
+    }
+    let hasType = 0
+    node.value.properties.forEach((item) => {
+      if (item.type !== 'Property') return
+      const keyName = sourceCode.getText(item.key)
+      if (!allowKeys.includes(keyName)) {
+        context.report({
+          node: item,
+          message: "Property '{{propName}}' has invalid key '{{keyName}}'.",
+          data: {
+            propName,
+            keyName
+          }
+        })
+      } else if (keyName === 'type') {
+        hasType = 1
+      }
+    })
+    if (!hasType) {
+      context.report({
+        node: node.value,
+        message: "Property '{{propName}}' requires 'type' key.",
+        data: {
+          propName
+        }
+      })
+    }
+  } else if (node.value.type !== 'Identifier') {
+    return context.report({
+      node,
+      message: "Invalid value for '{{propName}}'.",
+      data: {
+        propName
+      }
+    })
+  }
+}
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'enforce that a return statement is present in computed property',
+      categories: ['mpx-essential'],
+      url: 'https://mpx-ecology.github.io/eslint-plugin-mpx/rules/valid-properties.html'
+    },
+    fixable: null, // or "code" or "whitespace"
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          allowKeys: {
+            type: 'array'
+          }
+        }
+      }
+    ]
+  },
+  /** @param {RuleContext} context */
+  create(context) {
+    const options = context.options[0] || {}
+    const allowKeys = options.allowKeys || DEFAULT_KEYS
+    const isScriptSetup = utils.isScriptSetup(context)
+
+    // ----------------------------------------------------------------------
+    // Public
+    // ----------------------------------------------------------------------
+
+    if (isScriptSetup) {
+      return utils.defineTemplateBodyVisitor(
+        context,
+        {},
+        {
+          /**
+           * @param {ObjectExpression} node
+           */
+          "CallExpression[callee.name='defineProps'] > ObjectExpression"(node) {
+            for (const prop of utils.getComponentPropsFromDefine(node)) {
+              prop.type === 'object' && validProp(prop.node, context, allowKeys)
+            }
+          }
+        }
+      )
+    } else {
+      return utils.defineMpxVisitor(context, {
+        onMpxObjectEnter(obj) {
+          for (const prop of utils.getComponentPropsFromOptions(obj)) {
+            prop.type === 'object' && validProp(prop.node, context, allowKeys)
+          }
+        }
+      })
+    }
+  }
+}

package/lib/rules/valid-setup-define-expose.js

@@ -137,7 +137,10 @@ module.exports = {
                 node.parent.key.name.name
               )
             ) {
-              if (node.parent.key.name.name === 'for-item') {
+              if (
+                node.parent.key.name.name === 'for-item' ||
+                node.parent.key.name.name === 'for-index'
+              ) {
                 exposeSet.add(ref.id.name)
               }
               continue

package/lib/utils/index.js

@@ -803,6 +803,8 @@ module.exports = {
    * @return {(ComponentArrayProp | ComponentObjectProp | ComponentUnknownProp)[]} Array of component props
    */
   getComponentPropsFromOptions,
+
+  getComponentPropsFromDefine,
   /**
    * Get all computed properties by looking at all component's properties
    * @param {ObjectExpression} componentObject Object with component definition

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "eslint-plugin-mpx",
-  "version": "0.2.16",
+  "version": "0.2.18",
   "description": "Official ESLint plugin for Mpx.js",
   "main": "lib/index.js",
   "scripts": {
     "start": "npm run test:base -- --watch --growl",
     "test": "mocha \"tests/lib/**/*.js\" --reporter dot",
-    "test:only": "mocha \"tests/lib/rules/valid-initdata.js\" --reporter dot",
+    "test:only": "mocha \"tests/lib/rules/valid-properties.js\" --reporter dot",
     "debug": "mocha --inspect \"tests/lib/**/*.js\" --reporter dot --timeout 60000",
     "cover": "npm run cover:test && npm run cover:report",
     "cover:test": "nyc npm run test -- --timeout 60000",