2024-08-09 12:04:48 +00:00
|
|
|
/**
|
|
|
|
* @fileoverview Disallow shadowing of NaN, undefined, and Infinity (ES5 section 15.1.1)
|
|
|
|
* @author Michael Ficarra
|
|
|
|
*/
|
|
|
|
"use strict";
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Determines if a variable safely shadows undefined.
|
|
|
|
* This is the case when a variable named `undefined` is never assigned to a value (i.e. it always shares the same value
|
|
|
|
* as the global).
|
|
|
|
* @param {eslintScope.Variable} variable The variable to check
|
|
|
|
* @returns {boolean} true if this variable safely shadows `undefined`
|
|
|
|
*/
|
|
|
|
function safelyShadowsUndefined(variable) {
|
|
|
|
return variable.name === "undefined" &&
|
|
|
|
variable.references.every(ref => !ref.isWrite()) &&
|
|
|
|
variable.defs.every(def => def.node.type === "VariableDeclarator" && def.node.init === null);
|
|
|
|
}
|
|
|
|
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
// Rule Definition
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
|
2024-08-21 06:34:30 +00:00
|
|
|
/** @type {import('../shared/types').Rule} */
|
2024-08-09 12:04:48 +00:00
|
|
|
module.exports = {
|
|
|
|
meta: {
|
|
|
|
type: "suggestion",
|
|
|
|
|
|
|
|
docs: {
|
2024-08-21 06:34:30 +00:00
|
|
|
description: "Disallow identifiers from shadowing restricted names",
|
2024-08-09 12:04:48 +00:00
|
|
|
recommended: true,
|
2024-08-21 06:34:30 +00:00
|
|
|
url: "https://eslint.org/docs/latest/rules/no-shadow-restricted-names"
|
2024-08-09 12:04:48 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
schema: [],
|
|
|
|
|
|
|
|
messages: {
|
|
|
|
shadowingRestrictedName: "Shadowing of global property '{{name}}'."
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
|
|
|
create(context) {
|
|
|
|
|
|
|
|
|
|
|
|
const RESTRICTED = new Set(["undefined", "NaN", "Infinity", "arguments", "eval"]);
|
2024-08-21 06:34:30 +00:00
|
|
|
const sourceCode = context.sourceCode;
|
2024-08-09 12:04:48 +00:00
|
|
|
|
|
|
|
return {
|
|
|
|
"VariableDeclaration, :function, CatchClause"(node) {
|
2024-08-21 06:34:30 +00:00
|
|
|
for (const variable of sourceCode.getDeclaredVariables(node)) {
|
2024-08-09 12:04:48 +00:00
|
|
|
if (variable.defs.length > 0 && RESTRICTED.has(variable.name) && !safelyShadowsUndefined(variable)) {
|
|
|
|
context.report({
|
|
|
|
node: variable.defs[0].name,
|
|
|
|
messageId: "shadowingRestrictedName",
|
|
|
|
data: {
|
|
|
|
name: variable.name
|
|
|
|
}
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
}
|
|
|
|
};
|