feat(eslint-plugin): add NgRx ESLint Plugin (#3373)

* feat(eslint-plugin): add NgRx ESLint Plugin

* feat: add eslint-plugin to update groups

Author: timdeschryver

.eslintrc.json

@@ -42,66 +42,7 @@
             "caughtErrorsIgnorePattern": "^_"
           }
         ],
-        "@typescript-eslint/naming-convention": [
-          "warn",
-          {
-            "selector": "default",
-            "format": ["camelCase"],
-            "leadingUnderscore": "allow"
-          },
-          {
-            "selector": "property",
-            "format": ["camelCase", "UPPER_CASE"],
-            "leadingUnderscore": "allow"
-          },
-          {
-            "selector": "enum",
-            "format": ["PascalCase"]
-          },
-          {
-            "selector": "enumMember",
-            "format": ["PascalCase", "UPPER_CASE"]
-          },
-          {
-            "selector": "typeParameter",
-            "format": ["PascalCase"]
-          },
-          {
-            "selector": "typeAlias",
-            "format": ["PascalCase"]
-          },
-          {
-            "selector": "interface",
-            "format": ["PascalCase"]
-          },
-          {
-            "selector": "classProperty",
-            "format": ["camelCase", "PascalCase", "UPPER_CASE"],
-            "leadingUnderscore": "allow"
-          },
-          {
-            "selector": "class",
-            "format": ["PascalCase"]
-          },
-          {
-            "selector": "variable",
-            "format": ["camelCase", "PascalCase", "UPPER_CASE"],
-            "leadingUnderscore": "allow"
-          },
-          {
-            "selector": "objectLiteralMethod",
-            "format": ["camelCase", "PascalCase", "UPPER_CASE"]
-          },
-          {
-            "selector": "objectLiteralProperty",
-            "format": ["camelCase", "PascalCase", "UPPER_CASE"]
-          },
-          {
-            "selector": "function",
-            "format": ["camelCase", "PascalCase"],
-            "leadingUnderscore": "allow"
-          }
-        ],
+        "@typescript-eslint/naming-convention": "off",
         "@typescript-eslint/prefer-namespace-keyword": "error",
         // because we're using object
         "@typescript-eslint/ban-types": "warn",

angular.json

@@ -440,6 +440,83 @@
       "schematics": {},
       "tags": []
     },
+    "eslint-plugin": {
+      "root": "modules/eslint-plugin",
+      "sourceRoot": "modules/eslint-plugin/src",
+      "projectType": "library",
+      "schematics": {},
+      "architect": {
+        "lint": {
+          "builder": "@nrwl/linter:eslint",
+          "options": {
+            "lintFilePatterns": [
+              "modules/eslint-plugin/*/**/*.ts",
+              "modules/eslint-plugin/*/**/*.html"
+            ]
+          },
+          "outputs": ["{options.outputFile}"]
+        },
+        "test": {
+          "builder": "@nrwl/jest:jest",
+          "options": {
+            "jestConfig": "modules/eslint-plugin/jest.config.js",
+            "runInBand": true
+          },
+          "outputs": ["coverage/modules/eslint-plugin"]
+        },
+        "build-package": {
+          "builder": "@nrwl/js:tsc",
+          "options": {
+            "outputPath": "dist/modules/eslint-plugin",
+            "tsConfig": "modules/eslint-plugin/tsconfig.build.json",
+            "packageJson": "modules/eslint-plugin/package.json",
+            "main": "modules/eslint-plugin/src/index.ts",
+            "sourceMap": false,
+            "assets": [
+              "collection.json",
+              {
+                "input": "./modules/eslint-plugin/src",
+                "glob": "**/*.!(ts)",
+                "output": "./src"
+              },
+              {
+                "input": "./modules/eslint-plugin",
+                "glob": "collection.json",
+                "output": "."
+              }
+            ],
+            "srcRootForCompilationRoot": "modules/eslint-plugin"
+          },
+          "outputs": ["{options.outputPath}"]
+        },
+        "build": {
+          "builder": "@nrwl/workspace:run-commands",
+          "options": {
+            "parallel": false,
+            "commands": [
+              {
+                "command": "nx build-package eslint-plugin"
+              },
+              // uncomment when there are eslint-plugin migrations
+              // {
+              //   "command": "yarn tsc -p modules/eslint-plugin/tsconfig.schematics.json"
+              // },
+              {
+                "command": "cpy modules/eslint-plugin/migrations/migration.json dist/modules/eslint-plugin/migrations"
+              },
+              {
+                "command": "cpy modules/eslint-plugin/schematics/collection.json dist/modules/eslint-plugin/schematics"
+              },
+              {
+                "command": "cpy modules/eslint-plugin/schematics/ng-add/schema.json dist/modules/eslint-plugin/schematics/ng-add"
+              }
+            ],
+            "outputPath": ["dist/modules/eslint-plugin"]
+          }
+        }
+      },
+      "tags": []
+    },
     "example-app": {
       "root": "projects/example-app",
       "sourceRoot": "projects/example-app/src",

modules/component-store/package.json

@@ -37,7 +37,8 @@
       "@ngrx/schematics",
       "@ngrx/store-devtools",
       "@ngrx/component-store",
-      "@ngrx/component"
+      "@ngrx/component",
+      "@ngrx/eslint-plugin"
     ],
     "migrations": "./migrations/migration.json"
   },

modules/component/package.json

@@ -36,7 +36,8 @@
       "@ngrx/schematics",
       "@ngrx/store-devtools",
       "@ngrx/component-store",
-      "@ngrx/component"
+      "@ngrx/component",
+      "@ngrx/eslint-plugin"
     ],
     "migrations": "./migrations/migration.json"
   },

modules/component/src/let/let.directive.ts

@@ -91,7 +91,6 @@ export interface LetViewContext<T> {
  */
 @Directive({ selector: '[ngrxLet]' })
 export class LetDirective<U> implements OnDestroy {
-  // eslint-disable-next-line @typescript-eslint/naming-convention
   static ngTemplateGuard_ngrxLet: 'binding';
 
   private isEmbeddedViewCreated = false;

modules/data/package.json

@@ -38,7 +38,8 @@
       "@ngrx/schematics",
       "@ngrx/store-devtools",
       "@ngrx/component-store",
-      "@ngrx/component"
+      "@ngrx/component",
+      "@ngrx/eslint-plugin"
     ],
     "migrations": "./migrations/migration.json"
   },

modules/effects/package.json

@@ -36,7 +36,8 @@
       "@ngrx/schematics",
       "@ngrx/store-devtools",
       "@ngrx/component-store",
-      "@ngrx/component"
+      "@ngrx/component",
+      "@ngrx/eslint-plugin"
     ],
     "migrations": "./migrations/migration.json"
   },

modules/entity/package.json

@@ -35,7 +35,8 @@
       "@ngrx/schematics",
       "@ngrx/store-devtools",
       "@ngrx/component-store",
-      "@ngrx/component"
+      "@ngrx/component",
+      "@ngrx/eslint-plugin"
     ],
     "migrations": "./migrations/migration.json"
   },

modules/eslint-plugin/.eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"]
+}

modules/eslint-plugin/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Change Log
+
+See [CHANGELOG.md](https://github.com/ngrx/platform/blob/master/CHANGELOG.md)