Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix: no-undef-init should not apply to class fields (refs #14857) #14994

Merged
merged 2 commits into from Sep 2, 2021
Merged

Fix: no-undef-init should not apply to class fields (refs #14857) #14994

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
742ac06
Fix: no-undef-init should not apply to class fields (refs #14857)
mdjermanovic Aug 30, 2021
6f1c430
update docs
mdjermanovic Aug 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
72 changes: 9 additions & 63 deletions lib/rules/no-undef-init.js
View file
Open in desktop
Expand Up @@ -33,91 +33,37 @@ module.exports = {

const sourceCode = context.getSourceCode();

/**
* Get the node of init target.
* @param {ASTNode} node The node to get.
* @throws {Error} (Unreachable.)
* @returns {ASTNode} The node of init target.
*/
function getIdNode(node) {
switch (node.type) {
case "VariableDeclarator":
return node.id;
case "PropertyDefinition":
return node.key;
default:
throw new Error("unreachable");
}
}

/**
* Get the node of init value.
* @param {ASTNode} node The node to get.
* @throws {Error} (Unreachable.)
* @returns {ASTNode} The node of init value.
*/
function getInitNode(node) {
switch (node.type) {
case "VariableDeclarator":
return node.init;
case "PropertyDefinition":
return node.value;
default:
throw new Error("unreachable");
}
}

/**
* Get the parent kind of the node.
* @param {ASTNode} node The node to get.
* @throws {Error} (Unreachable.)
* @returns {string} The parent kind.
*/
function getParentKind(node) {
switch (node.type) {
case "VariableDeclarator":
return node.parent.kind;
case "PropertyDefinition":
return "field";
default:
throw new Error("unreachable");
}
}

return {

"VariableDeclarator, PropertyDefinition"(node) {
const idNode = getIdNode(node),
name = sourceCode.getText(idNode),
initNode = getInitNode(node),
initIsUndefined = initNode && initNode.type === "Identifier" && initNode.name === "undefined",
parentKind = getParentKind(node),
VariableDeclarator(node) {
const name = sourceCode.getText(node.id),
init = node.init && node.init.name,
scope = context.getScope(),
undefinedVar = astUtils.getVariableByName(scope, "undefined"),
shadowed = undefinedVar && undefinedVar.defs.length > 0,
lastToken = sourceCode.getLastToken(node, astUtils.isNotSemicolonToken);
lastToken = sourceCode.getLastToken(node);

if (initIsUndefined && parentKind !== "const" && !shadowed) {
if (init === "undefined" && node.parent.kind !== "const" && !shadowed) {
context.report({
node,
messageId: "unnecessaryUndefinedInit",
data: { name },
fix(fixer) {
if (parentKind === "var") {
if (node.parent.kind === "var") {
return null;
}

if (idNode.type === "ArrayPattern" || idNode.type === "ObjectPattern") {
if (node.id.type === "ArrayPattern" || node.id.type === "ObjectPattern") {

// Don't fix destructuring assignment to `undefined`.
return null;
}

if (sourceCode.commentsExistBetween(idNode, lastToken)) {
if (sourceCode.commentsExistBetween(node.id, lastToken)) {
return null;
}

return fixer.removeRange([idNode.range[1], lastToken.range[1]]);
return fixer.removeRange([node.id.range[1], node.range[1]]);
}
});
}
Expand Down
32 changes: 5 additions & 27 deletions tests/lib/rules/no-undef-init.js
View file
Open in desktop
Expand Up @@ -22,7 +22,11 @@ ruleTester.run("no-undef-init", rule, {
valid: [
"var a;",
{ code: "const foo = undefined", parserOptions: { ecmaVersion: 6 } },
"var undefined = 5; var foo = undefined;"
"var undefined = 5; var foo = undefined;",

// doesn't apply to class fields
{ code: "class C { field = undefined; }", parserOptions: { ecmaVersion: 2022 } }

],
invalid: [
{
Expand Down Expand Up @@ -148,32 +152,6 @@ ruleTester.run("no-undef-init", rule, {
output: "let a//comment\n, b;",
parserOptions: { ecmaVersion: 6 },
errors: [{ messageId: "unnecessaryUndefinedInit", data: { name: "a" }, type: "VariableDeclarator" }]
},

// Class fields
{
code: "class C { field = undefined; }",
output: "class C { field; }",
parserOptions: { ecmaVersion: 2022 },
errors: [{ messageId: "unnecessaryUndefinedInit", data: { name: "field" }, type: "PropertyDefinition" }]
},
{
code: "class C { field = undefined }",
output: "class C { field }",
parserOptions: { ecmaVersion: 2022 },
errors: [{ messageId: "unnecessaryUndefinedInit", data: { name: "field" }, type: "PropertyDefinition" }]
},
{
code: "class C { #field = undefined; }",
output: "class C { #field; }",
parserOptions: { ecmaVersion: 2022 },
errors: [{ messageId: "unnecessaryUndefinedInit", data: { name: "#field" }, type: "PropertyDefinition" }]
},
{
code: "class C { '#field' = undefined; }",
output: "class C { '#field'; }",
parserOptions: { ecmaVersion: 2022 },
errors: [{ messageId: "unnecessaryUndefinedInit", data: { name: "'#field'" }, type: "PropertyDefinition" }]
}
]
});