eslint-plugin-rxjs-x 0.1.0 → 0.2.0

package/docs/rules/ban-observables.md

@@ -1,4 +1,6 @@
-# Avoid banned observable creators (`ban-observables`)
+# Disallow banned observable creators (`rxjs-x/ban-observables`)
+
+<!-- end auto-generated rule header -->
 
 This rule can be configured so that developers can ban any observable creators they want to avoid in their project.
 

package/docs/rules/ban-operators.md

@@ -1,4 +1,6 @@
-# Avoid banned operators (`ban-operators`)
+# Disallow banned operators (`rxjs-x/ban-operators`)
+
+<!-- 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/finnish.md

@@ -1,4 +1,8 @@
-# Use Finnish notation (`finnish`)
+# Enforce Finnish notation (`rxjs-x/finnish`)
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule enforces the use of Finnish notation - i.e. the `$` suffix.
 
@@ -18,9 +22,24 @@ const answer$ = of(42, 54);
 
 ## Options
 
+<!-- begin auto-generated rule options list -->
+
+| Name         | Description                                                          | Type    |
+| :----------- | :------------------------------------------------------------------- | :------ |
+| `functions`  | Require for functions.                                               | Boolean |
+| `methods`    | Require for methods.                                                 | Boolean |
+| `names`      | Enforce for specific names. Keys are a RegExp, values are a boolean. | Object  |
+| `parameters` | Require for parameters.                                              | Boolean |
+| `properties` | Require for properties.                                              | Boolean |
+| `strict`     | Disallow Finnish notation for non-Observables.                       | Boolean |
+| `types`      | Enforce for specific types. Keys are a RegExp, values are a boolean. | Object  |
+| `variables`  | Require for variables.                                               | Boolean |
+
+<!-- end auto-generated rule options list -->
+
 This rule accepts a single option which is an object with properties that determine whether Finnish notation is enforced for `functions`, `methods`, `parameters`, `properties` and `variables`. It also contains:
 
-- `names` and `types` properties that determine whether of not Finnish notation is to be enforced for specific names or types.
+- `names` and `types` properties that determine whether or not Finnish notation is to be enforced for specific names or types.
 - a `strict` property that, if `true`, allows the `$` suffix to be used _only_ with identifiers that have an `Observable` type.
 
 The default (Angular-friendly) configuration looks like this:

package/docs/rules/just.md

@@ -1,11 +1,11 @@
-# Use `just` instead of `of` (`just`)
+# Require the use of `just` instead of `of` (`rxjs-x/just`)
 
-This rule enforces the use of `just` instead of `of`. Some other languages with Rx implementations use the former and this rule is for developers who have that preference.
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-## Options
+<!-- end auto-generated rule header -->
 
-This rule has no options.
+This rule enforces the use of `just` instead of `of`. Some other languages with Rx implementations use the former and this rule is for developers who have that preference.
 
 ## Further reading
 
