From 2888441a8d22b7c76340caf17a70a46f184cfb3b Mon Sep 17 00:00:00 2001 From: Jason Weinzierl Date: Sat, 9 Nov 2024 10:15:58 -0600 Subject: [PATCH] chore: deprecate rxjs-x/macro --- README.md | 2 +- docs/rules/macro.md | 4 ++++ src/rules/macro.ts | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 37585520..7b819887 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ The package includes the following rules. | [ban-operators](docs/rules/ban-operators.md) | Disallow banned operators. | | | | | | | [finnish](docs/rules/finnish.md) | Enforce Finnish notation. | | | | 💭 | | | [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. | | 🔧 | | | | +| [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-connectable](docs/rules/no-connectable.md) | Disallow operators that return connectable observables. | | | | 💭 | | diff --git a/docs/rules/macro.md b/docs/rules/macro.md index c1f269ef..7366475f 100644 --- a/docs/rules/macro.md +++ b/docs/rules/macro.md @@ -1,7 +1,11 @@ # Require the use of the RxJS Tools Babel macro (`rxjs-x/macro`) +❌ This rule is deprecated. + 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix). This rule ensures that modules that import `rxjs` also import the Babel macro for [RxJS Tools](https://rxjs.tools). + +This rule is deprecated because [`babel-plugin-rxjs-tools`](https://www.npmjs.com/package/babel-plugin-rxjs-tools) is unmaintained. diff --git a/src/rules/macro.ts b/src/rules/macro.ts index 0d404cb1..ab0ead34 100644 --- a/src/rules/macro.ts +++ b/src/rules/macro.ts @@ -7,6 +7,7 @@ import { ruleCreator } from '../utils'; export const macroRule = ruleCreator({ defaultOptions: [], meta: { + deprecated: true, docs: { description: 'Require the use of the RxJS Tools Babel macro.', },