diff --git a/README.md b/README.md index 4a68a477..c2e88286 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ The package includes the following rules. | [just](docs/rules/just.md) | Require the use of `just` instead of `of`. | | 🔧 | | | | | [macro](docs/rules/macro.md) | Require the use of the RxJS Tools Babel macro. | | 🔧 | | | ❌ | | [no-async-subscribe](docs/rules/no-async-subscribe.md) | Disallow passing `async` functions to `subscribe`. | ✅ | | | 💭 | | -| [no-compat](docs/rules/no-compat.md) | Disallow the `rxjs-compat` package. | | | | | | +| [no-compat](docs/rules/no-compat.md) | Disallow the `rxjs-compat` package. | | | | | ❌ | | [no-connectable](docs/rules/no-connectable.md) | Disallow operators that return connectable observables. | | | | 💭 | | | [no-create](docs/rules/no-create.md) | Disallow the static `Observable.create` function. | ✅ | | | 💭 | | | [no-cyclic-action](docs/rules/no-cyclic-action.md) | Disallow cyclic actions in effects and epics. | | | | 💭 | | diff --git a/docs/rules/no-compat.md b/docs/rules/no-compat.md index 27f2d5ec..a071a443 100644 --- a/docs/rules/no-compat.md +++ b/docs/rules/no-compat.md @@ -1,9 +1,13 @@ # Disallow the `rxjs-compat` package (`rxjs-x/no-compat`) +❌ This rule is deprecated. + This rule prevents importing from locations that depend upon the `rxjs-compat` package. +This rule is deprecated because RxJS v7+ no longer includes `rxjs-compat`. + ## Further reading - [Backwards compatibility](https://github.com/ReactiveX/rxjs/blob/a6590e971969c736a15b77154dabbc22275aa0d5/docs_app/content/guide/v6/migration.md#backwards-compatibility) diff --git a/src/rules/no-compat.ts b/src/rules/no-compat.ts index aec188f1..84046427 100644 --- a/src/rules/no-compat.ts +++ b/src/rules/no-compat.ts @@ -4,6 +4,7 @@ import { ruleCreator } from '../utils'; export const noCompatRule = ruleCreator({ defaultOptions: [], meta: { + deprecated: true, docs: { description: 'Disallow the `rxjs-compat` package.',