prefer-number-properties: Add checkNaN option (#2315)

Co-authored-by: fisker Cheung <[email protected]>
Co-authored-by: Richie Bendall <[email protected]>

Author: 3 people

docs/rules/prefer-number-properties.md

@@ -107,6 +107,16 @@ const foo = -Infinity;
 
 #### Pass
 
+```js
+// eslint unicorn/prefer-number-properties: ["error", {"checkInfinity": true}]
+const foo = Number.POSITIVE_INFINITY;
+```
+
+```js
+// eslint unicorn/prefer-number-properties: ["error", {"checkInfinity": true}]
+const foo = Number.NEGATIVE_INFINITY;
+```
+
 ```js
 // eslint unicorn/prefer-number-properties: ["error", {"checkInfinity": false}]
 const foo = Infinity;
@@ -126,3 +136,44 @@ const isPositiveZero = value => value === 0 && 1 / value === Number.POSITIVE_INF
 // eslint unicorn/prefer-number-properties: ["error", {"checkInfinity": true}]
 const isNegativeZero = value => value === 0 && 1 / value === Number.NEGATIVE_INFINITY;
 ```
+
+### checkNaN
+
+Type: `boolean`\
+Default: `true`
+
+Pass `checkNaN: false` to disable check on `NaN`.
+
+#### Fail
+
+```js
+// eslint unicorn/prefer-number-properties: ["error", {"checkNaN": true}]
+const foo = NaN;
+```
+
+```js
+// eslint unicorn/prefer-number-properties: ["error", {"checkNaN": true}]
+const foo = -NaN;
+```
+
+#### Pass
+
+```js
+// eslint unicorn/prefer-number-properties: ["error", {"checkNaN": true}]
+const foo = Number.NaN;
+```
+
+```js
+// eslint unicorn/prefer-number-properties: ["error", {"checkNaN": true}]
+const foo = -Number.NaN;
+```
+
+```js
+// eslint unicorn/prefer-number-properties: ["error", {"checkNaN": false}]
+const foo = NaN;
+```
+
+```js
+// eslint unicorn/prefer-number-properties: ["error", {"checkNaN": false}]
+const foo = -NaN;
+```

rules/prefer-number-properties.js

@@ -77,16 +77,25 @@ function checkProperty({node, path: [name]}, sourceCode) {
 const create = context => {
 	const {
 		checkInfinity,
+		checkNaN,
 	} = {
 		checkInfinity: false,
+		checkNaN: true,
 		...context.options[0],
 	};
 	const {sourceCode} = context;
 
-	let objects = Object.keys(globalObjects);
-	if (!checkInfinity) {
-		objects = objects.filter(name => name !== 'Infinity');
-	}
+	const objects = Object.keys(globalObjects).filter(name => {
+		if (!checkInfinity && name === 'Infinity') {
+			return false;
+		}
+
+		if (!checkNaN && name === 'NaN') {
+			return false;
+		}
+
+		return true;
+	});
 
 	const tracker = new GlobalReferenceTracker({
 		objects,
@@ -103,6 +112,10 @@ const schema = [
 		additionalProperties: false,
 		properties: {
 			checkInfinity: {
+				type: 'boolean',
+				default: false,
+			},
+			checkNaN: {
 				type: 'boolean',
 				default: true,
 			},

test/prefer-number-properties.mjs

@@ -281,6 +281,10 @@ test({
 		'class Foo { Infinity(){}}',
 		'const foo = Infinity;',
 		'const foo = -Infinity;',
+		{
+			code: 'const foo = NaN',
+			options: [{checkNaN: false}],
+		},
 	],
 	invalid: [
 		{