rewrite force-types-on-object-props

vuejs · Feb 28, 2023 · 9161964 · 9161964
1 parent 75fc825
commit 9161964
Show file tree

Hide file tree

Showing 2 changed files with 379 additions and 158 deletions.
diff --git a/lib/rules/force-types-on-object-props.js b/lib/rules/force-types-on-object-props.js
@@ -4,6 +4,11 @@
  */
 'use strict'
 
+const utils = require('../utils')
+/**
+ * @typedef {import('../utils').ComponentProp} ComponentProp
+ */
+
 // ------------------------------------------------------------------------------
 // Helpers
 // ------------------------------------------------------------------------------
@@ -29,6 +34,97 @@ const isLooksLike = (a, b) =>
       : isLooksLike(aVal, bVal)
   })
 
+/**
+ * @param {ComponentProp} property
+ * @param {RuleContext} context
+ */
+const checkProperty = (property, context) => {
+  if (!property.value) {
+    return
+  }
+
+  if (
+    isLooksLike(property.value, { type: 'Identifier', name: 'Object' }) &&
+    property.node.value.type !== 'TSAsExpression'
+  ) {
+    context.report({
+      node: property.node,
+      message: 'Expected type annotation on object prop.'
+    })
+  }
+
+  if (
+    property.type === 'object' &&
+    property.value.type === 'ObjectExpression' &&
+    property.node.value.type === 'ObjectExpression'
+  ) {
+    const typePropert = property.node.value.properties.find(
+      (prop) =>
+        prop.type === 'Property' &&
+        prop.key.type === 'Identifier' &&
+        prop.key.name === 'type'
+    )
+    if (
+      typePropert &&
+      typePropert.type === 'Property' &&
+      isLooksLike(typePropert.value, { type: 'Identifier', name: 'Object' })
+    ) {
+      context.report({
+        node: property.node,
+        message: 'Expected type annotation on object prop.'
+      })
+    }
+  }
+
+  if (property.node.value.type === 'ObjectExpression') {
+    for (const prop of property.node.value.properties) {
+      if (prop.type !== 'Property') {
+        continue
+      }
+      if (prop.key.type !== 'Identifier' || prop.key.name !== 'type') {
+        continue
+      }
+      if (prop.value.type !== 'TSAsExpression') {
+        continue
+      }
+
+      const { typeAnnotation } = prop.value
+      if (
+        ['TSAnyKeyword', 'TSUnknownKeyword'].includes(typeAnnotation.type) ||
+        !typeAnnotation.typeName ||
+        !['Prop', 'PropType'].includes(typeAnnotation.typeName.name)
+      ) {
+        context.report({
+          node: property.node,
+          message: 'Expected type annotation on object prop.'
+        })
+      }
+    }
+  }
+
+  if (property.node.value.type === 'TSAsExpression') {
+    const { typeAnnotation } = property.node.value
+    if (typeAnnotation.type === 'TSFunctionType') {
+      return
+    }
+    if (
+      [
+        'TSAnyKeyword',
+        'TSTypeLiteral',
+        'TSUnknownKeyword',
+        'TSObjectKeyword'
+      ].includes(typeAnnotation.type) ||
+      !typeAnnotation.typeName ||
+      !['Prop', 'PropType'].includes(typeAnnotation.typeName.name)
+    ) {
+      context.report({
+        node: property.node,
+        message: 'Expected type annotation on object prop.'
+      })
+    }
+  }
+}
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -47,73 +143,21 @@ module.exports = {
   },
   /** @param {RuleContext} context */
   create(context) {
-    return {
-      /** @param {ExportDefaultDeclaration} node */
-      ExportDefaultDeclaration(node) {
-        if (node.declaration.type !== 'ObjectExpression') {
-          return
-        }
-        if (!Array.isArray(node.declaration.properties)) {
-          return
+    return utils.compositingVisitors(
+      utils.defineScriptSetupVisitor(context, {
+        onDefinePropsEnter(_node, props) {
+          for (const prop of props) {
+            checkProperty(prop, context)
+          }
         }
+      }),
+      utils.executeOnVue(context, (obj) => {
+        const props = utils.getComponentPropsFromOptions(obj)
 
-        const property = node.declaration.properties.find(
-          (property) =>
-            property.type === 'Property' &&
-            isLooksLike(property.key, { type: 'Identifier', name: 'props' }) &&
-            property.value.type === 'ObjectExpression'
-        )
-
-        if (
-          !property ||
-          property.type === 'SpreadElement' ||
-          !('properties' in property.value)
-        ) {
-          return
-        }
-        const properties = property.value.properties
-          .filter(
-            (prop) =>
-              prop.type === 'Property' && prop.value.type === 'ObjectExpression'
-          )
-          .map((prop) =>
-            prop.value.properties.find((propValueProperty) =>
-              isLooksLike(propValueProperty.key, {
-                type: 'Identifier',
-                name: 'type'
-              })
-            )
-          )
-        for (const prop of properties) {
-          if (!prop) {
-            continue
-          }
-          if (isLooksLike(prop.value, { type: 'Identifier', name: 'Object' })) {
-            context.report({
-              node: prop,
-              message: 'Expected type annotation on object prop.'
-            })
-          }
-          if (prop.value.type === 'TSAsExpression') {
-            const { typeAnnotation } = prop.value
-            if (
-              [
-                'TSAnyKeyword',
-                'TSTypeLiteral',
-                'TSUnknownKeyword',
-                'TSObjectKeyword'
-              ].includes(typeAnnotation.type) ||
-              !typeAnnotation.typeName ||
-              !['Prop', 'PropType'].includes(typeAnnotation.typeName.name)
-            ) {
-              context.report({
-                node: prop,
-                message: 'Expected type annotation on object prop.'
-              })
-            }
-          }
+        for (const prop of props) {
+          checkProperty(prop, context)
         }
-      }
-    }
+      })
+    )
   }
 }