‘liusuyi’
2023-10-21 94023628bd9c5e6bf724c37371a19b60d338b291
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/**
 * @fileoverview Prop definitions should be detailed
 * @author Armano
 */
'use strict'
 
const utils = require('../utils')
 
/**
 * @typedef {import('../utils').ComponentArrayProp} ComponentArrayProp
 * @typedef {import('../utils').ComponentObjectProp} ComponentObjectProp
 */
 
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
 
module.exports = {
  meta: {
    type: 'suggestion',
    docs: {
      description: 'require type definitions in props',
      categories: ['vue3-strongly-recommended', 'strongly-recommended'],
      url: 'https://eslint.vuejs.org/rules/require-prop-types.html'
    },
    fixable: null, // or "code" or "whitespace"
    schema: [
      // fill in your schema
    ]
  },
  /** @param {RuleContext} context */
  create(context) {
    // ----------------------------------------------------------------------
    // Helpers
    // ----------------------------------------------------------------------
 
    /**
     * @param {ObjectExpression} node
     * @returns {boolean}
     */
    function objectHasType(node) {
      const typeProperty = node.properties.find(
        (p) =>
          p.type === 'Property' &&
          utils.getStaticPropertyName(p) === 'type' &&
          (p.value.type !== 'ArrayExpression' || p.value.elements.length > 0)
      )
      const validatorProperty = node.properties.find(
        (p) =>
          p.type === 'Property' &&
          utils.getStaticPropertyName(p) === 'validator'
      )
      return Boolean(typeProperty || validatorProperty)
    }
 
    /**
     * @param { ComponentArrayProp | ComponentObjectProp } prop
     */
    function checkProperty({ value, node, propName }) {
      let hasType = true
 
      if (!value) {
        hasType = false
      } else if (value.type === 'ObjectExpression') {
        // foo: {
        hasType = objectHasType(value)
      } else if (value.type === 'ArrayExpression') {
        // foo: [
        hasType = value.elements.length > 0
      } else if (
        value.type === 'FunctionExpression' ||
        value.type === 'ArrowFunctionExpression'
      ) {
        hasType = false
      }
      if (!hasType) {
        const name =
          propName ||
          (node.type === 'Identifier' && node.name) ||
          'Unknown prop'
        context.report({
          node,
          message: 'Prop "{{name}}" should define at least its type.',
          data: {
            name
          }
        })
      }
    }
 
    // ----------------------------------------------------------------------
    // Public
    // ----------------------------------------------------------------------
 
    return utils.executeOnVue(context, (obj) => {
      const props = utils.getComponentProps(obj)
 
      for (const prop of props) {
        checkProperty(prop)
      }
    })
  }
}