/
index.js
335 lines (288 loc) · 9.69 KB
/
index.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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
"use strict"
const path = require("path")
const extract = require("./extract")
const utils = require("./utils")
const splatSet = utils.splatSet
const getSettings = require("./settings").getSettings
const getFileMode = require("./getFileMode")
const PREPARE_RULE_NAME = "__eslint-plugin-html-prepare"
const LINTER_ISPATCHED_PROPERTY_NAME =
"__eslint-plugin-html-verify-function-is-patched"
// Disclaimer:
//
// This is not a long term viable solution. ESLint needs to improve its processor API to
// provide access to the configuration before actually preprocess files, but it's not
// planed yet. This solution is quite ugly but shouldn't alter eslint process.
//
// Related github issues:
// https://github.com/eslint/eslint/issues/3422
// https://github.com/eslint/eslint/issues/4153
const needles = [
path.join("lib", "linter", "linter.js"), // ESLint 6+
path.join("lib", "linter.js"), // ESLint 5-
]
iterateESLintModules(patch)
function getLinterFromModule(moduleExports) {
return moduleExports.Linter
? moduleExports.Linter // ESLint 6+
: moduleExports // ESLint 5-
}
function getModuleFromRequire() {
return getLinterFromModule(require("eslint/lib/linter"))
}
function getModuleFromCache(key) {
if (!needles.some((needle) => key.endsWith(needle))) return
const module = require.cache[key]
if (!module || !module.exports) return
const Linter = getLinterFromModule(module.exports)
if (
typeof Linter === "function" &&
typeof Linter.prototype.verify === "function"
) {
return Linter
}
}
function iterateESLintModules(fn) {
if (!require.cache || Object.keys(require.cache).length === 0) {
// Jest is replacing the node "require" function, and "require.cache" isn't available here.
fn(getModuleFromRequire())
return
}
let found = false
for (const key in require.cache) {
const Linter = getModuleFromCache(key)
if (Linter) {
fn(Linter)
found = true
}
}
if (!found) {
let eslintPath, eslintVersion
try {
eslintPath = require.resolve("eslint")
} catch (e) {
eslintPath = "(not found)"
}
try {
eslintVersion = require("eslint/package.json").version
} catch (e) {
eslintVersion = "n/a"
}
const parentPaths = (module) =>
module ? [module.filename].concat(parentPaths(module.parent)) : []
throw new Error(
`eslint-plugin-html error: It seems that eslint is not loaded.
If you think this is a bug, please file a report at https://github.com/BenoitZugmeyer/eslint-plugin-html/issues
In the report, please include *all* those informations:
* ESLint version: ${eslintVersion}
* ESLint path: ${eslintPath}
* Plugin version: ${require("../package.json").version}
* Plugin inclusion paths: ${parentPaths(module).join(", ")}
* NodeJS version: ${process.version}
* CLI arguments: ${JSON.stringify(process.argv)}
* Content of your lock file (package-lock.json or yarn.lock) or the output of \`npm list\`
* How did you run ESLint (via the command line? an editor plugin?)
* The following stack trace:
${new Error().stack.slice(10)}
`
)
}
}
function patch(Linter) {
const verifyMethodName = Linter.prototype._verifyWithoutProcessors
? "_verifyWithoutProcessors" // ESLint 6+
: "verify" // ESLint 5-
const verify = Linter.prototype[verifyMethodName]
// ignore if verify function is already been patched sometime before
if (Linter[LINTER_ISPATCHED_PROPERTY_NAME] === true) {
return
}
Linter[LINTER_ISPATCHED_PROPERTY_NAME] = true
Linter.prototype[verifyMethodName] = function (
textOrSourceCode,
config,
filenameOrOptions,
saveState
) {
if (typeof config.extractConfig === "function") {
return verify.call(this, textOrSourceCode, config, filenameOrOptions)
}
const pluginSettings = getSettings(config.settings || {})
const mode = getFileMode(pluginSettings, filenameOrOptions)
if (!mode || typeof textOrSourceCode !== "string") {
return verify.call(
this,
textOrSourceCode,
config,
filenameOrOptions,
saveState
)
}
const extractResult = extract(
textOrSourceCode,
pluginSettings.indent,
mode === "xml",
pluginSettings.isJavaScriptMIMEType
)
const messages = []
if (pluginSettings.reportBadIndent) {
messages.push(
...extractResult.badIndentationLines.map((line) => ({
message: "Bad line indentation.",
line,
column: 1,
ruleId: "(html plugin)",
severity: pluginSettings.reportBadIndent,
}))
)
}
// Save code parts parsed source code so we don't have to parse it twice
const sourceCodes = new WeakMap()
const verifyCodePart = (codePart, { prepare, ignoreRules } = {}) => {
this.defineRule(PREPARE_RULE_NAME, (context) => {
sourceCodes.set(codePart, context.getSourceCode())
return {
Program() {
if (prepare) {
prepare(context)
}
},
}
})
const localMessages = verify.call(
this,
sourceCodes.get(codePart) || String(codePart),
Object.assign({}, config, {
rules: Object.assign(
{ [PREPARE_RULE_NAME]: "error" },
!ignoreRules && config.rules
),
}),
ignoreRules && typeof filenameOrOptions === "object"
? Object.assign({}, filenameOrOptions, {
reportUnusedDisableDirectives: false,
})
: filenameOrOptions,
saveState
)
messages.push(
...remapMessages(localMessages, extractResult.hasBOM, codePart)
)
}
const parserOptions = config.parserOptions || {}
if (parserOptions.sourceType === "module") {
for (const codePart of extractResult.code) {
verifyCodePart(codePart)
}
} else {
verifyWithSharedScopes(extractResult.code, verifyCodePart, parserOptions)
}
messages.sort((ma, mb) => ma.line - mb.line || ma.column - mb.column)
return messages
}
}
function verifyWithSharedScopes(codeParts, verifyCodePart, parserOptions) {
// First pass: collect needed globals and declared globals for each script tags.
const firstPassValues = []
for (const codePart of codeParts) {
verifyCodePart(codePart, {
prepare(context) {
const globalScope = context.getScope()
// See https://github.com/eslint/eslint/blob/4b267a5c8a42477bb2384f33b20083ff17ad578c/lib/rules/no-redeclare.js#L67-L78
let scopeForDeclaredGlobals
if (
parserOptions.ecmaFeatures &&
parserOptions.ecmaFeatures.globalReturn
) {
scopeForDeclaredGlobals = globalScope.childScopes[0]
} else {
scopeForDeclaredGlobals = globalScope
}
firstPassValues.push({
codePart,
exportedGlobals: globalScope.through.map(
(node) => node.identifier.name
),
declaredGlobals: scopeForDeclaredGlobals.variables.map(
(variable) => variable.name
),
})
},
ignoreRules: true,
})
}
// Second pass: declare variables for each script scope, then run eslint.
for (let i = 0; i < firstPassValues.length; i += 1) {
verifyCodePart(firstPassValues[i].codePart, {
prepare(context) {
const exportedGlobals = splatSet(
firstPassValues
.slice(i + 1)
.map((nextValues) => nextValues.exportedGlobals)
)
for (const name of exportedGlobals) context.markVariableAsUsed(name)
const declaredGlobals = splatSet(
firstPassValues
.slice(0, i)
.map((previousValues) => previousValues.declaredGlobals)
)
const scope = context.getScope()
scope.through = scope.through.filter((variable) => {
return !declaredGlobals.has(variable.identifier.name)
})
},
})
}
}
function remapMessages(messages, hasBOM, codePart) {
const newMessages = []
for (const message of messages) {
if (remapMessage(message, hasBOM, codePart)) {
newMessages.push(message)
}
}
return newMessages
}
function remapMessage(message, hasBOM, codePart) {
if (!message.line || !message.column) {
// Some messages apply to the whole file instead of a particular code location. In particular:
// * @typescript-eslint/parser may send messages with no line/column
// * eslint-plugin-eslint-comments send messages with column=0 to bypass ESLint ignore comments.
// See https://github.com/BenoitZugmeyer/eslint-plugin-html/issues/70
// For now, just include them in the output. In the future, we should make sure those messages
// are not print twice.
return true
}
const location = codePart.originalLocation({
line: message.line,
column: message.column,
})
// Ignore messages if they were in transformed code
if (!location) {
return false
}
Object.assign(message, location)
message.source = codePart.getOriginalLine(location.line)
// Map fix range
if (message.fix && message.fix.range) {
const bomOffset = hasBOM ? -1 : 0
message.fix.range = [
codePart.originalIndex(message.fix.range[0]) + bomOffset,
// The range end is exclusive, meaning it should replace all characters with indexes from
// start to end - 1. We have to get the original index of the last targeted character.
codePart.originalIndex(message.fix.range[1] - 1) + 1 + bomOffset,
]
}
// Map end location
if (message.endLine && message.endColumn) {
const endLocation = codePart.originalLocation({
line: message.endLine,
column: message.endColumn,
})
if (endLocation) {
message.endLine = endLocation.line
message.endColumn = endLocation.column
}
}
return true
}