2024-08-09 12:04:48 +00:00
|
|
|
/**
|
|
|
|
* @fileoverview Rule to flag when initializing to undefined
|
|
|
|
* @author Ilya Volodin
|
|
|
|
*/
|
|
|
|
|
|
|
|
"use strict";
|
|
|
|
|
|
|
|
const astUtils = require("./utils/ast-utils");
|
|
|
|
|
|
|
|
//------------------------------------------------------------------------------
|
|
|
|
// 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 initializing variables to `undefined`",
|
2024-08-09 12:04:48 +00:00
|
|
|
recommended: false,
|
2024-08-21 06:34:30 +00:00
|
|
|
url: "https://eslint.org/docs/latest/rules/no-undef-init"
|
2024-08-09 12:04:48 +00:00
|
|
|
},
|
|
|
|
|
|
|
|
schema: [],
|
|
|
|
fixable: "code",
|
|
|
|
|
|
|
|
messages: {
|
|
|
|
unnecessaryUndefinedInit: "It's not necessary to initialize '{{name}}' to undefined."
|
|
|
|
}
|
|
|
|
},
|
|
|
|
|
|
|
|
create(context) {
|
|
|
|
|
2024-08-21 06:34:30 +00:00
|
|
|
const sourceCode = context.sourceCode;
|
2024-08-09 12:04:48 +00:00
|
|
|
|
|
|
|
return {
|
|
|
|
|
|
|
|
VariableDeclarator(node) {
|
|
|
|
const name = sourceCode.getText(node.id),
|
|
|
|
init = node.init && node.init.name,
|
2024-08-21 06:34:30 +00:00
|
|
|
scope = sourceCode.getScope(node),
|
2024-08-09 12:04:48 +00:00
|
|
|
undefinedVar = astUtils.getVariableByName(scope, "undefined"),
|
|
|
|
shadowed = undefinedVar && undefinedVar.defs.length > 0,
|
|
|
|
lastToken = sourceCode.getLastToken(node);
|
|
|
|
|
|
|
|
if (init === "undefined" && node.parent.kind !== "const" && !shadowed) {
|
|
|
|
context.report({
|
|
|
|
node,
|
|
|
|
messageId: "unnecessaryUndefinedInit",
|
|
|
|
data: { name },
|
|
|
|
fix(fixer) {
|
|
|
|
if (node.parent.kind === "var") {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (node.id.type === "ArrayPattern" || node.id.type === "ObjectPattern") {
|
|
|
|
|
|
|
|
// Don't fix destructuring assignment to `undefined`.
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (sourceCode.commentsExistBetween(node.id, lastToken)) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
return fixer.removeRange([node.id.range[1], node.range[1]]);
|
|
|
|
}
|
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
}
|
|
|
|
};
|