docs: auto-generate rule docs (#5)

- Add eslint-doc-generator and run on existing documentation.
- Update existing rule descriptions to align across both rule
description and markdown header.
	- Add Configs section to README.
- Add markdownlint.

Author: JasonWeinzierl

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

README.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-observables.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/ban-operators.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/finnish.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/just.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/macro.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-async-subscribe.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