@ngrx/eslint-plugin 14.0.0-beta.0

package/jest.config.js

@@ -0,0 +1,22 @@
+"use strict";
+exports.__esModule = true;
+/* eslint-disable */
+exports["default"] = {
+    displayName: 'eslint-plugin',
+    preset: '../../jest.preset.js',
+    coverageDirectory: '../../coverage/modules/esling-plugin',
+    setupFilesAfterEnv: ['<rootDir>/test-setup.ts'],
+    testEnvironment: 'node',
+    globals: {
+        'ts-jest': {
+            tsconfig: '<rootDir>/tsconfig.spec.json',
+            stringifyContentPathRegex: '\\.(html|svg)$'
+        }
+    },
+    transform: { '^.+\\.(ts|js|mjs|html)$': 'jest-preset-angular' },
+    transformIgnorePatterns: ['node_modules/(?!@angular|tslib)'],
+    moduleNameMapper: {
+        tslib: '<rootDir>../../node_modules/tslib/tslib.es6.js'
+    }
+};
+//# sourceMappingURL=jest.config.js.map

package/jest.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.config.js","sourceRoot":"","sources":["../../../modules/eslint-plugin/jest.config.ts"],"names":[],"mappings":";;AAAA,oBAAoB;AACpB,qBAAe;IACb,WAAW,EAAE,eAAe;IAC5B,MAAM,EAAE,sBAAsB;IAC9B,iBAAiB,EAAE,sCAAsC;IACzD,kBAAkB,EAAE,CAAC,yBAAyB,CAAC;IAC/C,eAAe,EAAE,MAAM;IACvB,OAAO,EAAE;QACP,SAAS,EAAE;YACT,QAAQ,EAAE,8BAA8B;YACxC,yBAAyB,EAAE,gBAAgB;SAC5C;KACF;IACD,SAAS,EAAE,EAAE,yBAAyB,EAAE,qBAAqB,EAAE;IAC/D,uBAAuB,EAAE,CAAC,iCAAiC,CAAC;IAC5D,gBAAgB,EAAE;QAChB,KAAK,EAAE,gDAAgD;KACxD;CACF,CAAC","sourcesContent":["/* eslint-disable */\nexport default {\n  displayName: 'eslint-plugin',\n  preset: '../../jest.preset.js',\n  coverageDirectory: '../../coverage/modules/esling-plugin',\n  setupFilesAfterEnv: ['<rootDir>/test-setup.ts'],\n  testEnvironment: 'node',\n  globals: {\n    'ts-jest': {\n      tsconfig: '<rootDir>/tsconfig.spec.json',\n      stringifyContentPathRegex: '\\\\.(html|svg)$',\n    },\n  },\n  transform: { '^.+\\\\.(ts|js|mjs|html)$': 'jest-preset-angular' },\n  transformIgnorePatterns: ['node_modules/(?!@angular|tslib)'],\n  moduleNameMapper: {\n    tslib: '<rootDir>../../node_modules/tslib/tslib.es6.js',\n  },\n};\n"]}

package/migrations/migration.json

@@ -0,0 +1,3 @@
+{
+  "schematics": {}
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@ngrx/eslint-plugin",
+  "version": "14.0.0-beta.0",
+  "description": "NgRx ESLint Plugin",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ngrx/platform.git"
+  },
+  "keywords": [
+    "RxJS",
+    "Angular",
+    "Redux",
+    "NgRx"
+  ],
+  "author": "NgRx",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ngrx/platform/issues"
+  },
+  "homepage": "https://github.com/ngrx/platform#readme",
+  "schematics": "./schematics/collection.json",
+  "ng-update": {
+    "packageGroup": [
+      "@ngrx/store",
+      "@ngrx/effects",
+      "@ngrx/entity",
+      "@ngrx/router-store",
+      "@ngrx/data",
+      "@ngrx/schematics",
+      "@ngrx/store-devtools",
+      "@ngrx/component-store",
+      "@ngrx/component",
+      "@ngrx/eslint-plugin"
+    ],
+    "migrations": "./migrations/migration.json"
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@angular-devkit/schematics": "^14.0.0-rc.0",
+    "@typescript-eslint/experimental-utils": "^5.4.0",
+    "eslint-etc": "^5.1.0",
+    "semver": "^7.3.5",
+    "strip-json-comments": "3.1.1"
+  },
+  "peerDependencies": {
+    "eslint": ">=8.0.0",
+    "typescript": ">=4.4.0"
+  },
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts"
+}

package/schematics/collection.json

@@ -0,0 +1,10 @@
+{
+  "schematics": {
+    "ng-add": {
+      "aliases": ["init"],
+      "factory": "./ng-add",
+      "schema": "./ng-add/schema.json",
+      "description": "Add @ngrx/eslint-plugin to your application"
+    }
+  }
+}

package/schematics/ng-add/index.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+var strip_json_comments_1 = __importDefault(require("strip-json-comments"));
+function addNgRxESLintPlugin(schema) {
+    return function (host, context) {
+        var _a, _b;
+        var eslintConfigPath = '.eslintrc.json';
+        var docs = 'https://ngrx.io/guide/eslint-plugin';
+        var eslint = (_a = host.read(eslintConfigPath)) === null || _a === void 0 ? void 0 : _a.toString('utf-8');
+        if (!eslint) {
+            context.logger.warn("\nCould not find the ESLint config at `".concat(eslintConfigPath, "`.\nThe NgRx ESLint Plugin is installed but not configured.\n\nPlease see ").concat(docs, " to configure the NgRx ESLint Plugin.\n"));
+            return host;
+        }
+        try {
+            var json = JSON.parse((0, strip_json_comments_1["default"])(eslint));
+            if (json.overrides) {
+                if (!json.overrides.some(function (override) {
+                    var _a;
+                    return (_a = override["extends"]) === null || _a === void 0 ? void 0 : _a.some(function (extend) {
+                        return extend.startsWith('plugin:@ngrx');
+                    });
+                })) {
+                    json.overrides.push(configurePlugin(schema.config));
+                }
+            }
+            else if (!((_b = json["extends"]) === null || _b === void 0 ? void 0 : _b.some(function (extend) { return extend.startsWith('plugin:@ngrx'); }))) {
+                json.overrides = [configurePlugin(schema.config)];
+            }
+            host.overwrite(eslintConfigPath, JSON.stringify(json, null, 2));
+            context.logger.info("\n  The NgRx ESLint Plugin is installed and configured with the '".concat(schema.config, "' config.\n\n  If you want to change the configuration, please see ").concat(docs, ".\n  "));
+            return host;
+        }
+        catch (err) {
+            var detailsContent = err instanceof Error
+                ? "\nDetails:\n".concat(err.message, "\n")
+                : '';
+            context.logger.warn("\nSomething went wrong while adding the NgRx ESLint Plugin.\nThe NgRx ESLint Plugin is installed but not configured.\n\nPlease see ".concat(docs, " to configure the NgRx ESLint Plugin.\n").concat(detailsContent, "\n"));
+        }
+    };
+    function configurePlugin(config) {
+        return {
+            files: ['*.ts'],
+            "extends": ["plugin:@ngrx/".concat(config)]
+        };
+    }
+}
+exports["default"] = addNgRxESLintPlugin;
+//# sourceMappingURL=index.js.map

