eslint-plugin-rxjs-x 0.2.4 → 0.3.1

package/docs/rules/ban-operators.md

@@ -1,5 +1,7 @@
 # Disallow banned operators (`rxjs-x/ban-operators`)
 
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
 <!-- end auto-generated rule header -->
 
 This rule can be configured so that developers can ban any operators they want to avoid in their project.

package/docs/rules/no-async-subscribe.md

@@ -7,6 +7,9 @@
 <!-- end auto-generated rule header -->
 
 This rule effects failures if async functions are passed to `subscribe`.
+Developers are encouraged to avoid race conditions
+by instead using RxJS operators which can handle both Promises and Observables
+(e.g. `concatMap`, `switchMap`, `mergeMap`, `exhaustMap`).
 
 ## Rule details
 
@@ -14,16 +17,26 @@ Examples of **incorrect** code for this rule:
 
 ```ts
 import { of } from "rxjs";
-of(42).subscribe(async () => console.log(value));
+
+of(42).subscribe(async value => {
+    const data1 = await fetch(`https://api.some.com/things/${value}`);
+    const data2 = await fetch(`https://api.some.com/things/${data1.id}`);
+    console.log(data2);
+});
 ```
 
 Examples of **correct** code for this rule:
 
 ```ts
 import { of } from "rxjs";
-of(42).subscribe(() => console.log(value));
+
+of(42).pipe(
+    switchMap(value => fetch(`http://api.some.com/things/${value}`)),
+    switchMap(data1 => fetch(`http://api.some.com/things/${data1.id}`)),
+).subscribe(data2 => console.log(data2));
 ```
 
 ## Further reading
 
 - [Why does this rule exist?](https://stackoverflow.com/q/71559135)
+- [Higher-order Observables](https://rxjs.dev/guide/higher-order-observables)

package/docs/rules/no-ignored-default-value.md

@@ -0,0 +1,29 @@
+# Disallow using `firstValueFrom`, `lastValueFrom`, `first`, and `last` without specifying a default value (`rxjs-x/no-ignored-default-value`)
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
+
+This rule prevents `EmptyError` rejections if there were no emissions from `firstValueFrom`, `lastValueFrom`, `first`, or `last` by requiring `defaultValue`.
+
+## Rule details
+
+Examples of **incorrect** code for this rule:
+
+```ts
+import { Subject, firstValueFrom } from "rxjs";
+
+const sub = new Subject();
+const result = firstValueFrom(sub);
+sub.complete();
+```
+
+Examples of **correct** code for this rule:
+
+```ts
+import { Subject, firstValueFrom } from "rxjs";
+
+const sub = new Subject();
+const result = firstValueFrom(sub, { defaultValue: null });
+sub.complete();
+```

package/docs/rules/throw-error.md

@@ -1,49 +1,38 @@
-# Enforce passing only `Error` values to error notifications (`rxjs-x/throw-error`)
+# Enforce passing only `Error` values to `throwError` (`rxjs-x/throw-error`)
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
 <!-- end auto-generated rule header -->
 
-This rule forbids throwing values that are neither `Error` nor `DOMException` instances.
+This rule forbids passing values that are not `Error` objects to `throwError`.
+It's similar to the typescript-eslint [`only-throw-error`](https://typescript-eslint.io/rules/only-throw-error/) rule,
+but is for the `throwError` Observable creation function - not `throw` statements.
 
 ## Rule details
 
 Examples of **incorrect** code for this rule:
 
-```ts
-throw "Kaboom!";
-```
-
 ```ts
 import { throwError } from "rxjs";
-throwError("Kaboom!");
-```
 
-```ts
-import { throwError } from "rxjs";
 throwError(() => "Kaboom!");
 ```
 
 Examples of **correct** code for this rule:
 
 ```ts
-throw new Error("Kaboom!");
-```
+import { throwError } from "rxjs";
 
-```ts
-throw new RangeError("Kaboom!");
+throwError(() => new Error("Kaboom!"));
 ```
 
-```ts
-throw new DOMException("Kaboom!");
-```
+## Options
 
-```ts
-import { throwError } from "rxjs";
-throwError(new Error("Kaboom!"));
-```
+<!-- begin auto-generated rule options list -->
 
-```ts
-import { throwError } from "rxjs";
-throwError(() => new Error("Kaboom!"));
-```
+| Name                   | Description                                                 | Type    | Default |
+| :--------------------- | :---------------------------------------------------------- | :------ | :------ |
+| `allowThrowingAny`     | Whether to always allow throwing values typed as `any`.     | Boolean | `true`  |
+| `allowThrowingUnknown` | Whether to always allow throwing values typed as `unknown`. | Boolean | `true`  |
+
+<!-- end auto-generated rule options list -->

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-rxjs-x",
   "type": "commonjs",
-  "version": "0.2.4",
+  "version": "0.3.1",
   "packageManager": "yarn@4.5.1+sha512.341db9396b6e289fecc30cd7ab3af65060e05ebff4b3b47547b278b9e67b08f485ecd8c79006b405446262142c7a38154445ef7f17c1d5d1de7d90bf9ce7054d",
   "description": "ESLint v9+ plugin for RxJS",
   "author": "Jason Weinzierl <weinzierljason@gmail.com>",
@@ -75,25 +75,24 @@
     "@stylistic/eslint-plugin": "^2.10.1",
     "@types/common-tags": "^1.8.4",
     "@types/node": "~18.18.0",
-    "@typescript-eslint/rule-tester": "^8.13.0",
+    "@typescript-eslint/rule-tester": "^8.14.0",
     "@typescript/vfs": "^1.6.0",
-    "@vitest/coverage-v8": "^2.1.4",
-    "@vitest/eslint-plugin": "^1.1.7",
-    "bumpp": "^9.8.0",
+    "@vitest/coverage-v8": "^2.1.5",
+    "@vitest/eslint-plugin": "^1.1.10",
+    "bumpp": "^9.8.1",
     "eslint": "^9.14.0",
     "eslint-config-flat-gitignore": "^0.3.0",
     "eslint-doc-generator": "^1.7.1",
     "eslint-import-resolver-typescript": "^3.6.3",
     "eslint-plugin-eslint-plugin": "^6.3.1",
-    "eslint-plugin-import-x": "^4.4.0",
+    "eslint-plugin-import-x": "^4.4.2",
     "eslint-plugin-n": "^17.13.1",
-    "markdownlint-cli2": "^0.14.0",
+    "markdownlint-cli2": "^0.15.0",
     "rxjs": "^7.8.1",
     "tsup": "^8.3.5",
-    "tsx": "^4.19.2",
     "typescript": "~5.6.3",
-    "typescript-eslint": "^8.13.0",
-    "vitest": "^2.1.4"
+    "typescript-eslint": "^8.14.0",
+    "vitest": "^2.1.5"
   },
   "engines": {
     "node": "^18.18.0 || ^20.9.0 || >= 21.1.0"