-- [Rename `of` to `just`](https://github.com/ReactiveX/rxjs/issues/3747)
+- [Rename `of` to `just`](https://github.com/ReactiveX/rxjs/issues/3747)

package/docs/rules/macro.md

@@ -1,7 +1,7 @@
-# Use the RxJS Tools macro (`macro`)
+# Require the use of the RxJS Tools Babel macro (`rxjs-x/macro`)
 
-This rule ensures that modules that import `rxjs` also import the Babel macro for [RxJS Tools](https://rxjs.tools).
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-## Options
+<!-- end auto-generated rule header -->
 
-This rule has no options.
+This rule ensures that modules that import `rxjs` also import the Babel macro for [RxJS Tools](https://rxjs.tools).

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

@@ -1,4 +1,10 @@
-# Avoid passing async functions to `subscribe` (`no-async-subscribe`)
+# Disallow passing `async` functions to `subscribe` (`rxjs-x/no-async-subscribe`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures if async functions are passed to `subscribe`.
 
@@ -18,10 +24,6 @@ import { of } from "rxjs";
 of(42).subscribe(() => console.log(value));
 ```
 
-## Options
-
-This rule has no options.
-
 ## Further reading
 
 - [Why does this rule exist?](https://stackoverflow.com/q/71559135)

package/docs/rules/no-compat.md

@@ -1,10 +1,8 @@
-# Avoid the `rxjs-compat` package (`no-compat`)
+# Disallow the `rxjs-compat` package (`rxjs-x/no-compat`)
 
-This rule prevents the use of `rxjs-compat`.
+<!-- end auto-generated rule header -->
 
-## Options
-
-This rule has no options.
+This rule prevents importing from locations that depend upon the `rxjs-compat` package.
 
 ## Further reading
 

package/docs/rules/no-connectable.md

@@ -1,7 +1,7 @@
-# Avoid connectable observables (`no-connectable`)
+# Disallow operators that return connectable observables (`rxjs-x/no-connectable`)
 
-This rule prevents the use of connectable observables.
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
-## Options
+<!-- end auto-generated rule header -->
 
-This rule has no options.
+This rule prevents the use of connectable observables.

package/docs/rules/no-create.md

@@ -1,4 +1,10 @@
-# Avoid the static `create` function (`no-create`)
+# Disallow the static `Observable.create` function (`rxjs-x/no-create`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule prevents the use of the static `create` function in `Observable`. Developers should use `new` and the constructor instead.
 
@@ -23,7 +29,3 @@ const answers = new Observable<number>(subscriber => {
   subscriber.complete();
 });
 ```
-
-## Options
-
-This rule has no options.

package/docs/rules/no-cyclic-action.md

@@ -1,4 +1,8 @@
-# Avoid cyclic actions in effects and epics (`no-cyclic-action`)
+# Disallow cyclic actions in effects and epics (`rxjs-x/no-cyclic-action`)
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures for effects and epics that emit actions that would pass their `ofType` filter. Such actions are cyclic and, upon emission, immediately re-trigger the effect or epic.
 
@@ -22,7 +26,7 @@ actions.pipe(
 );
 ```
 
-This rule can be used with effects _and epics_, so it makes __no attempt__ to discern whether or not dispatching is disabled for an NgRx effect. That is, code like this will effect (🙈) a failure:
+This rule can be used with effects _and epics_, so it makes **no attempt** to discern whether or not dispatching is disabled for an NgRx effect. That is, code like this will effect (🙈) a failure:
 
 ```ts
 someEffect = createEffect(() =>
@@ -50,6 +54,14 @@ Or you can use an ESLint [inline comment](https://eslint.org/docs/user-guide/con
 
 ## Options
 
+<!-- begin auto-generated rule options list -->
+
+| Name         | Description                                                   | Type   | Default                  |
+| :----------- | :------------------------------------------------------------ | :----- | :----------------------- |
+| `observable` | A RegExp that matches an effect or epic's actions observable. | String | `[Aa]ction(s\|s\$\|\$)$` |
+
+<!-- end auto-generated rule options list -->
+
 This rule accepts a single option which is an object with an `observable` property that is a regular expression used to match an effect or epic's actions observable. The default `observable` regular expression should match most effect and epic action sources.
 
 ```json

package/docs/rules/no-explicit-generics.md

@@ -1,4 +1,6 @@
-# Avoid unnecessary explicit type arguments (`no-explicit-generics`)
+# Disallow unnecessary explicit generic type arguments (`rxjs-x/no-explicit-generics`)
+
+<!-- end auto-generated rule header -->
 
 This rule prevents the use of explicit type arguments when the type arguments can be inferred.
 
@@ -17,7 +19,3 @@ Examples of **correct** code for this rule:
 import { BehaviorSubject } from "rxjs";
 const subject = new BehaviorSubject(42);
 ```
-
-## Options
-
-This rule has no options.

package/docs/rules/no-exposed-subjects.md

@@ -1,6 +1,10 @@
-# Avoid public and protected subjects (`no-exposed-subjects`)
+# Disallow public and protected subjects (`rxjs-x/no-exposed-subjects`)
 
-This rule prevents the public or protected subjects. Developers should instead expose observables via the subjects' `toObservable` method.
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
+
+This rule prevents exposed (i.e. non-private) subjects. Developers should instead expose observables via the subjects' `toObservable` method.
 
 ## Rule details
 
@@ -27,6 +31,14 @@ class Answers {
 
 ## Options
 
+<!-- begin auto-generated rule options list -->
+
+| Name             | Description               | Type    | Default |
+| :--------------- | :------------------------ | :------ | :------ |
+| `allowProtected` | Allow protected subjects. | Boolean | `false` |
+
+<!-- end auto-generated rule options list -->
+
 This rule accepts a single option which is an object with an `allowProtected` property that determines whether or not protected subjects are allowed. By default, they are not.
 
 ```json

package/docs/rules/no-finnish.md

@@ -1,4 +1,8 @@
-# Avoid Finnish notation (`no-finnish`)
+# Disallow Finnish notation (`rxjs-x/no-finnish`)
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule prevents the use of Finnish notation.
 
@@ -16,10 +20,6 @@ Examples of **correct** code for this rule:
 const answers = of(42, 54);
 ```
 
-## Options
-
-This rule has no options.
-
 ## Further reading
 
-- [Observables and Finnish Notation](https://medium.com/@benlesh/observables-and-finnish-notation-df8356ed1c9b)
+- [Observables and Finnish Notation](https://medium.com/@benlesh/observables-and-finnish-notation-df8356ed1c9b)

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

@@ -1,4 +1,8 @@
-# Enforce the passing of error handlers (`no-ignored-error`)
+# Disallow calling `subscribe` without specifying an error handler (`rxjs-x/no-ignored-error`)
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule enforces the passing of an error handler to `subscribe` calls.
 
@@ -31,7 +35,3 @@ source.subscribe({
   error: (error) => console.error(error)
 });
 ```
-
-## Options
-
-This rule has no options.

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

@@ -1,4 +1,10 @@
-# Ensure `repeatWhen` or `retryWhen` notifiers are used (`no-ignored-notifier`)
+# Disallow observables not composed from the `repeatWhen` or `retryWhen` notifier (`rxjs-x/no-ignored-notifier`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures if the notifier passed to a `repeatWhen` or `retryWhen` callback is not used.
 
@@ -24,7 +30,3 @@ const repeating = source.pipe(
   repeatWhen(notifications => notifications.pipe(take(3)))
 );
 ```
-
-## Options
-
-This rule has no options.

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

@@ -1,4 +1,8 @@
-# Use returned observables (`no-ignored-observable`)
+# Disallow ignoring observables returned by functions (`rxjs-x/no-ignored-observable`)
+
+💭 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.
 
@@ -17,7 +21,3 @@ Examples of **correct** code for this rule:
 import { of } from "rxjs";
 const answers = of(42, 54);
 ```
-
-## Options
-
-This rule has no options.

package/docs/rules/no-ignored-replay-buffer.md

@@ -1,4 +1,8 @@
-# Avoid unbounded replay buffers (`no-ignored-replay-buffer`)
+# Disallow using `ReplaySubject`, `publishReplay` or `shareReplay` without specifying the buffer size (`rxjs-x/no-ignored-replay-buffer`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures if the buffer size of a replay buffer is not explicitly specified.
 
@@ -22,7 +26,3 @@ const subject = new ReplaySubject<number>(1);
 import { ReplaySubject } from "rxjs";
 const subject = new ReplaySubject<number>(Infinity);
 ```
-
-## Options
-
-This rule has no options.

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

@@ -1,4 +1,8 @@
-# Enforce the passing of handlers to `subscribe` (`no-ignored-subscribe`)
+# Disallow calling `subscribe` without specifying arguments (`rxjs-x/no-ignored-subscribe`)
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures whenever `subscribe` is called without handlers.
 
@@ -22,7 +26,3 @@ import { of } from "rxjs";
 
 of(42, 54).subscribe((value) => console.log(value));
 ```
-
-## Options
-
-This rule has no options.

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

@@ -1,4 +1,8 @@
-# Use returned subscriptions (`no-ignored-subscription`)
+# Disallow ignoring the subscription returned by `subscribe` (`rxjs-x/no-ignored-subscription`)
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 The effects failures if an subscription returned by call to `subscribe` is neither assigned to a variable or property or passed to a function.
 
@@ -27,7 +31,3 @@ const numbers = new Observable<number>(subscriber => {
   interval(1e3).subscribe(subscriber);
 });
 ```
-
-## Options
-
-This rule has no options.

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

@@ -1,4 +1,8 @@
-# Avoid unused `takeWhile` values (`no-ignored-takewhile-value`)
+# Disallow ignoring the value within `takeWhile` (`rxjs-x/no-ignored-takewhile-value`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures if the value received by a `takeWhile` callback is not used in an expression.
 
@@ -20,7 +24,3 @@ import { takeWhile } from "rxjs/operators";
 
 const whilst = source.pipe(takeWhile(value => value));
 ```
-
-## Options
-
-This rule has no options.

package/docs/rules/no-implicit-any-catch.md

@@ -1,6 +1,14 @@
-# Use type-safe error handlers (`no-implicit-any-catch`)
+# Disallow implicit `any` error parameters in `catchError` operators (`rxjs-x/no-implicit-any-catch`)
 
-This rule requires an explicit type annotation for error parameters in error handlers. It's similar to the TypeScript [`no-implicit-any-catch`](https://github.com/typescript-eslint/typescript-eslint/blob/e01204931e460f5e6731abc443c88d666ca0b07a/packages/eslint-plugin/docs/rules/no-implicit-any-catch.md) rule, but is for observables - not `try`/`catch` statements.
+💼 This rule is enabled in the ✅ `recommended` config.
+
+🔧💡 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).
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
+
+This rule requires an explicit type annotation for error parameters in error handlers. It's similar to the typescript-eslint [`use-unknown-in-catch-callback-variable`](https://typescript-eslint.io/rules/use-unknown-in-catch-callback-variable/) rule or the TSConfig [`useUnknownInCatchVariables`](https://www.typescriptlang.org/tsconfig/#useUnknownInCatchVariables) option, but is for observables - not `try`/`catch` statements.
 
 ## Rule details
 
@@ -62,6 +70,14 @@ throwError(() => new Error("Kaboom!")).pipe(
 
 ## Options
 
+<!-- begin auto-generated rule options list -->
+
+| Name               | Description                                           | Type    | Default |
+| :----------------- | :---------------------------------------------------- | :------ | :------ |
+| `allowExplicitAny` | Allow error variable to be explicitly typed as `any`. | Boolean | `false` |
+
+<!-- end auto-generated rule options list -->
+
 This rule accepts a single option which is an object with an `allowExplicitAny` property that determines whether or not the error variable can be explicitly typed as `any`. By default, the use of explicit `any` is forbidden.
 
 ```json

package/docs/rules/no-index.md

@@ -1,4 +1,8 @@
-# Avoid importing index modules (`no-index`)
+# Disallow importing index modules (`rxjs-x/no-index`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures if an index module is specified as the import location.
 
@@ -15,7 +19,3 @@ Examples of **correct** code for this rule:
 ```ts
 import { of } from "rxjs";
 ```
-
-## Options
-
-This rule has no options.

package/docs/rules/no-internal.md

@@ -1,4 +1,10 @@
-# Avoid importing internal modules (`no-internal`)
+# Disallow importing internal modules (`rxjs-x/no-internal`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+🔧💡 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).
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures if an internal module is specified as the import location.
 
@@ -15,7 +21,3 @@ Examples of **correct** code for this rule:
 ```ts
 import { of } from "rxjs";
 ```
-
-## Options
-
-This rule has no options.

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

@@ -1,4 +1,10 @@
-# Avoid nested `subscribe` calls (`no-nested-subscribe`)
+# Disallow calling `subscribe` within a `subscribe` callback (`rxjs-x/no-nested-subscribe`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures if `subscribe` is called within a `subscribe` handler.
 
@@ -24,7 +30,3 @@ of(42, 54).pipe(
   mergeMap((value) => timer(1e3).pipe(mapTo(value)))
 ).subscribe((value) => console.log(value));
 ```
-
-## Options
-
-This rule has no options.

package/docs/rules/no-redundant-notify.md

@@ -1,4 +1,10 @@
-# Avoid sending redundant notifications (`no-redundant-notify`)
+# Disallow sending redundant notifications from completed or errored observables (`rxjs-x/no-redundant-notify`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures if an attempt is made to send a notification to an observer after a `complete` or `error` notification has already been sent.
 
@@ -26,7 +32,3 @@ const subject = new Subject<number>();
 subject.next(42);
 subject.error(new Error("Kaboom!"));
 ```
-
-## Options
-
-This rule has no options.

package/docs/rules/no-sharereplay.md

@@ -1,11 +1,23 @@
-# Avoid `shareReplay` (`no-sharereplay`)
+# Disallow unsafe `shareReplay` usage (`rxjs-x/no-sharereplay`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures if the `shareReplay` operator is used - or if it is used without specifying a `config` argument.
 
-The behaviour of `shareReplay` has changed several times - see the blog post linked below.
+The behavior of `shareReplay` has changed several times - see the blog post linked below.
 
 ## Options
 
+<!-- begin auto-generated rule options list -->
+
+| Name          | Description                                          | Type    | Default |
+| :------------ | :--------------------------------------------------- | :------ | :------ |
+| `allowConfig` | Allow shareReplay if a config argument is specified. | Boolean | `true`  |
+
+<!-- end auto-generated rule options list -->
+
 This rule accepts a single option which is an object with an `allowConfig` property that that determines whether `shareReplay` is allow if a config argument is specified. By default, `allowConfig` is `true`.
 
 ```json

package/docs/rules/no-subclass.md

@@ -1,7 +1,7 @@
-# Avoid subclassing RxJS classes (`no-subclass`)
+# Disallow subclassing RxJS classes (`rxjs-x/no-subclass`)
 
-This rule effects failures if an RxJS class is subclassed. Developers are encouraged to avoid subclassing RxJS classes, as some public and protected implementation details might change in the future.
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
-## Options
+<!-- end auto-generated rule header -->
 
-This rule has no options.
+This rule effects failures if an RxJS class is subclassed. Developers are encouraged to avoid subclassing RxJS classes, as some public and protected implementation details might change in the future.

package/docs/rules/no-subject-unsubscribe.md

@@ -1,11 +1,13 @@
-# Avoid calling `unsubscribe` on subjects (`no-subject-unsubscribe`)
+# Disallow calling the `unsubscribe` method of subjects (`rxjs-x/no-subject-unsubscribe`)
 
-This rule effects failures if the `unsubscribe` method is called on subjects. The method behaves differently to the `unsubsribe` method on subscriptions and is often an error.
+💼 This rule is enabled in the ✅ `recommended` config.
 
-## Options
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
-This rule has no options.
+<!-- end auto-generated rule header -->
+
+This rule effects failures if the `unsubscribe` method is called on subjects. The method behaves differently to the `unsubscribe` method on subscriptions and is often an error.
 
 ## Further reading
 
-- [Closed Subjects](https://ncjamieson.com/closed-subjects/)
+- [Closed Subjects](https://ncjamieson.com/closed-subjects/)

package/docs/rules/no-subject-value.md

@@ -1,7 +1,7 @@
-# Avoid using a behavior subject's value (`no-subject-value`)
+# Disallow accessing the `value` property of a `BehaviorSubject` instance (`rxjs-x/no-subject-value`)
 
-This rule effects an error if the `value` property - or `getValue` method - of a `BehaviorSubject` is used.
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
-## Options
+<!-- end auto-generated rule header -->
 
-This rule has no options.
+This rule effects an error if the `value` property - or `getValue` method - of a `BehaviorSubject` is used.

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

@@ -1,4 +1,8 @@
-# Forbid the passing of handlers to `subscribe` (`no-subscribe-handlers`)
+# Disallow passing handlers to `subscribe` (`rxjs-x/no-subscribe-handlers`)
+
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
+
+<!-- end auto-generated rule header -->
 
 This rule effects failures whenever `subscribe` is called with handlers.
 
@@ -13,7 +17,6 @@ import { tap } from "rxjs/operators";
 of(42, 54).subscribe((value) => console.log(value));
 ```
 
-<!-- prettier-ignore -->
 ```ts
 import { of } from "rxjs";
 import { tap } from "rxjs/operators";
@@ -25,7 +28,6 @@ of(42, 54).subscribe({
 
 Examples of **correct** code for this rule:
 
-<!-- prettier-ignore -->
 ```ts
 import { of } from "rxjs";
 
@@ -33,7 +35,3 @@ of(42, 54)
   .pipe(tap((value) => console.log(value)))
   .subscribe();
 ```
-
-## Options
-
-This rule has no options.

package/docs/rules/no-tap.md

@@ -1,7 +1,7 @@
-# Avoid `tap` (`no-tap`)
+# Disallow the `tap` operator (`rxjs-x/no-tap`)
 
-This rule effects failures if the `tap` operator is used.
+❌ This rule is deprecated. It was replaced by [`rxjs-x/ban-operators`](ban-operators.md).
 
-## Options
+<!-- end auto-generated rule header -->
 
-This rule has no options.
+This rule effects failures if the `tap` operator is used.

package/docs/rules/no-topromise.md

@@ -1,7 +1,7 @@
-# Avoid `toPromise` (`no-topromise`)
+# Disallow use of the `toPromise` method (`rxjs-x/no-topromise`)
 
-This rule effects failures if the `toPromise` method is used.
+💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
 
-## Options
+<!-- end auto-generated rule header -->
 
-This rule has no options.
+This rule effects failures if the `toPromise` method is used.