RxJS TSLint

TSLint rules for rxjs.

Rules

This repository provides the following rules:

| Rule name | Configuration | Description | | --------------------------------- | ------------- | ---------------------------------------------------- | | rxjs-collapse-imports | none | Collapses multiple imports from rxjs to a single one | | rxjs-pipeable-operators-only | none | Migrates side-effect operators to pipeables | | rxjs-no-static-observable-methods | none | Migrates static Observable method calls | | rxjs-proper-imports | none | Updates RxJS 5.x.x imports to RxJS 6.0 |

Migration to RxJS 6

Using the current set of rules allows you to automatically migrate your project which uses RxJS 5 to RxJS 6. Here's how you can perform the automatic migration:

1. Install rxjs-tslint:

npm i rxjs-tslint

2. In your project's directory, create a file called migrate-rxjs.tslint.json with the following content:

{
  "rulesDirectory": ["node_modules/rxjs-tslint"],
  "rules": {
    "rxjs-proper-imports": true,
    "rxjs-pipeable-operators-only": true,
    "rxjs-no-static-observable-methods": true,
    "rxjs-collapse-imports": true
  }
}

3. Run tslint, pointing to the tsconfig.json file that you use for TypeScript compilation (this is used so the checks can use type information). For example if your tsconfig is in src/tsconfig.app.json (the default from Angular CLI), the command would be:

./node_modules/.bin/tslint -c migrate-rxjs.tslint.json --project src/tsconfig.app.json --fix

4. Enjoy! 😎

Notes

• Once you run all the migrations check the diff and make sure that everything looks as expected. These fixers cover almost all cases we know of, but it's possible that some manual fixes can be required.
• Although the migration will format your source code, it's likely that that the style is not consistent with the rest of your project. To make sure that everything is properly following your project's style guide, we recommend you apply a formatter such as prettier or clang-format after the edits are made.

License

MIT