From 6d36407515be8aa8a02f7fc28c6e46bf872060ee Mon Sep 17 00:00:00 2001
From: fisker Cheung <lionkay@gmail.com>
Date: Tue, 2 Jun 2020 01:00:32 +0800
Subject: [PATCH] `no-useless-undefined`: Ignore `undefined` use in compare
 functions (#758)

---
 rules/no-useless-undefined.js | 41 +++++++++++++++++++++++++++++++++++
 test/no-useless-undefined.js  | 23 +++++++++++++++++++-
 2 files changed, 63 insertions(+), 1 deletion(-)

diff --git a/rules/no-useless-undefined.js b/rules/no-useless-undefined.js
index d990bf6c57..c95a63f753 100644
--- a/rules/no-useless-undefined.js
+++ b/rules/no-useless-undefined.js
@@ -32,6 +32,43 @@ const assignmentPatternSelector = getSelector('AssignmentPattern', 'right');
 
 const isUndefined = node => node && node.type === 'Identifier' && node.name === 'undefined';
 
+const compareFunctionNames = new Set([
+	'is',
+	'equal',
+	'notEqual',
+	'strictEqual',
+	'notStrictEqual',
+	'propertyVal',
+	'notPropertyVal',
+	'not',
+	'include',
+	'property',
+	'toBe',
+	'toContain',
+	'toContainEqual',
+	'toEqual',
+	'same',
+	'notSame',
+	'strictSame',
+	'strictNotSame'
+]);
+const isCompareFunction = node => {
+	let name;
+
+	if (node.type === 'Identifier') {
+		name = node.name;
+	} else if (
+		node.type === 'MemberExpression' &&
+		node.computed === false &&
+		node.property &&
+		node.property.type === 'Identifier'
+	) {
+		name = node.property.name;
+	}
+
+	return compareFunctionNames.has(name);
+};
+
 const create = context => {
 	const listener = fix => node => {
 		context.report({
@@ -64,6 +101,10 @@ const create = context => {
 			(node, fixer) => fixer.removeRange([node.parent.left.range[1], node.range[1]])
 		),
 		CallExpression: node => {
+			if (isCompareFunction(node.callee)) {
+				return;
+			}
+
 			const argumentNodes = node.arguments;
 			const undefinedArguments = [];
 			for (let index = argumentNodes.length - 1; index >= 0; index--) {
diff --git a/test/no-useless-undefined.js b/test/no-useless-undefined.js
index 9f70ef3251..fec9b03e56 100644
--- a/test/no-useless-undefined.js
+++ b/test/no-useless-undefined.js
@@ -31,7 +31,28 @@ ruleTester.run('no-useless-undefined', rule, {
 		'function foo({bar} = {}) {}',
 		'function foo(bar) {}',
 		// I guess nobody use this, but `yield* undefined;` is valid code, and `yield*;` is not
-		'function* foo() {yield* undefined;}'
+		'function* foo() {yield* undefined;}',
+
+		// Ignored
+		'if (Object.is(foo, undefined)){}',
+		't.is(foo, undefined)',
+		'assert.equal(foo, undefined, message)',
+		'assert.notEqual(foo, undefined, message)',
+		'assert.strictEqual(foo, undefined, message)',
+		'assert.notStrictEqual(foo, undefined, message)',
+		'assert.propertyVal(foo, "bar", undefined, message)',
+		'assert.notPropertyVal(foo, "bar", undefined, message)',
+		'expect(foo).not(undefined)',
+		'expect(foo).to.have.property("bar", undefined)',
+		'expect(foo).to.have.property("bar", undefined)',
+		'expect(foo).toBe(undefined)',
+		'expect(foo).toContain(undefined)',
+		'expect(foo).toContainEqual(undefined)',
+		'expect(foo).toEqual(undefined)',
+		't.same(foo, undefined)',
+		't.notSame(foo, undefined)',
+		't.strictSame(foo, undefined)',
+		't.strictNotSame(foo, undefined)'
 	],
 	invalid: [
 		{