eslint-plugin-change-detection-strategy

eslint-plugin-change-detection-strategy

This eslint plugin checks Angular ChangeDetectionStrategy is OnPush

Example of incorrect code:

@Component({
    changeDetection: ChangeDetectionStrategy.Default // <-- error  Component should have ChangeDetectionStrategy.OnPush  change-detection-strategy/on-push
}) { }

@Component({
    ... // <-- error  Component should have ChangeDetectionStrategy.OnPush  change-detection-strategy/on-push
}) { }

Example of correct code:

@Component({
    changeDetection: ChangeDetectionStrategy.OnPush
}) { }

Installation

npm install --save-dev eslint-plugin-change-detection-strategy

or

yarn add -D eslint-plugin-change-detection-strategy

Usage

1. Add to .eslintrc plugins:

   "plugins": [ "change-detection-strategy" ],
   

2. Add to .eslintrc rules:

   "rules": { "change-detection-strategy/on-push": "error" }
   

3. Run lint --fix to fix the issues automatically.
4. Ignore the rule at some component if you like:

   // eslint-disable-next-line change-detection-strategy/on-push
   @Component({
       changeDetection: ChangeDetectionStrategy.OnPush // <-- ok
   }) { }
   

Changelog

0.1.1 (May 14, 2021)

• Add README.md (@snowinmars in #1)