package/schematics/ng-add/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../modules/eslint-plugin/schematics/ng-add/index.ts"],"names":[],"mappings":";;;;;AACA,4EAAoD;AAGpD,SAAwB,mBAAmB,CAAC,MAAc;IACxD,OAAO,UAAC,IAAU,EAAE,OAAyB;;QAC3C,IAAM,gBAAgB,GAAG,gBAAgB,CAAC;QAC1C,IAAM,IAAI,GAAG,qCAAqC,CAAC;QAEnD,IAAM,MAAM,GAAG,MAAA,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,0CAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,iDACc,gBAAgB,uFAG3C,IAAI,4CAChB,CAAC,CAAC;YACG,OAAO,IAAI,CAAC;SACb;QAED,IAAI;YACF,IAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,gCAAiB,EAAC,MAAM,CAAC,CAAC,CAAC;YACnD,IAAI,IAAI,CAAC,SAAS,EAAE;gBAClB,IACE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAC,QAAa;;oBACjC,OAAA,MAAA,QAAQ,CAAC,SAAO,CAAA,0CAAE,IAAI,CAAC,UAAC,MAAW;wBACjC,OAAA,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC;oBAAjC,CAAiC,CAClC,CAAA;iBAAA,CACF,EACD;oBACA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;iBACrD;aACF;iBAAM,IACL,CAAC,CAAA,MAAA,IAAI,CAAC,SAAO,CAAA,0CAAE,IAAI,CAAC,UAAC,MAAW,IAAK,OAAA,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,EAAjC,CAAiC,CAAC,CAAA,EACvE;gBACA,IAAI,CAAC,SAAS,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;aACnD;YAED,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAEhE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,2EACuC,MAAM,CAAC,MAAM,gFAEtB,IAAI,UACzD,CAAC,CAAC;YACC,OAAO,IAAI,CAAC;SACb;QAAC,OAAO,GAAG,EAAE;YACZ,IAAM,cAAc,GAClB,GAAG,YAAY,KAAK;gBAClB,CAAC,CAAC,sBAEV,GAAG,CAAC,OAAO,OACZ;gBACS,CAAC,CAAC,EAAE,CAAC;YACT,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,6IAIb,IAAI,oDACf,cAAc,OACf,CAAC,CAAC;SACE;IACH,CAAC,CAAC;IACF,SAAS,eAAe,CAAC,MAAwB;QAC/C,OAAO;YACL,KAAK,EAAE,CAAC,MAAM,CAAC;YACf,SAAO,EAAE,CAAC,uBAAgB,MAAM,CAAE,CAAC;SACpC,CAAC;IACJ,CAAC;AACH,CAAC;AAjED,yCAiEC","sourcesContent":["import type { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';\nimport stripJsonComments from 'strip-json-comments';\nimport type { Schema } from './schema';\n\nexport default function addNgRxESLintPlugin(schema: Schema): Rule {\n  return (host: Tree, context: SchematicContext) => {\n    const eslintConfigPath = '.eslintrc.json';\n    const docs = 'https://ngrx.io/guide/eslint-plugin';\n\n    const eslint = host.read(eslintConfigPath)?.toString('utf-8');\n    if (!eslint) {\n      context.logger.warn(`\nCould not find the ESLint config at \\`${eslintConfigPath}\\`.\nThe NgRx ESLint Plugin is installed but not configured.\n\nPlease see ${docs} to configure the NgRx ESLint Plugin.\n`);\n      return host;\n    }\n\n    try {\n      const json = JSON.parse(stripJsonComments(eslint));\n      if (json.overrides) {\n        if (\n          !json.overrides.some((override: any) =>\n            override.extends?.some((extend: any) =>\n              extend.startsWith('plugin:@ngrx')\n            )\n          )\n        ) {\n          json.overrides.push(configurePlugin(schema.config));\n        }\n      } else if (\n        !json.extends?.some((extend: any) => extend.startsWith('plugin:@ngrx'))\n      ) {\n        json.overrides = [configurePlugin(schema.config)];\n      }\n\n      host.overwrite(eslintConfigPath, JSON.stringify(json, null, 2));\n\n      context.logger.info(`\n  The NgRx ESLint Plugin is installed and configured with the '${schema.config}' config.\n\n  If you want to change the configuration, please see ${docs}.\n  `);\n      return host;\n    } catch (err) {\n      const detailsContent =\n        err instanceof Error\n          ? `\nDetails:\n${err.message}\n`\n          : '';\n      context.logger.warn(`\nSomething went wrong while adding the NgRx ESLint Plugin.\nThe NgRx ESLint Plugin is installed but not configured.\n\nPlease see ${docs} to configure the NgRx ESLint Plugin.\n${detailsContent}\n`);\n    }\n  };\n  function configurePlugin(config: Schema['config']): Record<string, unknown> {\n    return {\n      files: ['*.ts'],\n      extends: [`plugin:@ngrx/${config}`],\n    };\n  }\n}\n"]}

package/schematics/ng-add/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+exports.__esModule = true;
+//# sourceMappingURL=schema.js.map

package/schematics/ng-add/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../../modules/eslint-plugin/schematics/ng-add/schema.ts"],"names":[],"mappings":"","sourcesContent":["// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface Schema {\n  config:\n    | 'recommended'\n    | 'strict'\n    | 'store'\n    | 'effects'\n    | 'component-store'\n    | 'all';\n}\n"]}

package/schematics/ng-add/schema.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "SchematicsEslintPluginNgRx",
+  "title": "eslint-plugin-ngrx schema",
+  "type": "object",
+  "properties": {
+    "config": {
+      "description": "The config to be used.",
+      "type": "string",
+      "default": "recommended",
+      "enum": [
+        "recommended",
+        "recommended-requiring-type-checking",
+        "strict",
+        "strict-requiring-type-checking",
+        "store",
+        "store-strict",
+        "effects",
+        "effects-requiring-type-checking",
+        "effects-strict",
+        "component-store",
+        "component-store-strict",
+        "all",
+        "all-requiring-type-checking"
+      ],
+      "x-prompt": {
+        "message": "Which config would you like to use?",
+        "type": "list",
+        "items": [
+          {
+            "value": "recommended",
+            "label": "recommended"
+          },
+          {
+            "value": "recommended-requiring-type-checking",
+            "label": "recommended with type checking"
+          },
+          {
+            "value": "strict",
+            "label": "strict"
+          },
+          {
+            "value": "strict-requiring-type-checking",
+            "label": "strict with type checking"
+          },
+          {
+            "value": "store",
+            "label": "store"
+          },
+          {
+            "value": "store-strict",
+            "label": "strict store"
+          },
+          {
+            "value": "effects",
+            "label": "effects"
+          },
+          {
+            "value": "effects-requiring-type-checking",
+            "label": "effects with type checking"
+          },
+          {
+            "value": "effects-strict",
+            "label": "strict effects"
+          },
+          {
+            "value": "component-store",
+            "label": "component-store"
+          },
+          {
+            "value": "component-store-strict",
+            "label": "strict component-store"
+          },
+          {
+            "value": "all",
+            "label": "all"
+          },
+          {
+            "value": "all-requiring-type-checking",
+            "label": "all with type checking"
+          }
+        ]
+      }
+    }
+  },
+  "required": []
+}

