feat: add support for NgRx 18 (#23)

getlarge · web-flow · commit e1105887982b · 2024-10-09T13:53:28.000+02:00
* feat: add support for NgRx 18

* fix: apply requested changes

* refactor: revert rules removal
diff --git a/README.md b/README.md
@@ -84,7 +84,7 @@ All peer dependencies used by `@code-pushup/eslint-config` are listed below, alo
 | ![angular_component](https://raw.githubusercontent.com/code-pushup/eslint-config/main/docs/icons/material/angular_component.png) | [@angular-eslint/eslint-plugin-template](https://www.npmjs.com/package/@angular-eslint/eslint-plugin-template) | `^17.0.0 \|\| ^18.0.0` |          |
 | ![angular_component](https://raw.githubusercontent.com/code-pushup/eslint-config/main/docs/icons/material/angular_component.png) | [@angular-eslint/template-parser](https://www.npmjs.com/package/@angular-eslint/template-parser)               | `^17.0.0 \|\| ^18.0.0` |          |
 |           ![graphql](https://raw.githubusercontent.com/code-pushup/eslint-config/main/docs/icons/material/graphql.png)           | [@graphql-eslint/eslint-plugin](https://www.npmjs.com/package/@graphql-eslint/eslint-plugin)                   |        `^3.0.0`        |          |
-|               ![ngrx](https://raw.githubusercontent.com/code-pushup/eslint-config/main/docs/icons/other/ngrx.png)                | [@ngrx/eslint-plugin](https://www.npmjs.com/package/@ngrx/eslint-plugin)                                       |       `^17.0.0`        |          |
+|               ![ngrx](https://raw.githubusercontent.com/code-pushup/eslint-config/main/docs/icons/other/ngrx.png)                | [@ngrx/eslint-plugin](https://www.npmjs.com/package/@ngrx/eslint-plugin)                                       | `^17.0.0 \|\| ^18.0.0` |          |
 |           ![cypress](https://raw.githubusercontent.com/code-pushup/eslint-config/main/docs/icons/material/cypress.png)           | [eslint-plugin-cypress](https://www.npmjs.com/package/eslint-plugin-cypress)                                   |        `^2.0.0`        |          |
 |            ![expired](https://raw.githubusercontent.com/code-pushup/eslint-config/main/docs/icons/icons8/expired.png)            | [eslint-plugin-deprecation](https://www.npmjs.com/package/eslint-plugin-deprecation)                           |  `^2.0.0 \|\| ^3.0.0`  |          |
 |              ![jest](https://raw.githubusercontent.com/code-pushup/eslint-config/main/docs/icons/material/jest.png)              | [eslint-plugin-jest](https://www.npmjs.com/package/eslint-plugin-jest)                                         | `^27.0.0 \|\| ^28.0.0` |          |
diff --git a/angular-ngrx.js b/angular-ngrx.js
@@ -6,22 +6,43 @@ module.exports = {
     {
       files: TYPESCRIPT_FILE_PATTERNS,
 
-      extends: [
-        '@code-pushup/eslint-config/angular',
-        'plugin:@ngrx/recommended-requiring-type-checking',
-      ],
+      plugins: ['@ngrx'],
+      extends: ['@code-pushup/eslint-config/angular'],
 
       rules: {
         // CUSTOMIZED RULES FROM EXTENDED CONFIGS
 
+        // ADDITIONAL RULES
+
+        // https://github.com/ngrx/platform/tree/main/modules/eslint-plugin
+        '@ngrx/avoid-combining-component-store-selectors': 'warn',
         '@ngrx/avoid-cyclic-effects': 'error',
         '@ngrx/avoid-duplicate-actions-in-reducer': 'error',
-        '@ngrx/no-multiple-actions-in-effects': 'off',
-        '@ngrx/prefer-effect-callback-in-block-statement': 'off',
+        '@ngrx/avoid-mapping-component-store-selectors': 'warn',
+        '@ngrx/updater-explicit-return-type': 'warn',
+        '@ngrx/no-dispatch-in-effects': 'warn',
+        '@ngrx/no-effects-in-providers': 'error',
+        '@ngrx/prefer-action-creator-in-of-type': 'warn',
+        '@ngrx/prefer-concat-latest-from': 'warn',
+        '@ngrx/use-effects-lifecycle-interface': 'warn',
+        '@ngrx/avoid-combining-selectors': 'warn',
+        '@ngrx/avoid-dispatching-multiple-actions-sequentially': 'warn',
+        '@ngrx/avoid-mapping-selectors': 'warn',
+        '@ngrx/good-action-hygiene': 'warn',
+        '@ngrx/no-multiple-global-stores': 'warn',
+        '@ngrx/no-reducer-in-key-names': 'warn',
+        '@ngrx/no-store-subscription': 'warn',
+        '@ngrx/no-typed-global-store': 'warn',
+        '@ngrx/on-function-explicit-return-type': 'warn',
+        '@ngrx/prefer-action-creator-in-dispatch': 'warn',
+        '@ngrx/prefer-action-creator': 'warn',
+        '@ngrx/prefer-inline-action-props': 'warn',
+        '@ngrx/prefer-one-generic-in-create-for-feature-selector': 'warn',
+        '@ngrx/prefer-selector-in-select': 'warn',
+        '@ngrx/prefix-selectors-with-select': 'warn',
+        '@ngrx/select-style': 'warn',
         '@ngrx/use-consistent-global-store-name': ['warn', 'store$'],
 
-        // ADDITIONAL RULES
-
         // https://github.com/cartant/eslint-plugin-rxjs#rules
         'rxjs/no-unsafe-catch': 'error',
         'rxjs/no-unsafe-first': 'error',
diff --git a/docs/angular-ngrx.md b/docs/angular-ngrx.md
@@ -87,7 +87,7 @@ Config for **Angular** projects using **NgRx** library.
 | [![@ngrx](./icons/other/ngrx.png)](https://ngrx.io/guide/eslint-plugin) | [prefer-inline-action-props](https://ngrx.io/guide/eslint-plugin/rules/prefer-inline-action-props)<br />Prefer using inline types instead of interfaces, types or classes.                                                             |                                                                                          |   💡    |           |
 | [![@ngrx](./icons/other/ngrx.png)](https://ngrx.io/guide/eslint-plugin) | [prefer-one-generic-in-create-for-feature-selector](https://ngrx.io/guide/eslint-plugin/rules/prefer-one-generic-in-create-for-feature-selector)<br />Prefer using a single generic to define the feature state.                       |                                                                                          |   💡    |           |
 | [![@ngrx](./icons/other/ngrx.png)](https://ngrx.io/guide/eslint-plugin) | [prefer-selector-in-select](https://ngrx.io/guide/eslint-plugin/rules/prefer-selector-in-select)<br />Using a selector in the `select` is preferred over `string` or `props drilling`.                                                 |                                                                                          |         |           |
-| [![@ngrx](./icons/other/ngrx.png)](https://ngrx.io/guide/eslint-plugin) | [prefix-selectors-with-select](https://ngrx.io/guide/eslint-plugin/rules/prefix-selectors-with-select)<br />The selector should start with "select", for example "selectThing".                                                        |                                                                                          |   💡    |           |
+| [![@ngrx](./icons/other/ngrx.png)](https://ngrx.io/guide/eslint-plugin) | [prefix-selectors-with-select](https://ngrx.io/guide/eslint-plugin/rules/prefix-selectors-with-select)<br />The selector should start with "select", for example "selectEntity".                                                       |                                                                                          |   💡    |           |
 | [![@ngrx](./icons/other/ngrx.png)](https://ngrx.io/guide/eslint-plugin) | [select-style](https://ngrx.io/guide/eslint-plugin/rules/select-style)<br />Selector can be used either with `select` as a pipeable operator or as a method.                                                                           |                                                                                          |   🔧    |           |
 | [![@ngrx](./icons/other/ngrx.png)](https://ngrx.io/guide/eslint-plugin) | [updater-explicit-return-type](https://ngrx.io/guide/eslint-plugin/rules/updater-explicit-return-type)<br />`Updater` should have an explicit return type.                                                                             |                                                                                          |         |           |
 | [![@ngrx](./icons/other/ngrx.png)](https://ngrx.io/guide/eslint-plugin) | [use-consistent-global-store-name](https://ngrx.io/guide/eslint-plugin/rules/use-consistent-global-store-name)<br />Use a consistent name for the global store.                                                                        | <details><summary>store$</summary><pre lang="json"><code>"store$"</code></pre></details> |   💡    |           |
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -33,7 +33,7 @@
     "@angular-eslint/eslint-plugin-template": "^17.0.0 || ^18.0.0",
     "@angular-eslint/template-parser": "^17.0.0 || ^18.0.0",
     "@graphql-eslint/eslint-plugin": "^3.0.0",
-    "@ngrx/eslint-plugin": "^17.0.0",
+    "@ngrx/eslint-plugin": "^17.0.0 || ^18.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0 || ^7.0.0",
     "@typescript-eslint/parser": "^6.0.0 || ^7.0.0",
     "eslint": "^8.0.0",
@@ -101,7 +101,7 @@
     "@angular-eslint/eslint-plugin-template": "^18.0.1",
     "@angular-eslint/template-parser": "^18.0.1",
     "@graphql-eslint/eslint-plugin": "^3.20.1",
-    "@ngrx/eslint-plugin": "^17.2.0",
+    "@ngrx/eslint-plugin": "^18.1.0",
     "@typescript-eslint/eslint-plugin": "^7.13.1",
     "@typescript-eslint/parser": "^7.13.1",
     "build-md": "^0.4.1",
