docs: auto-generate rule docs

.markdownlint.json

@@ -0,0 +1,3 @@
+{
+  "line-length": false
+}

CONTRIBUTING.md

@@ -1 +1,3 @@
-There's nothing here, yet. Thanks for looking. I'll eventually get around to filling this out.
+# Contributing
+
+There's nothing here, yet. Thanks for looking. I'll eventually get around to filling this out.

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.
 

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.
 

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,6 +22,21 @@ const answer$ = of(42, 54);
 
 ## Options
 
+<!-- begin auto-generated rule options list -->
+
+| Name         | Type    |
+| :----------- | :------ |
+| `functions`  | Boolean |
+| `methods`    | Boolean |
+| `names`      | Object  |
+| `parameters` | Boolean |
+| `properties` | Boolean |
+| `strict`     | Boolean |
+| `types`      | Object  |
+| `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.

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)

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).

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)

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
 

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.

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.

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         | Type   |
+| :----------- | :----- |
+| `observable` | String |
+
+<!-- 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

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.

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             | Type    |
+| :--------------- | :------ |
+| `allowProtected` | Boolean |
+
+<!-- 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

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)

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.

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.

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.

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.

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.

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.

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.