@codelaw/rules-js 0.0.0-stage → 0.2.0

package/rules/js/use-isnan.md

@@ -0,0 +1,105 @@
+---
+id: js/use-isnan
+title: "Test for NaN with Number.isNaN"
+languages: [javascript, jsx, typescript, tsx]
+fix: manual
+fix_reason: "the comparison's operator decides whether to negate"
+stability: preview
+ported_from: [eslint/use-isnan]
+since: 0.1.0
+---
+
+Code tests for `NaN` with `Number.isNaN(x)`, never by comparing with `NaN`.
+
+**Why:** `NaN` is not equal to anything, itself included, so `x === NaN` is always false.
+
+```codelaw
+match:
+  kind: binary_expression
+  has:
+    field: operator
+    regex: ^(==|===|!=|!==|<|>|<=|>=)$
+  any:
+    - has: { field: left, regex: '^(Number\.)?NaN$' }
+    - has: { field: right, regex: '^(Number\.)?NaN$' }
+message: "Nothing equals NaN, not even NaN; use Number.isNaN(x)"
+```
+
+## How to fix
+
+1. Replace `x === NaN` or `x == NaN` with `Number.isNaN(x)`.
+2. Replace `x !== NaN` or `x != NaN` with `!Number.isNaN(x)`.
+
+## Examples
+
+### JavaScript
+
+#### Don't
+
+```js
+if (price === NaN) {
+  reset();
+}
+```
+
+#### Do
+
+```js
+if (Number.isNaN(price)) {
+  reset();
+}
+```
+
+### JSX
+
+#### Don't
+
+```jsx
+if (price === NaN) {
+  reset();
+}
+```
+
+#### Do
+
+```jsx
+if (Number.isNaN(price)) {
+  reset();
+}
+```
+
+### TypeScript
+
+#### Don't
+
+```ts
+if (price === NaN) {
+  reset();
+}
+```
+
+#### Do
+
+```ts
+if (Number.isNaN(price)) {
+  reset();
+}
+```
+
+### TSX
+
+#### Don't
+
+```tsx
+if (price === NaN) {
+  reset();
+}
+```
+
+#### Do
+
+```tsx
+if (Number.isNaN(price)) {
+  reset();
+}
+```

package/rules/js/valid-typeof.md

@@ -0,0 +1,111 @@
+---
+id: js/valid-typeof
+title: "typeof is compared with a type it can return"
+languages: [javascript, jsx, typescript, tsx]
+fix: manual
+fix_reason: "which type was meant needs the author"
+stability: preview
+ported_from: [eslint/valid-typeof]
+since: 0.1.0
+---
+
+`typeof x` is compared only with a string it can return: `"undefined"`, `"object"`, `"boolean"`,
+`"number"`, `"string"`, `"function"`, `"symbol"` or `"bigint"`.
+
+**Why:** A misspelled type such as `"strnig"` makes the comparison always false.
+
+```codelaw
+match:
+  any:
+    - pattern: typeof $X == $S
+    - pattern: typeof $X === $S
+    - pattern: typeof $X != $S
+    - pattern: typeof $X !== $S
+    - pattern: $S == typeof $X
+    - pattern: $S === typeof $X
+    - pattern: $S != typeof $X
+    - pattern: $S !== typeof $X
+constraints:
+  S:
+    kind: string
+    not: { regex: "^[\"'](undefined|object|boolean|number|string|function|symbol|bigint)[\"']$" }
+message: "`typeof` never returns $S"
+```
+
+## How to fix
+
+1. Correct the string to the type that was meant.
+
+## Examples
+
+### JavaScript
+
+#### Don't
+
+```js
+if (typeof name === "strnig") {
+  greet(name);
+}
+```
+
+#### Do
+
+```js
+if (typeof name === "string") {
+  greet(name);
+}
+```
+
+### JSX
+
+#### Don't
+
+```jsx
+if (typeof name === "strnig") {
+  greet(name);
+}
+```
+
+#### Do
+
+```jsx
+if (typeof name === "string") {
+  greet(name);
+}
+```
+
+### TypeScript
+
+#### Don't
+
+```ts
+if (typeof name === "strnig") {
+  greet(name);
+}
+```
+
+#### Do
+
+```ts
+if (typeof name === "string") {
+  greet(name);
+}
+```
+
+### TSX
+
+#### Don't
+
+```tsx
+if (typeof name === "strnig") {
+  greet(name);
+}
+```
+
+#### Do
+
+```tsx
+if (typeof name === "string") {
+  greet(name);
+}
+```