/
no-mutating-props.js
169 lines (156 loc) · 4.84 KB
/
no-mutating-props.js
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/**
* @fileoverview disallow mutation component props
* @author 2018 Armano
*/
'use strict'
const utils = require('../utils')
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
module.exports = {
meta: {
docs: {
description: 'disallow mutation of component props',
category: undefined,
url: 'https://github.com/vuejs/eslint-plugin-vue/blob/v5.0.0-beta.3/docs/rules/no-mutating-props.md'
},
fixable: null, // or "code" or "whitespace"
schema: [
// fill in your schema
]
},
create (context) {
let mutatedNodes = []
let props = []
let scope = {
parent: null,
nodes: []
}
function checkForMutations () {
if (mutatedNodes.length > 0) {
for (const prop of props) {
for (const node of mutatedNodes) {
if (prop === node.name) {
context.report({
node: node.node,
message: 'Unexpected mutation of "{{key}}" prop.',
data: {
key: node.name
}
})
}
}
}
}
mutatedNodes = []
}
function isInScope (name) {
return scope.nodes.some(node => node.name === name)
}
function checkExpression (node, expression) {
if (expression[0] === 'this') {
mutatedNodes.push({ name: expression[1], node })
} else {
const name = expression[0]
if (!isInScope(name)) {
mutatedNodes.push({ name, node })
}
}
}
function checkTemplateProperty (node) {
if (node.type === 'MemberExpression') {
checkExpression(node, utils.parseMemberExpression(node))
} else if (node.type === 'Identifier') {
if (!isInScope(node.name)) {
mutatedNodes.push({
name: node.name,
node
})
}
}
}
return Object.assign({},
{
// this.xxx <=|+=|-=>
'AssignmentExpression' (node) {
if (node.left.type !== 'MemberExpression') return
const expression = utils.parseMemberExpression(node.left)
if (expression[0] === 'this') {
mutatedNodes.push({
name: expression[1],
node
})
}
},
// this.xxx <++|-->
'UpdateExpression > MemberExpression' (node) {
const expression = utils.parseMemberExpression(node)
if (expression[0] === 'this') {
mutatedNodes.push({
name: expression[1],
node
})
}
},
// this.xxx.func()
'CallExpression' (node) {
const expression = utils.parseMemberOrCallExpression(node)
const code = expression.join('.').replace(/\.\[/g, '[')
const MUTATION_REGEX = /(this.)((?!(concat|slice|map|filter)\().)[^\)]*((push|pop|shift|unshift|reverse|splice|sort|copyWithin|fill)\()/g
if (MUTATION_REGEX.test(code)) {
if (expression[0] === 'this') {
mutatedNodes.push({
name: expression[1],
node
})
}
}
}
},
utils.executeOnVue(context, (obj) => {
props = utils.getComponentProps(obj)
.filter(cp => cp.key)
.map(cp => utils.getStaticPropertyName(cp.key))
checkForMutations()
}),
utils.defineTemplateBodyVisitor(context, {
VElement (node) {
scope = {
parent: scope,
nodes: scope.nodes.slice() // make copy
}
if (node.variables) {
for (const variable of node.variables) {
scope.nodes.push(variable.id)
}
}
},
'VElement:exit' () {
scope = scope.parent
},
'VExpressionContainer AssignmentExpression' (node) {
checkTemplateProperty(node.left)
},
// this.xxx <++|-->
'VExpressionContainer UpdateExpression' (node) {
checkTemplateProperty(node.argument)
},
// this.xxx.func()
'VExpressionContainer CallExpression' (node) {
const expression = utils.parseMemberOrCallExpression(node)
const code = expression.join('.').replace(/\.\[/g, '[')
const MUTATION_REGEX = /(this.)?((?!(concat|slice|map|filter)\().)[^\)]*((push|pop|shift|unshift|reverse|splice|sort|copyWithin|fill)\()/g
if (MUTATION_REGEX.test(code)) {
checkExpression(node, expression)
}
},
"VAttribute[directive=true][key.name='model'] VExpressionContainer" (node) {
checkTemplateProperty(node.expression)
},
"VElement[name='template']:exit" () {
checkForMutations()
}
})
)
}
}