fune/tools/lint/eslint/eslint-plugin-mozilla/lib/rules/mark-exported-symbols-as-used.js
Victor Porof 5c7cdbd4ba Bug 1561435 - Format tools/, a=automatic-formatting
# ignore-this-changeset

Differential Revision: https://phabricator.services.mozilla.com/D35940

--HG--
extra : source : d214f0c82813e5a8d3987debc490a2c11f1308ff
2019-07-05 11:18:19 +02:00

83 lines
2.4 KiB
JavaScript

/**
* @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,
message: "Unexpected assignment of non-Array to EXPORTED_SYMBOLS",
});
return;
}
for (let element of expression.elements) {
context.markVariableAsUsed(element.value);
}
// Also mark EXPORTED_SYMBOLS as used.
context.markVariableAsUsed("EXPORTED_SYMBOLS");
}
// -----------------------------------------------------------------------------
// Rule Definition
// -----------------------------------------------------------------------------
module.exports = function(context) {
// 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() {
return !context.getScope().upper;
}
// ---------------------------------------------------------------------------
// Public
// ---------------------------------------------------------------------------
return {
AssignmentExpression(node, parents) {
if (
node.operator === "=" &&
node.left.type === "MemberExpression" &&
node.left.object.type === "ThisExpression" &&
node.left.property.name === "EXPORTED_SYMBOLS" &&
isGlobalScope()
) {
markArrayElementsAsUsed(context, node, node.right);
}
},
VariableDeclaration(node, parents) {
if (!isGlobalScope()) {
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,
message:
"EXPORTED_SYMBOLS cannot be declared via `let`. Use `var` or `this.EXPORTED_SYMBOLS =`",
});
}
markArrayElementsAsUsed(context, node, item.init);
}
}
},
};
};