/** * @fileoverview Rule to disallow assignments to native objects or read-only global variables * @author Ilya Volodin * @deprecated in ESLint v3.3.0 */ "use strict"; //------------------------------------------------------------------------------ // Rule Definition //------------------------------------------------------------------------------ /** @type {import('../types').Rule.RuleModule} */ module.exports = { meta: { type: "suggestion", docs: { description: "Disallow assignments to native objects or read-only global variables", recommended: false, url: "https://eslint.org/docs/latest/rules/no-native-reassign", }, deprecated: { message: "Renamed rule.", url: "https://eslint.org/blog/2016/08/eslint-v3.3.0-released/#deprecated-rules", deprecatedSince: "3.3.0", availableUntil: null, replacedBy: [ { rule: { name: "no-global-assign", url: "https://eslint.org/docs/rules/no-global-assign", }, }, ], }, schema: [ { type: "object", properties: { exceptions: { type: "array", items: { type: "string" }, uniqueItems: true, }, }, additionalProperties: false, }, ], messages: { nativeReassign: "Read-only global '{{name}}' should not be modified.", }, }, create(context) { const config = context.options[0]; const exceptions = (config && config.exceptions) || []; const sourceCode = context.sourceCode; /** * Reports write references. * @param {Reference} reference A reference to check. * @param {int} index The index of the reference in the references. * @param {Reference[]} references The array that the reference belongs to. * @returns {void} */ function checkReference(reference, index, references) { const identifier = reference.identifier; if ( reference.init === false && reference.isWrite() && /* * Destructuring assignments can have multiple default value, * so possibly there are multiple writeable references for the same identifier. */ (index === 0 || references[index - 1].identifier !== identifier) ) { context.report({ node: identifier, messageId: "nativeReassign", data: identifier, }); } } /** * Reports write references if a given variable is read-only builtin. * @param {Variable} variable A variable to check. * @returns {void} */ function checkVariable(variable) { if ( variable.writeable === false && !exceptions.includes(variable.name) ) { variable.references.forEach(checkReference); } } return { Program(node) { const globalScope = sourceCode.getScope(node); globalScope.variables.forEach(checkVariable); }, }; }, };