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
|
/**
* @fileoverview Simply marks exported symbols as used. Designed for use in
* .jsm files only.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
"use strict";
function markArrayElementsAsUsed(context, node, expression) {
if (expression.type != "ArrayExpression") {
context.report({
node,
messageId: "nonArrayAssignedToImported",
});
return;
}
for (let element of expression.elements) {
context.markVariableAsUsed(element.value);
}
// Also mark EXPORTED_SYMBOLS as used.
context.markVariableAsUsed("EXPORTED_SYMBOLS");
}
// Ignore assignments not in the global scope, e.g. where special module
// definitions are required due to having different ways of importing files,
// e.g. osfile.
function isGlobalScope(context) {
return !context.getScope().upper;
}
module.exports = {
meta: {
docs: {
url: "https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint-plugin-mozilla/mark-exported-symbols-as-used.html",
},
messages: {
useLetForExported:
"EXPORTED_SYMBOLS cannot be declared via `let`. Use `var` or `this.EXPORTED_SYMBOLS =`",
nonArrayAssignedToImported:
"Unexpected assignment of non-Array to EXPORTED_SYMBOLS",
},
schema: [],
type: "problem",
},
create(context) {
return {
AssignmentExpression(node, parents) {
if (
node.operator === "=" &&
node.left.type === "MemberExpression" &&
node.left.object.type === "ThisExpression" &&
node.left.property.name === "EXPORTED_SYMBOLS" &&
isGlobalScope(context)
) {
markArrayElementsAsUsed(context, node, node.right);
}
},
VariableDeclaration(node, parents) {
if (!isGlobalScope(context)) {
return;
}
for (let item of node.declarations) {
if (
item.id &&
item.id.type == "Identifier" &&
item.id.name === "EXPORTED_SYMBOLS"
) {
if (node.kind === "let") {
// The use of 'let' isn't allowed as the lexical scope may die after
// the script executes.
context.report({
node,
messageId: "useLetForExported",
});
}
markArrayElementsAsUsed(context, node, item.init);
}
}
},
};
},
};
|