package/scripts/generate-config.js

@@ -0,0 +1,85 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+exports.__esModule = true;
+var fs_1 = require("fs");
+var path_1 = require("path");
+var prettier_1 = require("prettier");
+var rules_1 = require("../src/rules");
+var prettierConfig = prettier_1.resolveConfig.sync(__dirname);
+var RULE_MODULE = '@ngrx';
+var CONFIG_DIRECTORY = './modules/eslint-plugin/src/configs/';
+writeConfig('recommended', function (rule) { var _a, _b; return !!((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.recommended) && !((_b = rule.meta.docs) === null || _b === void 0 ? void 0 : _b.requiresTypeChecking); });
+writeConfig('all', function (rule) { var _a; return !((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.requiresTypeChecking); });
+writeConfig('strict', function (rule) { var _a; return !((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.requiresTypeChecking); }, function () { return 'error'; });
+writeConfig('recommended-requiring-type-checking', function (rule) { var _a; return !!((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.recommended); });
+writeConfig('all-requiring-type-checking', function () { return true; });
+writeConfig('strict-requiring-type-checking', function () { return true; }, function () { return 'error'; });
+writeConfig('store', function (rule) { var _a; return rule.meta.ngrxModule === 'store' && !((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.requiresTypeChecking); });
+writeConfig('store-strict', function (rule) { var _a; return rule.meta.ngrxModule === 'store' && !((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.requiresTypeChecking); }, function () { return 'error'; });
+writeConfig('effects', function (rule) { var _a; return rule.meta.ngrxModule === 'effects' && !((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.requiresTypeChecking); });
+writeConfig('effects-strict', function (rule) { var _a; return rule.meta.ngrxModule === 'effects' && !((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.requiresTypeChecking); }, function () { return 'error'; });
+writeConfig('effects-requiring-type-checking', function (rule) { return rule.meta.ngrxModule === 'effects'; });
+writeConfig('effects-strict-requiring-type-checking', function (rule) { return rule.meta.ngrxModule === 'effects'; }, function () { return 'error'; });
+writeConfig('component-store', function (rule) {
+    var _a;
+    return rule.meta.ngrxModule === 'component-store' &&
+        !((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.requiresTypeChecking);
+});
+writeConfig('component-store-strict', function (rule) {
+    var _a;
+    return rule.meta.ngrxModule === 'component-store' &&
+        !((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.requiresTypeChecking);
+}, function () { return 'error'; });
+function writeConfig(configName, predicate, setting) {
+    if (setting === void 0) { setting = function (rule) { var _a; return ((_a = rule.meta.docs) === null || _a === void 0 ? void 0 : _a.recommended) || 'warn'; }; }
+    var rulesForConfig = Object.entries(rules_1.rules).filter(function (_a) {
+        var _b = __read(_a, 2), _ = _b[0], rule = _b[1];
+        return predicate(rule);
+    });
+    var configRules = rulesForConfig.reduce(function (rules, _a) {
+        var _b = __read(_a, 2), ruleName = _b[0], rule = _b[1];
+        rules["".concat(RULE_MODULE, "/").concat(ruleName)] = setting(rule);
+        return rules;
+    }, {});
+    var parserOptions = rulesForConfig.some(function (_a) {
+        var _b;
+        var _c = __read(_a, 2), _ = _c[0], rule = _c[1];
+        return (_b = rule.meta.docs) === null || _b === void 0 ? void 0 : _b.requiresTypeChecking;
+    })
+        ? {
+            ecmaVersion: 2020,
+            sourceType: 'module',
+            project: './tsconfig.json'
+        }
+        : null;
+    var code = "\n/**\n * DO NOT EDIT\n * This file is generated\n */\n\nexport = {\n  parser: \"@typescript-eslint/parser\",\n  ".concat(parserOptions ? "parserOptions: ".concat(JSON.stringify(parserOptions), ",") : '', "\n  plugins: [\"").concat(RULE_MODULE, "\"],\n  rules: ").concat(JSON.stringify(configRules), ",\n}\n");
+    var config = (0, prettier_1.format)(code, __assign({ parser: 'typescript' }, prettierConfig));
+    (0, fs_1.writeFileSync)((0, path_1.join)(CONFIG_DIRECTORY, "".concat(configName, ".ts")), config);
+}
+//# sourceMappingURL=generate-config.js.map

package/scripts/generate-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-config.js","sourceRoot":"","sources":["../../../../modules/eslint-plugin/scripts/generate-config.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yBAAmC;AACnC,6BAA4B;AAC5B,qCAAiD;AAEjD,sCAAqC;AAErC,IAAM,cAAc,GAAG,wBAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAErD,IAAM,WAAW,GAAG,OAAO,CAAC;AAC5B,IAAM,gBAAgB,GAAG,sCAAsC,CAAC;AAEhE,WAAW,CACT,aAAa,EACb,UAAC,IAAI,gBACH,OAAA,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,WAAW,CAAA,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,oBAAoB,CAAA,CAAA,EAAA,CACzE,CAAC;AAEF,WAAW,CAAC,KAAK,EAAE,UAAC,IAAI,YAAK,OAAA,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,oBAAoB,CAAA,CAAA,EAAA,CAAC,CAAC;AAEpE,WAAW,CACT,QAAQ,EACR,UAAC,IAAI,YAAK,OAAA,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,oBAAoB,CAAA,CAAA,EAAA,EAC/C,cAAM,OAAA,OAAO,EAAP,CAAO,CACd,CAAC;AAEF,WAAW,CACT,qCAAqC,EACrC,UAAC,IAAI,YAAK,OAAA,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,WAAW,CAAA,CAAA,EAAA,CACxC,CAAC;AAEF,WAAW,CAAC,6BAA6B,EAAE,cAAM,OAAA,IAAI,EAAJ,CAAI,CAAC,CAAC;AAEvD,WAAW,CACT,gCAAgC,EAChC,cAAM,OAAA,IAAI,EAAJ,CAAI,EACV,cAAM,OAAA,OAAO,EAAP,CAAO,CACd,CAAC;AAEF,WAAW,CACT,OAAO,EACP,UAAC,IAAI,YACH,OAAA,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,oBAAoB,CAAA,CAAA,EAAA,CAC5E,CAAC;AAEF,WAAW,CACT,cAAc,EACd,UAAC,IAAI,YACH,OAAA,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,oBAAoB,CAAA,CAAA,EAAA,EAC3E,cAAM,OAAA,OAAO,EAAP,CAAO,CACd,CAAC;AAEF,WAAW,CACT,SAAS,EACT,UAAC,IAAI,YACH,OAAA,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,oBAAoB,CAAA,CAAA,EAAA,CAC9E,CAAC;AAEF,WAAW,CACT,gBAAgB,EAChB,UAAC,IAAI,YACH,OAAA,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,oBAAoB,CAAA,CAAA,EAAA,EAC7E,cAAM,OAAA,OAAO,EAAP,CAAO,CACd,CAAC;AAEF,WAAW,CACT,iCAAiC,EACjC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,EAAlC,CAAkC,CAC7C,CAAC;AAEF,WAAW,CACT,wCAAwC,EACxC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,EAAlC,CAAkC,EAC5C,cAAM,OAAA,OAAO,EAAP,CAAO,CACd,CAAC;AAEF,WAAW,CACT,iBAAiB,EACjB,UAAC,IAAI;;IACH,OAAA,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,iBAAiB;QAC1C,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,oBAAoB,CAAA,CAAA;CAAA,CACxC,CAAC;AAEF,WAAW,CACT,wBAAwB,EACxB,UAAC,IAAI;;IACH,OAAA,IAAI,CAAC,IAAI,CAAC,UAAU,KAAK,iBAAiB;QAC1C,CAAC,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,oBAAoB,CAAA,CAAA;CAAA,EACvC,cAAM,OAAA,OAAO,EAAP,CAAO,CACd,CAAC;AAEF,SAAS,WAAW,CAClB,UAc4B,EAC5B,SAAwD,EACxD,OACuC;IADvC,wBAAA,EAAA,oBAAW,IAAgC,YACzC,OAAA,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,WAAW,KAAI,MAAM,CAAA,EAAA;IAEvC,IAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,aAAK,CAAC,CAAC,MAAM,CAAC,UAAC,EAAS;YAAT,KAAA,aAAS,EAAR,CAAC,QAAA,EAAE,IAAI,QAAA;QAC3D,OAAA,SAAS,CAAC,IAAI,CAAC;IAAf,CAAe,CAChB,CAAC;IACF,IAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CACvC,UAAC,KAAK,EAAE,EAAgB;YAAhB,KAAA,aAAgB,EAAf,QAAQ,QAAA,EAAE,IAAI,QAAA;QACrB,KAAK,CAAC,UAAG,WAAW,cAAI,QAAQ,CAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QACpD,OAAO,KAAK,CAAC;IACf,CAAC,EACD,EAAE,CACH,CAAC;IACF,IAAM,aAAa,GACjB,cAAc,CAAC,IAAI,CAAC,UAAC,EAAS;;YAAT,KAAA,aAAS,EAAR,CAAC,QAAA,EAAE,IAAI,QAAA;QAAM,OAAA,MAAA,IAAI,CAAC,IAAI,CAAC,IAAI,0CAAE,oBAAoB,CAAA;KAAA,CAAC;QACtE,CAAC,CAAC;YACE,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,iBAAiB;SAC3B;QACH,CAAC,CAAC,IAAI,CAAC;IAEX,IAAM,IAAI,GAAG,2HAQX,aAAa,CAAC,CAAC,CAAC,yBAAkB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,MAAG,CAAC,CAAC,CAAC,EAAE,6BAC5D,WAAW,4BACf,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,WAErC,CAAC;IACA,IAAM,MAAM,GAAG,IAAA,iBAAM,EAAC,IAAI,aACxB,MAAM,EAAE,YAAY,IACjB,cAAc,EACjB,CAAC;IACH,IAAA,kBAAa,EAAC,IAAA,WAAI,EAAC,gBAAgB,EAAE,UAAG,UAAU,QAAK,CAAC,EAAE,MAAM,CAAC,CAAC;AACpE,CAAC","sourcesContent":["import { writeFileSync } from 'fs';\nimport { join } from 'path';\nimport { format, resolveConfig } from 'prettier';\nimport type { NgRxRuleModule } from '../src/rule-creator';\nimport { rules } from '../src/rules';\n\nconst prettierConfig = resolveConfig.sync(__dirname);\n\nconst RULE_MODULE = '@ngrx';\nconst CONFIG_DIRECTORY = './modules/eslint-plugin/src/configs/';\n\nwriteConfig(\n  'recommended',\n  (rule) =>\n    !!rule.meta.docs?.recommended && !rule.meta.docs?.requiresTypeChecking\n);\n\nwriteConfig('all', (rule) => !rule.meta.docs?.requiresTypeChecking);\n\nwriteConfig(\n  'strict',\n  (rule) => !rule.meta.docs?.requiresTypeChecking,\n  () => 'error'\n);\n\nwriteConfig(\n  'recommended-requiring-type-checking',\n  (rule) => !!rule.meta.docs?.recommended\n);\n\nwriteConfig('all-requiring-type-checking', () => true);\n\nwriteConfig(\n  'strict-requiring-type-checking',\n  () => true,\n  () => 'error'\n);\n\nwriteConfig(\n  'store',\n  (rule) =>\n    rule.meta.ngrxModule === 'store' && !rule.meta.docs?.requiresTypeChecking\n);\n\nwriteConfig(\n  'store-strict',\n  (rule) =>\n    rule.meta.ngrxModule === 'store' && !rule.meta.docs?.requiresTypeChecking,\n  () => 'error'\n);\n\nwriteConfig(\n  'effects',\n  (rule) =>\n    rule.meta.ngrxModule === 'effects' && !rule.meta.docs?.requiresTypeChecking\n);\n\nwriteConfig(\n  'effects-strict',\n  (rule) =>\n    rule.meta.ngrxModule === 'effects' && !rule.meta.docs?.requiresTypeChecking,\n  () => 'error'\n);\n\nwriteConfig(\n  'effects-requiring-type-checking',\n  (rule) => rule.meta.ngrxModule === 'effects'\n);\n\nwriteConfig(\n  'effects-strict-requiring-type-checking',\n  (rule) => rule.meta.ngrxModule === 'effects',\n  () => 'error'\n);\n\nwriteConfig(\n  'component-store',\n  (rule) =>\n    rule.meta.ngrxModule === 'component-store' &&\n    !rule.meta.docs?.requiresTypeChecking\n);\n\nwriteConfig(\n  'component-store-strict',\n  (rule) =>\n    rule.meta.ngrxModule === 'component-store' &&\n    !rule.meta.docs?.requiresTypeChecking,\n  () => 'error'\n);\n\nfunction writeConfig(\n  configName:\n    | 'all'\n    | 'recommended'\n    | 'strict'\n    | 'all-requiring-type-checking'\n    | 'recommended-requiring-type-checking'\n    | 'strict-requiring-type-checking'\n    | 'store'\n    | 'store-strict'\n    | 'effects'\n    | 'effects-requiring-type-checking'\n    | 'effects-strict'\n    | 'effects-strict-requiring-type-checking'\n    | 'component-store'\n    | 'component-store-strict',\n  predicate: (rule: NgRxRuleModule<[], string>) => boolean,\n  setting = (rule: NgRxRuleModule<[], string>) =>\n    rule.meta.docs?.recommended || 'warn'\n) {\n  const rulesForConfig = Object.entries(rules).filter(([_, rule]) =>\n    predicate(rule)\n  );\n  const configRules = rulesForConfig.reduce<Record<string, string>>(\n    (rules, [ruleName, rule]) => {\n      rules[`${RULE_MODULE}/${ruleName}`] = setting(rule);\n      return rules;\n    },\n    {}\n  );\n  const parserOptions: null | Record<string, string | number> =\n    rulesForConfig.some(([_, rule]) => rule.meta.docs?.requiresTypeChecking)\n      ? {\n          ecmaVersion: 2020,\n          sourceType: 'module',\n          project: './tsconfig.json',\n        }\n      : null;\n\n  const code = `\n/**\n * DO NOT EDIT\n * This file is generated\n */\n\nexport = {\n  parser: \"@typescript-eslint/parser\",\n  ${parserOptions ? `parserOptions: ${JSON.stringify(parserOptions)},` : ''}\n  plugins: [\"${RULE_MODULE}\"],\n  rules: ${JSON.stringify(configRules)},\n}\n`;\n  const config = format(code, {\n    parser: 'typescript',\n    ...prettierConfig,\n  });\n  writeFileSync(join(CONFIG_DIRECTORY, `${configName}.ts`), config);\n}\n"]}

package/scripts/generate-docs.js

@@ -0,0 +1,90 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var e_1, _a;
+var _b, _c, _d;
+exports.__esModule = true;
+var fs_1 = require("fs");
+var path = __importStar(require("path"));
+var prettier_1 = require("prettier");
+var rules_1 = require("../src/rules");
+var prettierConfig = prettier_1.resolveConfig.sync(__dirname);
+var PLACEHOLDER = '<!-- MANUAL-DOC:START -->';
+var RULES_PATH = './projects/ngrx.io/content/guide/eslint-plugin/rules';
+try {
+    for (var _e = __values(Object.entries(rules_1.rules)), _f = _e.next(); !_f.done; _f = _e.next()) {
+        var _g = __read(_f.value, 2), ruleName = _g[0], meta = _g[1].meta;
+        var docPath = path.join(RULES_PATH, "".concat(ruleName, ".md"));
+        var doc = (0, fs_1.readFileSync)(docPath, 'utf-8');
+        var docContent = doc.substring(doc.indexOf(PLACEHOLDER) + PLACEHOLDER.length);
+        var newDoc = (0, prettier_1.format)("# ".concat(ruleName, "\n\n").concat(meta.version ? '> Required NgRx Version Range: ${meta.version}' : '', " \n\n").concat((_b = meta.docs) === null || _b === void 0 ? void 0 : _b.description, "\n\n- **Type**: ").concat(meta.type, "\n- **Recommended**: ").concat(((_c = meta.docs) === null || _c === void 0 ? void 0 : _c.recommended) ? 'Yes' : 'No', "\n- **Fixable**: ").concat(meta.fixable ? 'Yes' : 'No', "\n- **Suggestion**: ").concat(meta.hasSuggestions ? 'Yes' : 'No', "\n- **Requires type checking**: ").concat(((_d = meta.docs) === null || _d === void 0 ? void 0 : _d.requiresTypeChecking) ? 'Yes' : 'No', "\n- **Configurable**: ").concat(meta.schema.length ? 'Yes' : 'No', "\n\n<!-- Everything above this generated, do not edit -->\n<!-- MANUAL-DOC:START -->\n\n").concat(docContent), __assign({ parser: 'markdown' }, prettierConfig));
+        (0, fs_1.writeFileSync)(docPath, newDoc);
+    }
+}
+catch (e_1_1) { e_1 = { error: e_1_1 }; }
+finally {
+    try {
+        if (_f && !_f.done && (_a = _e["return"])) _a.call(_e);
+    }
+    finally { if (e_1) throw e_1.error; }
+}
+//# sourceMappingURL=generate-docs.js.map

package/scripts/generate-docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-docs.js","sourceRoot":"","sources":["../../../../modules/eslint-plugin/scripts/generate-docs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yBAAiD;AACjD,yCAA6B;AAC7B,qCAAiD;AACjD,sCAAqC;AAErC,IAAM,cAAc,GAAG,wBAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACrD,IAAM,WAAW,GAAG,2BAA2B,CAAC;AAChD,IAAM,UAAU,GAAG,sDAAsD,CAAC;;IAE1E,KAAmC,IAAA,KAAA,SAAA,MAAM,CAAC,OAAO,CAAC,aAAK,CAAC,CAAA,gBAAA,4BAAE;QAA/C,IAAA,KAAA,mBAAoB,EAAnB,QAAQ,QAAA,EAAI,IAAI,aAAA;QAC1B,IAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAG,QAAQ,QAAK,CAAC,CAAC;QACxD,IAAM,GAAG,GAAG,IAAA,iBAAY,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC3C,IAAM,UAAU,GAAG,GAAG,CAAC,SAAS,CAC9B,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,MAAM,CAC9C,CAAC;QACF,IAAM,MAAM,GAAG,IAAA,iBAAM,EACnB,YAAK,QAAQ,iBAEf,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,gDAAgD,CAAC,CAAC,CAAC,EAAE,kBAEpE,MAAA,IAAI,CAAC,IAAI,0CAAE,WAAW,6BAEV,IAAI,CAAC,IAAI,kCACF,CAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,WAAW,EAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,8BACzC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,iCACxB,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,6CACtB,CAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,oBAAoB,EAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,mCACxD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,qGAKrD,UAAU,CAAE,aAER,MAAM,EAAE,UAAU,IACf,cAAc,EAEpB,CAAC;QAEF,IAAA,kBAAa,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;KAChC","sourcesContent":["import { readFileSync, writeFileSync } from 'fs';\nimport * as path from 'path';\nimport { format, resolveConfig } from 'prettier';\nimport { rules } from '../src/rules';\n\nconst prettierConfig = resolveConfig.sync(__dirname);\nconst PLACEHOLDER = '<!-- MANUAL-DOC:START -->';\nconst RULES_PATH = './projects/ngrx.io/content/guide/eslint-plugin/rules';\n\nfor (const [ruleName, { meta }] of Object.entries(rules)) {\n  const docPath = path.join(RULES_PATH, `${ruleName}.md`);\n  const doc = readFileSync(docPath, 'utf-8');\n  const docContent = doc.substring(\n    doc.indexOf(PLACEHOLDER) + PLACEHOLDER.length\n  );\n  const newDoc = format(\n    `# ${ruleName}\n\n${meta.version ? '> Required NgRx Version Range: ${meta.version}' : ''} \n\n${meta.docs?.description}\n\n- **Type**: ${meta.type}\n- **Recommended**: ${meta.docs?.recommended ? 'Yes' : 'No'}\n- **Fixable**: ${meta.fixable ? 'Yes' : 'No'}\n- **Suggestion**: ${meta.hasSuggestions ? 'Yes' : 'No'}\n- **Requires type checking**: ${meta.docs?.requiresTypeChecking ? 'Yes' : 'No'}\n- **Configurable**: ${meta.schema.length ? 'Yes' : 'No'}\n\n<!-- Everything above this generated, do not edit -->\n<!-- MANUAL-DOC:START -->\n\n${docContent}`,\n    {\n      parser: 'markdown',\n      ...prettierConfig,\n    }\n  );\n\n  writeFileSync(docPath, newDoc);\n}\n"]}

package/scripts/generate-overview.js

@@ -0,0 +1,98 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+exports.__esModule = true;
+var fs_1 = require("fs");
+var os_1 = require("os");
+var prettier_1 = require("prettier");
+var rules_1 = require("../src/rules");
+var configs_1 = require("../src/configs");
+var prettierConfig = prettier_1.resolveConfig.sync(__dirname);
+var OVERVIEW = './projects/ngrx.io/content/guide/eslint-plugin/index.md';
+var GH_CONFIGS = 'https://github.com/ngrx/platform/blob/master/modules/eslint-plugin/src/configs';
+generateRules();
+generateConfigurations();
+function generateRules() {
+    var moduleRules = Object.entries(rules_1.rules).reduce(function (all, _a) {
+        var _b, _c, _d, _e, _f, _g;
+        var _h = __read(_a, 2), ruleName = _h[0], meta = _h[1].meta;
+        all[meta.ngrxModule] = ((_b = all[meta.ngrxModule]) !== null && _b !== void 0 ? _b : []).concat([
+            [
+                "[@ngrx/".concat(ruleName, "]").concat(((_c = meta.docs) === null || _c === void 0 ? void 0 : _c.url)
+                    ? '(' +
+                        meta.docs.url
+                            .replace('https://ngrx.io', '')
+                            .replace('.md', '') +
+                        ')'
+                    : ''),
+                (_e = (_d = meta.docs) === null || _d === void 0 ? void 0 : _d.description) !== null && _e !== void 0 ? _e : 'TODO',
+                meta.type,
+                "".concat((_f = meta.docs) === null || _f === void 0 ? void 0 : _f.recommended),
+                meta.fixable ? 'Yes' : 'No',
+                meta.hasSuggestions ? 'Yes' : 'No',
+                meta.schema.length ? 'Yes' : 'No',
+                ((_g = meta.docs) === null || _g === void 0 ? void 0 : _g.requiresTypeChecking) ? 'Yes' : 'No',
+            ],
+        ]);
+        return all;
+    }, {});
+    var tableHeader = "| Name | Description | Recommended | Category | Fixable | Has suggestions | Configurable | Requires type information\n| --- | --- | --- | --- | --- | --- | --- | --- |";
+    var configTable = Object.entries(moduleRules).map(function (_a) {
+        var _b = __read(_a, 2), ngrxModule = _b[0], pluginRules = _b[1];
+        var tableBody = pluginRules
+            .map(function (rule) { return "|".concat(rule.join('|'), "|"); })
+            .join(os_1.EOL);
+        var table = [tableHeader, tableBody].join(os_1.EOL);
+        return ["### ".concat(ngrxModule), table].join(os_1.EOL);
+    });
+    var overview = (0, fs_1.readFileSync)(OVERVIEW, 'utf-8');
+    var start = overview.indexOf('<!-- RULES-CONFIG:START -->');
+    var end = overview.indexOf('<!-- RULES-CONFIG:END -->');
+    var newOverview = (0, prettier_1.format)("".concat(overview.substring(0, start + '<!-- RULES-CONFIG:START -->'.length), "\n").concat(configTable.join(os_1.EOL), "\n").concat(overview.substring(end)), __assign({ parser: 'markdown' }, prettierConfig));
+    (0, fs_1.writeFileSync)(OVERVIEW, newOverview);
+}
+function generateConfigurations() {
+    var tableHeader = "| Name |\n  | --- |";
+    var config = Object.keys(configs_1.configs);
+    var overview = (0, fs_1.readFileSync)(OVERVIEW, 'utf-8');
+    var start = overview.indexOf('<!-- CONFIGURATIONS-CONFIG:START -->');
+    var end = overview.indexOf('<!-- CONFIGURATIONS-CONFIG:END -->');
+    var configTable = config.map(function (configName) { return "| [".concat(configName, "](").concat(GH_CONFIGS, "/").concat(configName, ".ts) |"); });
+    var newOverview = (0, prettier_1.format)("".concat(overview.substring(0, start + '<!-- CONFIGURATIONS-CONFIG:START -->'.length), "\n  ").concat(__spreadArray([tableHeader], __read(configTable), false).join(os_1.EOL), "\n  ").concat(overview.substring(end)), __assign({ parser: 'markdown' }, prettierConfig));
+    (0, fs_1.writeFileSync)(OVERVIEW, newOverview);
+}
+//# sourceMappingURL=generate-overview.js.map

package/scripts/generate-overview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-overview.js","sourceRoot":"","sources":["../../../../modules/eslint-plugin/scripts/generate-overview.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yBAAiD;AACjD,yBAAyB;AACzB,qCAAiD;AACjD,sCAAqC;AACrC,0CAAyC;AAEzC,IAAM,cAAc,GAAG,wBAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACrD,IAAM,QAAQ,GAAG,yDAAyD,CAAC;AAC3E,IAAM,UAAU,GACd,gFAAgF,CAAC;AAEnF,aAAa,EAAE,CAAC;AAChB,sBAAsB,EAAE,CAAC;AAEzB,SAAS,aAAa;IACpB,IAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,aAAK,CAAC,CAAC,MAAM,CAC9C,UAAC,GAAG,EAAE,EAAoB;;YAApB,KAAA,aAAoB,EAAnB,QAAQ,QAAA,EAAI,IAAI,aAAA;QACrB,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAA,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,mCAAI,EAAE,CAAC,CAAC,MAAM,CAAC;YACzD;gBACE,iBAAU,QAAQ,cAChB,CAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,GAAG;oBACZ,CAAC,CAAC,GAAG;wBACH,IAAI,CAAC,IAAI,CAAC,GAAG;6BACV,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC;6BAC9B,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;wBACrB,GAAG;oBACL,CAAC,CAAC,EAAE,CACN;gBACF,MAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,WAAW,mCAAI,MAAM;gBAChC,IAAI,CAAC,IAAI;gBACT,UAAG,MAAA,IAAI,CAAC,IAAI,0CAAE,WAAW,CAAE;gBAC3B,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;gBAC3B,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;gBAClC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;gBACjC,CAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,oBAAoB,EAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;aAC/C;SACF,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAE,CACH,CAAC;IAEF,IAAM,WAAW,GAAG,yKAC4B,CAAC;IAEjD,IAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CACjD,UAAC,EAAyB;YAAzB,KAAA,aAAyB,EAAxB,UAAU,QAAA,EAAE,WAAW,QAAA;QACvB,IAAM,SAAS,GAAG,WAAW;aAC1B,GAAG,CAAC,UAAC,IAAI,IAAK,OAAA,WAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAG,EAArB,CAAqB,CAAC;aACpC,IAAI,CAAC,QAAG,CAAC,CAAC;QACb,IAAM,KAAK,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,QAAG,CAAC,CAAC;QAEjD,OAAO,CAAC,cAAO,UAAU,CAAE,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,QAAG,CAAC,CAAC;IAChD,CAAC,CACF,CAAC;IAEF,IAAM,QAAQ,GAAG,IAAA,iBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACjD,IAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;IAC9D,IAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAE1D,IAAM,WAAW,GAAG,IAAA,iBAAM,EACxB,UAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,GAAG,6BAA6B,CAAC,MAAM,CAAC,eACxE,WAAW,CAAC,IAAI,CAAC,QAAG,CAAC,eACrB,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAE,aAErB,MAAM,EAAE,UAAU,IACf,cAAc,EAEpB,CAAC;IAEF,IAAA,kBAAa,EAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,sBAAsB;IAC7B,IAAM,WAAW,GAAG,qBACZ,CAAC;IAET,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAO,CAAC,CAAC;IAEpC,IAAM,QAAQ,GAAG,IAAA,iBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACjD,IAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAAC;IACvE,IAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;IAEnE,IAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAC5B,UAAC,UAAU,IAAK,OAAA,aAAM,UAAU,eAAK,UAAU,cAAI,UAAU,WAAQ,EAArD,CAAqD,CACtE,CAAC;IACF,IAAM,WAAW,GAAG,IAAA,iBAAM,EACxB,UAAG,QAAQ,CAAC,SAAS,CACnB,CAAC,EACD,KAAK,GAAG,sCAAsC,CAAC,MAAM,CACtD,iBACD,eAAC,WAAW,UAAK,WAAW,UAAE,IAAI,CAAC,QAAG,CAAC,iBACvC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAE,aAEvB,MAAM,EAAE,UAAU,IACf,cAAc,EAEpB,CAAC;IAEF,IAAA,kBAAa,EAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AACvC,CAAC","sourcesContent":["import { readFileSync, writeFileSync } from 'fs';\nimport { EOL } from 'os';\nimport { format, resolveConfig } from 'prettier';\nimport { rules } from '../src/rules';\nimport { configs } from '../src/configs';\n\nconst prettierConfig = resolveConfig.sync(__dirname);\nconst OVERVIEW = './projects/ngrx.io/content/guide/eslint-plugin/index.md';\nconst GH_CONFIGS =\n  'https://github.com/ngrx/platform/blob/master/modules/eslint-plugin/src/configs';\n\ngenerateRules();\ngenerateConfigurations();\n\nfunction generateRules() {\n  const moduleRules = Object.entries(rules).reduce<Record<string, string[][]>>(\n    (all, [ruleName, { meta }]) => {\n      all[meta.ngrxModule] = (all[meta.ngrxModule] ?? []).concat([\n        [\n          `[@ngrx/${ruleName}]${\n            meta.docs?.url\n              ? '(' +\n                meta.docs.url\n                  .replace('https://ngrx.io', '')\n                  .replace('.md', '') +\n                ')'\n              : ''\n          }`,\n          meta.docs?.description ?? 'TODO',\n          meta.type,\n          `${meta.docs?.recommended}`,\n          meta.fixable ? 'Yes' : 'No',\n          meta.hasSuggestions ? 'Yes' : 'No',\n          meta.schema.length ? 'Yes' : 'No',\n          meta.docs?.requiresTypeChecking ? 'Yes' : 'No',\n        ],\n      ]);\n      return all;\n    },\n    {}\n  );\n\n  const tableHeader = `| Name | Description | Recommended | Category | Fixable | Has suggestions | Configurable | Requires type information\n| --- | --- | --- | --- | --- | --- | --- | --- |`;\n\n  const configTable = Object.entries(moduleRules).map(\n    ([ngrxModule, pluginRules]) => {\n      const tableBody = pluginRules\n        .map((rule) => `|${rule.join('|')}|`)\n        .join(EOL);\n      const table = [tableHeader, tableBody].join(EOL);\n\n      return [`### ${ngrxModule}`, table].join(EOL);\n    }\n  );\n\n  const overview = readFileSync(OVERVIEW, 'utf-8');\n  const start = overview.indexOf('<!-- RULES-CONFIG:START -->');\n  const end = overview.indexOf('<!-- RULES-CONFIG:END -->');\n\n  const newOverview = format(\n    `${overview.substring(0, start + '<!-- RULES-CONFIG:START -->'.length)}\n${configTable.join(EOL)}\n${overview.substring(end)}`,\n    {\n      parser: 'markdown',\n      ...prettierConfig,\n    }\n  );\n\n  writeFileSync(OVERVIEW, newOverview);\n}\n\nfunction generateConfigurations() {\n  const tableHeader = `| Name |\n  | --- |`;\n\n  const config = Object.keys(configs);\n\n  const overview = readFileSync(OVERVIEW, 'utf-8');\n  const start = overview.indexOf('<!-- CONFIGURATIONS-CONFIG:START -->');\n  const end = overview.indexOf('<!-- CONFIGURATIONS-CONFIG:END -->');\n\n  const configTable = config.map(\n    (configName) => `| [${configName}](${GH_CONFIGS}/${configName}.ts) |`\n  );\n  const newOverview = format(\n    `${overview.substring(\n      0,\n      start + '<!-- CONFIGURATIONS-CONFIG:START -->'.length\n    )}\n  ${[tableHeader, ...configTable].join(EOL)}\n  ${overview.substring(end)}`,\n    {\n      parser: 'markdown',\n      ...prettierConfig,\n    }\n  );\n\n  writeFileSync(OVERVIEW, newOverview);\n}\n"]}

package/spec/utils/index.js

@@ -0,0 +1,22 @@
+"use strict";
+exports.__esModule = true;
+exports.ruleTester = void 0;
+var experimental_utils_1 = require("@typescript-eslint/experimental-utils");
+var path_1 = require("path");
+var utils_1 = require("../../src/utils");
+function ruleTester(environment) {
+    (0, utils_1.clearCache)();
+    if (environment) {
+        (0, utils_1.setNgrxVersion)(environment.ngrxModule, environment.version);
+    }
+    return new experimental_utils_1.TSESLint.RuleTester({
+        parser: (0, path_1.resolve)('./node_modules/@typescript-eslint/parser'),
+        parserOptions: {
+            project: (0, path_1.resolve)('./modules/eslint-plugin/spec/tsconfig.json'),
+            ecmaVersion: 2020,
+            sourceType: 'module'
+        }
+    });
+}
+exports.ruleTester = ruleTester;
+//# sourceMappingURL=index.js.map

package/spec/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../modules/eslint-plugin/spec/utils/index.ts"],"names":[],"mappings":";;;AAAA,4EAAiE;AACjE,6BAA+B;AAC/B,yCAA6D;AAE7D,SAAgB,UAAU,CAAC,WAG1B;IACC,IAAA,kBAAU,GAAE,CAAC;IAEb,IAAI,WAAW,EAAE;QACf,IAAA,sBAAc,EAAC,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;KAC7D;IAED,OAAO,IAAI,6BAAQ,CAAC,UAAU,CAAC;QAC7B,MAAM,EAAE,IAAA,cAAO,EAAC,0CAA0C,CAAC;QAC3D,aAAa,EAAE;YACb,OAAO,EAAE,IAAA,cAAO,EAAC,4CAA4C,CAAC;YAC9D,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,QAAQ;SACrB;KACF,CAAC,CAAC;AACL,CAAC;AAlBD,gCAkBC","sourcesContent":["import { TSESLint } from '@typescript-eslint/experimental-utils';\nimport { resolve } from 'path';\nimport { clearCache, setNgrxVersion } from '../../src/utils';\n\nexport function ruleTester(environment?: {\n  ngrxModule: string;\n  version: string;\n}) {\n  clearCache();\n\n  if (environment) {\n    setNgrxVersion(environment.ngrxModule, environment.version);\n  }\n\n  return new TSESLint.RuleTester({\n    parser: resolve('./node_modules/@typescript-eslint/parser'),\n    parserOptions: {\n      project: resolve('./modules/eslint-plugin/spec/tsconfig.json'),\n      ecmaVersion: 2020,\n      sourceType: 'module',\n    },\n  });\n}\n"]}