Installations

npm install @spotware/rxjs-tslint

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

8.11.1

NPM Version

5.7.1 Pull Requests

Open

3

Total

25

Closed

3

Merged

19

Issues

Open

11

Total

51

Closed

40

Releases

Unable to fetch releases

Languages

2

TypeScript

JavaScript

TypeScript (99.68%)

JavaScript (0.32%)

Developer

reactivex

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

310 Stars

46 Commits

41 Forks

7 Watchers

5 Branches

39 Contributors

Updated on Feb 16, 2025

Maintainers

1

View All 39 Contributors

Package Meta Information

Latest Version

0.1.7

Package Id

@spotware/rxjs-tslint@0.1.7

Unpacked Size

131.31 kB

Size

31.82 kB

File Count

56

NPM Version

5.7.1

Node Version

8.11.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

5

tslint chalk optimist tsutils typescript

Peer Dependencies

2

tslint typescript

Dev Dependencies

13

@types/chai @types/chalk @types/mocha @types/node @types/optimist @types/sprintf-js chai chai-spies js-yaml json-stringify-pretty-compact mocha rimraf ts-node

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:

1npm i -g rxjs-tslint
2rxjs-5-to-6-migrate -p [PATH_TO_TSCONFIG]

For an Angular CLI project the invocation of rxjs-5-to-6-migrate will be:

1rxjs-5-to-6-migrate -p src/tsconfig.app.json

Note: The rules use type checking to find all the instances of operators that need to be migrated to pipeables. This requires you to have rxjs@5 installed so that tslint could find the correct type definitions.

If you're following the migration instructions from https://update.angular.io, between versions 5 and 6 you'll have to run ng update @angular/core. This step will install rxjs-compat, which will let rxjs-5-to-6-migrate to perform the correct code transformations.

Use rules

To use the exported rules without rxjs-5-to-6-migrate, use the rulesDirectory configuration property of tslint.json:

1{
2  "rulesDirectory": [
3    "node_modules/rxjs-tslint"
4  ],
5  "rules": {
6    "rxjs-collapse-imports": true,
7    "rxjs-pipeable-operators-only": true,
8    "rxjs-no-static-observable-methods": true,
9    "rxjs-proper-imports": true
10  }
11}

To lint your project use:

./node_modules/.bin/tslint -c tslint.json -p tsconfig.json

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

No vulnerabilities found.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Pinned-Dependencies

Determines if the project has declared and pinned its dependencies.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

5

Code-Review

Determines if the project requires code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has a CII Best Practices Badge.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.2

/10

Last Scanned on 2022-08-15

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More