eslint-plugin-rxjs-x 0.4.1 → 0.5.1

package/docs/rules/no-floating-observables.md

@@ -0,0 +1,48 @@
+# Require Observables to be handled appropriately (`rxjs-x/no-floating-observables`)
+
+💼 This rule is enabled in the 🔒 `strict` config.
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
+
+A "floating" observable is one that is created without any code set up to handle any errors it might emit.
+Like a floating Promise, floating observables can cause several issues, such as ignored errors, unhandled cold observables, and more.
+
+This rule is like [no-floating-promises](https://typescript-eslint.io/rules/no-floating-promises/) but for Observables.
+This rule will report observable-valued statements that are not treated in one of the following ways:
+
+- Calling its `.subscribe()`
+- `return`ing it
+- Wrapping it in `lastValueFrom` or `firstValueFrom` and `await`ing it
+- [`void`ing it](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void)
+
+> [!TIP]
+> `no-floating-observables` only detects apparently unhandled observable _statements_.
+> See [`no-misused-observables`](./no-misused-observables.md) for detecting code that provides observables to _logical_ locations
+
+## Rule details
+
+Examples of **incorrect** code for this rule:
+
+```ts
+import { of } from "rxjs";
+of(42, 54);
+```
+
+Examples of **correct** code for this rule:
+
+```ts
+import { of } from "rxjs";
+const answers = of(42, 54);
+```
+
+## Options
+
+<!-- begin auto-generated rule options list -->
+
+| Name         | Description                           | Type    | Default |
+| :----------- | :------------------------------------ | :------ | :------ |
+| `ignoreVoid` | Whether to ignore `void` expressions. | Boolean | `true`  |
+
+<!-- end auto-generated rule options list -->

package/docs/rules/no-misused-observables.md

@@ -0,0 +1,85 @@
+# Disallow Observables in places not designed to handle them (`rxjs-x/no-misused-observables`)
+
+💼 This rule is enabled in the 🔒 `strict` config.
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
+
+This rule forbids providing observables to logical locations where the TypeScript compiler allows them but they are not handled properly.
+These situations can often arise due to a misunderstanding of the way observables are handled.
+
+> [!TIP]
+> `no-misused-observables` only detects code that provides observables to incorrect _logical_ locations.
+> See [`no-floating-observables`](./no-floating-observables.md) for detecting unhandled observable _statements_.
+
+This rule is like [no-misused-promises](https://typescript-eslint.io/rules/no-misused-promises) but for Observables.
+
+> [!NOTE]
+> Unlike `@typescript-eslint/no-misused-promises`, this rule does not check conditionals like `if` statements.
+> Use `@typescript-eslint/no-unnecessary-condition` for linting those situations.
+
+## Rule details
+
+Examples of **incorrect** code for this rule:
+
+```ts
+import { of } from "rxjs";
+
+[1, 2, 3].forEach(i => of(i));
+
+interface MySyncInterface {
+    foo(): void;
+}
+class MyRxClass implements MySyncInterface {
+    foo(): Observable<number> {
+        return of(42);
+    }
+}
+
+const a = of(42);
+const b = { ...b };
+```
+
+Examples of **correct** code for this rule:
+
+```ts
+import { of } from "rxjs";
+
+[1, 2, 3].map(i => of(i));
+
+interface MyRxInterface {
+    foo(): Observable<number>;
+}
+class MyRxClass implements MyRxInterface {
+    foo(): Observable<number> {
+        return of(42);
+    }
+}
+```
+
+## Options
+
+<!-- WARNING: not auto-generated! -->
+
+| Name               | Description                                                                 | Type    | Default |
+| :----------------- | :-------------------------------------------------------------------------- | :------ | :------ |
+| `checksSpreads`    | Disallow `...` spreading an Observable.                                     | Boolean | `true`  |
+| `checksVoidReturn` | Disallow returning an Observable from a function typed as returning `void`. | Object  | `true`  |
+
+### `checksVoidReturn`
+
+You can disable selective parts of the `checksVoidReturn` option. The following sub-options are supported:
+
+| Name               | Description                                                                                                                              | Type    | Default |
+| :----------------- | :--------------------------------------------------------------------------------------------------------------------------------------- | :------ | :------ |
+| `arguments`        | Disallow passing an Observable-returning function as an argument where the parameter type expects a function that returns `void`.        | Boolean | `true`  |
+| `attributes`       | Disallow passing an Observable-returning function as a JSX attribute expected to be a function that returns `void`.                      | Boolean | `true`  |
+| `inheritedMethods` | Disallow providing an Observable-returning function where a function that returns `void` is expected by an extended or implemented type. | Boolean | `true`  |
+| `properties`       | Disallow providing an Observable-returning function where a function that returns `void` is expected by a property.                      | Boolean | `true`  |
+| `returns`          | Disallow returning an Observable-returning function where a function that returns `void` is expected.                                    | Boolean | `true`  |
+| `variables`        | Disallow assigning or declaring an Observable-returning function where a function that returns `void` is expected.                       | Boolean | `true`  |
+
+## Further reading
+
+- [TypeScript void function assignability](https://github.com/Microsoft/TypeScript/wiki/FAQ#why-are-functions-returning-non-void-assignable-to-function-returning-void)

package/docs/rules/no-topromise.md

@@ -1,6 +1,6 @@
 # Disallow use of the `toPromise` method (`rxjs-x/no-topromise`)
 
-💼 This rule is enabled in the 🔒 `strict` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 

package/docs/rules/prefer-observer.md

@@ -1,6 +1,6 @@
 # Disallow passing separate handlers to `subscribe` and `tap` (`rxjs-x/prefer-observer`)
 
-💼 This rule is enabled in the 🔒 `strict` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 

package/docs/rules/prefer-root-operators.md

@@ -1,6 +1,6 @@
 # Disallow importing operators from `rxjs/operators` (`rxjs-x/prefer-root-operators`)
 
-💼 This rule is enabled in the 🔒 `strict` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 🔧💡 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix) and manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 

package/docs/rules/throw-error.md

@@ -1,6 +1,6 @@
 # Enforce passing only `Error` values to `throwError` (`rxjs-x/throw-error`)
 
-💼 This rule is enabled in the 🔒 `strict` config.
+💼 This rule is enabled in the following configs: ✅ `recommended`, 🔒 `strict`.
 
 💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-rxjs-x",
   "type": "commonjs",
-  "version": "0.4.1",
+  "version": "0.5.1",
   "packageManager": "yarn@4.5.3+sha512.3003a14012e2987072d244c720506549c1aab73ee728208f1b2580a9fd67b92d61ba6b08fe93f6dce68fd771e3af1e59a0afa28dd242dd0940d73b95fedd4e90",
   "description": "ESLint v9+ plugin for RxJS",
   "author": "Jason Weinzierl <weinzierljason@gmail.com>",
@@ -18,6 +18,8 @@
     "lint",
     "rules",
     "eslint",
+    "eslintplugin",
+    "eslint-plugin",
     "rxjs"
   ],
   "sideEffects": false,
@@ -62,7 +64,7 @@
   },
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0",
-    "rxjs": ">=7.0.0",
+    "rxjs": ">=7.2.0",
     "typescript": ">=4.7.4"
   },
   "peerDependenciesMeta": {
@@ -71,16 +73,16 @@
     }
   },
   "devDependencies": {
-    "@eslint/js": "^9.14.0",
+    "@eslint/js": "^9.16.0",
     "@stylistic/eslint-plugin": "^2.11.0",
     "@types/common-tags": "^1.8.4",
     "@types/node": "~18.18.0",
-    "@typescript-eslint/rule-tester": "^8.15.0",
+    "@typescript-eslint/rule-tester": "^8.17.0",
     "@typescript/vfs": "^1.6.0",
-    "@vitest/coverage-v8": "^2.1.5",
-    "@vitest/eslint-plugin": "^1.1.10",
+    "@vitest/coverage-v8": "^2.1.8",
+    "@vitest/eslint-plugin": "^1.1.14",
     "bumpp": "^9.8.1",
-    "eslint": "^9.14.0",
+    "eslint": "^9.16.0",
     "eslint-config-flat-gitignore": "^0.3.0",
     "eslint-doc-generator": "^1.7.1",
     "eslint-import-resolver-typescript": "^3.6.3",
@@ -91,8 +93,8 @@
     "rxjs": "^7.8.1",
     "tsup": "^8.3.5",
     "typescript": "~5.7.2",
-    "typescript-eslint": "^8.15.0",
-    "vitest": "^2.1.5"
+    "typescript-eslint": "^8.17.0",
+    "vitest": "^2.1.8"
   },
   "engines": {
     "node": "^18.18.0 || ^20.9.0 || >= 21.1.0"

package/docs/rules/no-ignored-observable.md

@@ -1,25 +0,0 @@
-# Disallow ignoring observables returned by functions (`rxjs-x/no-ignored-observable`)
-
-💼 This rule is enabled in the 🔒 `strict` config.
-
-💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
-
-<!-- end auto-generated rule header -->
-
-The effects failures if an observable returned by a function is neither assigned to a variable or property or passed to a function.
-
-## Rule details
-
-Examples of **incorrect** code for this rule:
-
-```ts
-import { of } from "rxjs";
-of(42, 54);
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-import { of } from "rxjs";
-const answers = of(42, 54);
-```