no-useless-undefined: Handle parenthesized undefined (#1178)

Author: fisker

rules/no-useless-undefined.js

@@ -1,6 +1,7 @@
 'use strict';
 const {isCommaToken} = require('eslint-utils');
 const getDocumentationUrl = require('./utils/get-documentation-url');
+const replaceNodeOrTokenAndSpacesBefore = require('./utils/replace-node-or-token-and-spaces-before');
 
 const messageId = 'no-useless-undefined';
 const messages = {
@@ -97,19 +98,14 @@ const create = context => {
 		});
 	};
 
-	const code = context.getSourceCode().text;
+	const sourceCode = context.getSourceCode();
 	const options = {
 		checkArguments: true,
 		...context.options[0]
 	};
 
-	const removeNodeAndLeadingSpace = (node, fixer) => {
-		const textBefore = code.slice(0, node.range[0]);
-		return fixer.removeRange([
-			node.range[0] - (textBefore.length - textBefore.trim().length),
-			node.range[1]
-		]);
-	};
+	const removeNodeAndLeadingSpace = (node, fixer) =>
+		replaceNodeOrTokenAndSpacesBefore(node, '', fixer, sourceCode);
 
 	const listeners = {
 		[returnSelector]: listener(
@@ -118,7 +114,7 @@ const create = context => {
 		),
 		[yieldSelector]: listener(removeNodeAndLeadingSpace),
 		[arrowFunctionSelector]: listener(
-			(node, fixer) => fixer.replaceText(node, '{}'),
+			(node, fixer) => replaceNodeOrTokenAndSpacesBefore(node, ' {}', fixer, sourceCode),
 			/* CheckFunctionReturnType */ true
 		),
 		[variableInitSelector]: listener(

test/no-useless-undefined.mjs

@@ -367,6 +367,43 @@ test.snapshot({
 		`,
 		'function foo([bar = undefined] = []) {}',
 		'foo(bar, undefined, undefined);',
-		'let a = undefined, b = 2;'
+		'let a = undefined, b = 2;',
+		outdent`
+			function foo() {
+				return /* */ (
+					/* */
+					(
+						/* */
+						undefined
+						/* */
+					)
+					/* */
+				) /* */ ;
+			}
+		`,
+		outdent`
+			function * foo() {
+				yield /* */ (
+					/* */
+					(
+						/* */
+						undefined
+						/* */
+					)
+					/* */
+				) /* */ ;
+			}
+		`,
+		outdent`
+			const foo = () => /* */ (
+				/* */
+				(
+					/* */
+					undefined
+					/* */
+				)
+				/* */
+			);
+		`
 	]
 });

test/snapshots/no-useless-undefined.mjs.md

@@ -87,3 +87,135 @@ Generated by [AVA](https://avajs.dev).
     > 1 | let a = undefined, b = 2;␊
         |         ^^^^^^^^^ Do not use useless \`undefined\`.␊
     `
+
+## Invalid #5
+       1 | function foo() {
+       2 | 	return /* */ (
+       3 | 		/* */
+       4 | 		(
+       5 | 			/* */
+       6 | 			undefined
+       7 | 			/* */
+       8 | 		)
+       9 | 		/* */
+      10 | 	) /* */ ;
+      11 | }
+
+> Output
+
+    `␊
+       1 | function foo() {␊
+       2 | 	return /* */␊
+       3 | 		/* */␊
+       4 |␊
+       5 | 			/* */␊
+       6 |␊
+       7 | 			/* */␊
+       8 |␊
+       9 | 		/* */␊
+      10 |  /* */ ;␊
+      11 | }␊
+    `
+
+> Error 1/1
+
+    `␊
+       1 | function foo() {␊
+       2 | 	return /* */ (␊
+       3 | 		/* */␊
+       4 | 		(␊
+       5 | 			/* */␊
+    >  6 | 			undefined␊
+         | 			^^^^^^^^^ Do not use useless \`undefined\`.␊
+       7 | 			/* */␊
+       8 | 		)␊
+       9 | 		/* */␊
+      10 | 	) /* */ ;␊
+      11 | }␊
+    `
+
+## Invalid #6
+       1 | function * foo() {
+       2 | 	yield /* */ (
+       3 | 		/* */
+       4 | 		(
+       5 | 			/* */
+       6 | 			undefined
+       7 | 			/* */
+       8 | 		)
+       9 | 		/* */
+      10 | 	) /* */ ;
+      11 | }
+
+> Output
+
+    `␊
+       1 | function * foo() {␊
+       2 | 	yield /* */␊
+       3 | 		/* */␊
+       4 |␊
+       5 | 			/* */␊
+       6 |␊
+       7 | 			/* */␊
+       8 |␊
+       9 | 		/* */␊
+      10 |  /* */ ;␊
+      11 | }␊
+    `
+
+> Error 1/1
+
+    `␊
+       1 | function * foo() {␊
+       2 | 	yield /* */ (␊
+       3 | 		/* */␊
+       4 | 		(␊
+       5 | 			/* */␊
+    >  6 | 			undefined␊
+         | 			^^^^^^^^^ Do not use useless \`undefined\`.␊
+       7 | 			/* */␊
+       8 | 		)␊
+       9 | 		/* */␊
+      10 | 	) /* */ ;␊
+      11 | }␊
+    `
+
+## Invalid #7
+      1 | const foo = () => /* */ (
+      2 | 	/* */
+      3 | 	(
+      4 | 		/* */
+      5 | 		undefined
+      6 | 		/* */
+      7 | 	)
+      8 | 	/* */
+      9 | );
+
+> Output
+
+    `␊
+      1 | const foo = () => /* */␊
+      2 | 	/* */␊
+      3 |␊
+      4 | 		/* */␊
+      5 |  {}␊
+      6 | 		/* */␊
+      7 |␊
+      8 | 	/* */␊
+      9 | ;␊
+    `
+
+> Error 1/1
+
+    `␊
+      1 | const foo = () => /* */ (␊
+      2 | 	/* */␊
+      3 | 	(␊
+      4 | 		/* */␊
+    > 5 | 		undefined␊
+        | 		^^^^^^^^^ Do not use useless \`undefined\`.␊
+      6 | 		/* */␊
+      7 | 	)␊
+      8 | 	/* */␊
+      9 | );␊
+    `