/
no-useless-v-bind.js
153 lines (142 loc) · 4.1 KB
/
no-useless-v-bind.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
/**
* @author Yosuke Ota
* See LICENSE file in root directory for full license.
*/
'use strict'
const utils = require('../utils')
const DOUBLE_QUOTES_RE = /"/gu
const SINGLE_QUOTES_RE = /'/gu
/**
* @typedef {import('eslint').Rule.RuleContext} RuleContext
* @typedef {import('vue-eslint-parser').AST.VDirective} VDirective
*/
module.exports = {
meta: {
docs: {
description: 'disallow unnecessary `v-bind` directives',
categories: undefined,
url: 'https://eslint.vuejs.org/rules/no-useless-v-bind.html'
},
fixable: 'code',
messages: {
unexpected: 'Unexpected `v-bind` with a string literal value.'
},
schema: [
{
type: 'object',
properties: {
ignoreIncludesComment: {
type: 'boolean'
},
ignoreStringEscape: {
type: 'boolean'
}
}
}
],
type: 'suggestion'
},
/** @param {RuleContext} context */
create(context) {
const opts = context.options[0] || {}
const ignoreIncludesComment = opts.ignoreIncludesComment
const ignoreStringEscape = opts.ignoreStringEscape
const sourceCode = context.getSourceCode()
/**
* Report if the value expression is string literals
* @param {VDirective} node the node to check
*/
function verify(node) {
if (!node.value || node.key.modifiers.length) {
return
}
const { expression } = node.value
if (!expression) {
return
}
let strValue, rawValue
if (expression.type === 'Literal') {
if (typeof expression.value !== 'string') {
return
}
strValue = expression.value
rawValue = expression.raw.slice(1, -1)
} else if (expression.type === 'TemplateLiteral') {
if (expression.expressions.length > 0) {
return
}
strValue = expression.quasis[0].value.cooked
rawValue = expression.quasis[0].value.raw
} else {
return
}
const tokenStore = context.parserServices.getTemplateBodyTokenStore()
const hasComment = tokenStore
.getTokens(node.value, { includeComments: true })
.some((t) => t.type === 'Block' || t.type === 'Line')
if (ignoreIncludesComment && hasComment) {
return
}
let hasEscape = false
if (rawValue !== strValue) {
// check escapes
const chars = [...rawValue]
let c = chars.shift()
while (c) {
if (c === '\\') {
c = chars.shift()
if (
c == null ||
// ignore "\\", '"', "'", "`" and "$"
'nrvtbfux'.includes(c)
) {
// has useful escape.
hasEscape = true
break
}
}
c = chars.shift()
}
}
if (ignoreStringEscape && hasEscape) {
return
}
context.report({
// @ts-ignore
node,
messageId: 'unexpected',
fix(fixer) {
if (hasComment || hasEscape) {
// cannot fix
return null
}
const text = sourceCode.getText(node.value)
const quoteChar = text[0]
const shorthand = node.key.name.rawName === ':'
/** @type { [number, number] } */
const keyDirectiveRange = [
node.key.name.range[0],
node.key.name.range[1] + (shorthand ? 0 : 1)
]
let attrValue
if (quoteChar === '"') {
attrValue = strValue.replace(DOUBLE_QUOTES_RE, '"')
} else if (quoteChar === "'") {
attrValue = strValue.replace(SINGLE_QUOTES_RE, ''')
} else {
attrValue = strValue
.replace(DOUBLE_QUOTES_RE, '"')
.replace(SINGLE_QUOTES_RE, ''')
}
return [
fixer.removeRange(keyDirectiveRange),
fixer.replaceText(expression, attrValue)
]
}
})
}
return utils.defineTemplateBodyVisitor(context, {
"VAttribute[directive=true][key.name.name='bind'][key.argument!=null]": verify
})
}
}