Skip to content

Commit 83a01e2

Browse files
docs: migration instructions
1 parent 1d1ea64 commit 83a01e2

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,22 @@
33
[![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/JasonWeinzierl/eslint-plugin-rxjs-x/blob/master/LICENSE)
44
[![NPM version](https://img.shields.io/npm/v/eslint-plugin-rxjs-x.svg)](https://www.npmjs.com/package/eslint-plugin-rxjs-x)
55

6-
This package contains a bunch of ESLint v9+ rules for RxJS.
7-
It is a fork of [`eslint-plugin-rxjs`](https://github.com/cartant/eslint-plugin-rxjs)
6+
This ESLint plugin is intended to prevent issues with [RxJS](https://github.com/ReactiveX/rxjs).
7+
8+
Most of these rules require TypeScript typed linting and are indicated as such below.
9+
10+
## Migrating from `eslint-plugin-rxjs`
11+
12+
This project is a fork of [`eslint-plugin-rxjs`](https://github.com/cartant/eslint-plugin-rxjs)
813
initially started to support the new ESLint flat config format.
9-
The original package is itself a re-implementation of the rules that are in the [`rxjs-tslint-rules`](https://github.com/cartant/rxjs-tslint-rules) package.
10-
(The Angular-specific rules in `rxjs-tslint-rules` have been re-implemented in [`eslint-plugin-rxjs-angular`](https://github.com/cartant/eslint-plugin-rxjs-angular).)
14+
There are some breaking changes:
1115

12-
Some of the rules are rather opinionated and are not included in the `recommended` configuration. Developers can decide for themselves whether they want to enable opinionated rules.
16+
- The old `.eslintrc` format is not supported.
17+
- If you need to continue using this old format, use the original `eslint-plugin-rxjs` or a different fork.
18+
- The plugin namespace specified in the `recommended` config was changed from `rxjs` to `rxjs-x`.
19+
- e.g. In your ESLint config, `rxjs/no-subject-value` should be renamed to `rxjs-x/no-subject-value`.
1320

14-
Almost all of these rules require the TypeScript parser for ESLint and are indicated as such below.
21+
A complete description of all changes are documented in the [CHANGELOG](CHANGELOG.md) file.
1522

1623
## Install
1724

0 commit comments

Comments
 (0)