Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

docs(useIsNan): promote Number.isNaN instead of isNaN #4088

Merged
merged 1 commit into from
Jan 5, 2023
Merged

docs(useIsNan): promote Number.isNaN instead of isNaN #4088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions crates/rome_js_analyze/src/analyzers/nursery/use_is_nan.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ declare_rule! {
/// - `NaN` === `NaN` or `NaN` == `NaN` evaluate to false
/// - `NaN` !== `NaN` or `NaN` != `NaN` evaluate to true
///
/// Therefore, use `Number.isNaN()` or global `isNaN()` functions to test whether a value is `NaN`.
/// Therefore, use `Number.isNaN()` or global `isNaN()` functions to test whether a value is `NaN`.
///
/// Note that `Number.isNaN()` and `isNaN()` [have not the same behavior](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/isNaN#description).
/// When the argument to `isNaN()` is not a number, the value is first coerced to a number.
/// `Number.isNaN()` does not perform this coercion.
/// Therefore, it is a more reliable way to test whether a value is `NaN`.
///
/// Source: [use-isnan](https://eslint.org/docs/latest/rules/use-isnan).
///
Expand All @@ -41,7 +46,7 @@ declare_rule! {
/// ### Valid
///
/// ```js
/// if (isNaN(123) !== true) {}
/// if (Number.isNaN(123) !== true) {}
///
/// foo(Number.NaN / 2)
///
Expand Down Expand Up @@ -73,7 +78,7 @@ pub struct RuleState {
impl Message {
fn as_str(&self) -> &str {
match self {
Self::BinaryExpression => "Use the isNaN function to compare with NaN.",
Self::BinaryExpression => "Use the Number.isNaN function to compare with NaN.",
Self::CaseClause => "'case NaN' can never match. Use Number.isNaN before the switch.",
Self::SwitchCase => "'switch(NaN)' can never match a case clause. Use Number.isNaN instead of the switch."
}
Expand Down
68 changes: 34 additions & 34 deletions crates/rome_js_analyze/tests/specs/nursery/useIsNan/invalid.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ switch(Number.NaN) { case Number.NaN: break; }
```
invalid.js:1:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

> 1 │ 123 == NaN;
│ ^^^^^^^^^^
Expand All @@ -83,7 +83,7 @@ invalid.js:1:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:2:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

1 │ 123 == NaN;
> 2 │ 123 === NaN;
Expand All @@ -97,7 +97,7 @@ invalid.js:2:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:3:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

1 │ 123 == NaN;
2 │ 123 === NaN;
Expand All @@ -112,7 +112,7 @@ invalid.js:3:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:4:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

2 │ 123 === NaN;
3 │ NaN === "abc";
Expand All @@ -127,7 +127,7 @@ invalid.js:4:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:5:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

3 │ NaN === "abc";
4 │ NaN == "abc";
Expand All @@ -142,7 +142,7 @@ invalid.js:5:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:6:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

4 │ NaN == "abc";
5 │ 123 != NaN;
Expand All @@ -157,7 +157,7 @@ invalid.js:6:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:7:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

5 │ 123 != NaN;
6 │ 123 !== NaN;
Expand All @@ -172,7 +172,7 @@ invalid.js:7:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:8:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

6 │ 123 !== NaN;
7 │ NaN !== "abc";
Expand All @@ -187,7 +187,7 @@ invalid.js:8:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:9:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

7 │ NaN !== "abc";
8 │ NaN != "abc";
Expand All @@ -202,7 +202,7 @@ invalid.js:9:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:10:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

8 │ NaN != "abc";
9 │ NaN < "abc";
Expand All @@ -217,7 +217,7 @@ invalid.js:10:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:11:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

9 │ NaN < "abc";
10 │ "abc" < NaN;
Expand All @@ -232,7 +232,7 @@ invalid.js:11:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:12:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

10 │ "abc" < NaN;
11 │ NaN > "abc";
Expand All @@ -247,7 +247,7 @@ invalid.js:12:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:13:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

11 │ NaN > "abc";
12 │ "abc" > NaN;
Expand All @@ -262,7 +262,7 @@ invalid.js:13:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:14:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

12 │ "abc" > NaN;
13 │ NaN <= "abc";
Expand All @@ -277,7 +277,7 @@ invalid.js:14:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:15:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

13 │ NaN <= "abc";
14 │ "abc" <= NaN;
Expand All @@ -292,7 +292,7 @@ invalid.js:15:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:16:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

14 │ "abc" <= NaN;
15 │ NaN >= "abc";
Expand All @@ -307,7 +307,7 @@ invalid.js:16:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:17:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

15 │ NaN >= "abc";
16 │ "abc" >= NaN;
Expand All @@ -322,7 +322,7 @@ invalid.js:17:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:18:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

16 │ "abc" >= NaN;
17 │ 123 == Number.NaN;
Expand All @@ -337,7 +337,7 @@ invalid.js:18:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:19:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

17 │ 123 == Number.NaN;
18 │ 123 === Number.NaN;
Expand All @@ -352,7 +352,7 @@ invalid.js:19:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:20:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

18 │ 123 === Number.NaN;
19 │ Number.NaN === "abc";
Expand All @@ -367,7 +367,7 @@ invalid.js:20:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:21:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

19 │ Number.NaN === "abc";
20 │ Number.NaN == "abc";
Expand All @@ -382,7 +382,7 @@ invalid.js:21:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:22:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

20 │ Number.NaN == "abc";
21 │ 123 != Number.NaN;
Expand All @@ -397,7 +397,7 @@ invalid.js:22:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:23:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

21 │ 123 != Number.NaN;
22 │ 123 !== Number.NaN;
Expand All @@ -412,7 +412,7 @@ invalid.js:23:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:24:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

22 │ 123 !== Number.NaN;
23 │ Number.NaN !== "abc";
Expand All @@ -427,7 +427,7 @@ invalid.js:24:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:25:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

23 │ Number.NaN !== "abc";
24 │ Number.NaN != "abc";
Expand All @@ -442,7 +442,7 @@ invalid.js:25:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:26:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

24 │ Number.NaN != "abc";
25 │ Number.NaN < "abc";
Expand All @@ -457,7 +457,7 @@ invalid.js:26:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:27:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

25 │ Number.NaN < "abc";
26 │ "abc" < Number.NaN;
Expand All @@ -472,7 +472,7 @@ invalid.js:27:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:28:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

26 │ "abc" < Number.NaN;
27 │ Number.NaN > "abc";
Expand All @@ -487,7 +487,7 @@ invalid.js:28:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:29:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

27 │ Number.NaN > "abc";
28 │ "abc" > Number.NaN;
Expand All @@ -502,7 +502,7 @@ invalid.js:29:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:30:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

28 │ "abc" > Number.NaN;
29 │ Number.NaN <= "abc";
Expand All @@ -517,7 +517,7 @@ invalid.js:30:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:31:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

29 │ Number.NaN <= "abc";
30 │ "abc" <= Number.NaN;
Expand All @@ -532,7 +532,7 @@ invalid.js:31:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:32:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

30 │ "abc" <= Number.NaN;
31 │ Number.NaN >= "abc";
Expand All @@ -547,7 +547,7 @@ invalid.js:32:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:33:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

31 │ Number.NaN >= "abc";
32 │ "abc" >= Number.NaN;
Expand All @@ -562,7 +562,7 @@ invalid.js:33:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━
```
invalid.js:34:1 lint/nursery/useIsNan ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

! Use the isNaN function to compare with NaN.
! Use the Number.isNaN function to compare with NaN.

32 │ "abc" >= Number.NaN;
33 │ x === Number?.NaN;
Expand Down
Loading