https://github.com/timdeschryver/ngrx-tslint

https://github.com/timdeschryver/ngrx-tslint

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/timdeschryver/ngrx-tslint
• Owner: timdeschryver
• License: mit
• Created: 2018-09-15T15:50:42.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-08T19:32:58.000Z (almost 6 years ago)
• Last Synced: 2024-10-04T17:48:31.618Z (3 months ago)
• Language: TypeScript
• Size: 33.2 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NgRx TSLint

TSLint rules for NgRx.

Heavily based on [ReactiveX/rxjs-tslint](https://github.com/ReactiveX/rxjs-tslint)

## Table of Contents

- [NgRx TSLint](#ngrx-tslint)

  - [Table of Contents](#table-of-contents)

  - [Rules](#rules)

    - [ngrx-effects-operators](#ngrx-effects-operators)

    - [ngrx-chained-pipes](#ngrx-chained-pipes)

  - [Usage](#usage)

  - [License](#license)

## Rules

### ngrx-effects-operators

Migrates the `ofType` function to its pipeable equivalent.

```ts

BEFORE:

import { Effect, Actions } from '@ngrx/effects';

@Effect()

search = this.actions.ofType(SEARCH_ANIMALS).pipe(

    debounceTime(3000),

    switchMap(...),

  );

AFTER:

import { Effect, Actions, ofType } from '@ngrx/effects';

@Effect()

search = this.actions.pipe(

    ofType(SEARCH_ANIMALS),

    debounceTime(3000),

    switchMap(...),

  );

```

### ngrx-chained-pipes

Because the rules above will create a new `pipe` chain you may end up with multiple pipes, this rule will combine both pipe chains.

```ts

BEFORE:

this.store.pipe(select(...)).pipe(map(...))

AFTER:

this.store.pipe(select(...), map(...))

```

## Usage

Automatically run the migration:

```bash

npx ngrx-tslint-oftype

```

Or install the package, add the following rules to the `tslint.confg` and run TSLint on the project.

```bash

npm install ngrx-tslint-oftype --save-dev

```

```json

{

  "rulesDirectory": ["node_modules/ngrx-tslint-oftype"],

  "rules": {

    "ngrx-effects-operators": true,

    "ngrx-chained-pipes": true

  }

}

```

```bash

./node_modules/.bin/tslint -c tslint.json -p src/tsconfig.app.json --fix

```

## License

MIT