@blumintinc/eslint-plugin-blumint 1.0.2 → 1.0.4

package/lib/utils/graph/ClassGraphSorterReadability.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClassGraphSorterReadability = void 0;
+const ClassGraphSorter_1 = require("./ClassGraphSorter");
+class ClassGraphSorterReadability extends ClassGraphSorter_1.ClassGraphSorter {
+    constructor(graph) {
+        super(graph);
+        this.graph = graph;
+    }
+    get nodeNamesSorted() {
+        return this.nodesSorted.map((node) => node.name);
+    }
+    get nodesSorted() {
+        return this.sortNodes();
+    }
+    sortNodes() {
+        const { methods, properties, classConstructor } = this.groupNodesByType();
+        const [propertiesSorted, methodsSorted] = [properties, methods].map((nodeGroup) => nodeGroup.sort(ClassGraphSorterReadability.sortMembersForReadability));
+        const searchNodeCandidates = [classConstructor, ...methodsSorted].filter((node) => !!node);
+        const searchNodeCandidatesValidated = searchNodeCandidates.filter((method, _index, arr) => ClassGraphSorterReadability.SEARCH_NODE_PRIORITY_FUNCTIONS.some((fn) => !!fn(method, arr)));
+        const searchNodesSorted = searchNodeCandidatesValidated.sort((a, b) => {
+            const getPriority = (method) => {
+                const priority = ClassGraphSorterReadability.SEARCH_NODE_PRIORITY_FUNCTIONS.findIndex((fn) => !!fn(method, methodsSorted));
+                return priority === -1
+                    ? ClassGraphSorterReadability.SEARCH_NODE_PRIORITY_FUNCTIONS.length
+                    : priority;
+            };
+            return getPriority(a) - getPriority(b);
+        });
+        const dfsSortedNodes = this.dependencyDfs(searchNodesSorted);
+        return [...propertiesSorted, ...dfsSortedNodes];
+    }
+    groupNodesByType() {
+        const nodes = Object.values(this.graph);
+        return nodes.reduce((acc, node) => {
+            switch (node.type) {
+                case 'property':
+                    acc.properties.push(node);
+                    break;
+                case 'constructor':
+                    acc.classConstructor = node;
+                    break;
+                case 'method':
+                    acc.methods.push(node);
+                    break;
+            }
+            return acc;
+        }, {
+            properties: [],
+            methods: [],
+            classConstructor: null,
+        });
+    }
+    static sortMembersForReadability(a, b) {
+        // NOTE: the ordering from Object.entries is safe here since it is readonly
+        for (const [key, priorities] of Object.entries(ClassGraphSorterReadability.MODIFIER_PRIORITY_MAP)) {
+            const indexA = priorities.indexOf(a[key]);
+            const indexB = priorities.indexOf(b[key]);
+            if (indexA !== indexB) {
+                return indexA - indexB;
+            }
+        }
+        return 0;
+    }
+    dependencyDfs(searchNodes) {
+        const visited = new Set();
+        const dfsSortedNodes = [];
+        const dfs = (node) => {
+            if (visited.has(node.name) || !node) {
+                return;
+            }
+            visited.add(node.name);
+            dfsSortedNodes.push(node);
+            for (const dep of node.dependencies) {
+                dfs(this.graph[String(dep)]);
+            }
+        };
+        searchNodes.forEach((node) => dfs(node));
+        return dfsSortedNodes;
+    }
+}
+exports.ClassGraphSorterReadability = ClassGraphSorterReadability;
+ClassGraphSorterReadability.MODIFIER_PRIORITY_MAP = {
+    isStatic: [true, false],
+    accessibility: ['public', undefined, 'private'],
+};
+ClassGraphSorterReadability.SEARCH_NODE_PRIORITY_FUNCTIONS = [
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    (method, _methods) => method.type === 'constructor',
+    (method, _methods) => !_methods.some((node) => node.dependencies.includes(method.name)),
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    (method, _methods) => method.dependencies.length === 0,
+];
+//# sourceMappingURL=ClassGraphSorterReadability.js.map

package/lib/utils/ruleTester.d.ts

@@ -0,0 +1,5 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { RuleTester } from 'eslint';
+export declare const ruleTesterTs: ESLintUtils.RuleTester;
+export declare const ruleTesterJsx: ESLintUtils.RuleTester;
+export declare const ruleTesterJson: RuleTester;

package/lib/utils/ruleTester.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ruleTesterJson = exports.ruleTesterJsx = exports.ruleTesterTs = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+const eslint_1 = require("eslint");
+exports.ruleTesterTs = new utils_1.ESLintUtils.RuleTester({
+    parser: '@typescript-eslint/parser',
+});
+exports.ruleTesterJsx = new utils_1.ESLintUtils.RuleTester({
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        ecmaFeatures: {
+            jsx: true,
+        },
+    },
+});
+exports.ruleTesterJson = new eslint_1.RuleTester({
+    parser: require.resolve('jsonc-eslint-parser'),
+    parserOptions: {
+        ecmaVersion: 2020,
+    },
+});
+//# sourceMappingURL=ruleTester.js.map

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@blumintinc/eslint-plugin-blumint",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Custom eslint rules for use within BluMint",
   "author": {
     "name": "Brodie McGuire",
     "email": "brodie@blumint.io"
   },
+  "main": "lib/index.js",
+  "exports": "./lib/index.js",
   "publishConfig": {
     "access": "public"
   },
@@ -24,23 +26,28 @@
   ],
   "private": false,
   "scripts": {
-    "lint-ts": "tsc && eslint ./**/*",
-    "lint-md": "remark .",
-    "lint-shell": "shellcheck .devcontainer/git-flow-completion.bash",
-    "lint": "npm run lint-ts && npm run lint-md && npm run lint-shell",
+    "lint": "npm-run-all \"lint:*\"",
+    "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
+    "lint:js": "eslint ./src",
+    "lint:md": "remark .",
+    "lint:shell": "shellcheck .devcontainer/git-flow-completion.bash",
     "lint:fix": "tsc && eslint ./**/* --quiet --fix",
     "test": "jest --passWithNoTests --reporters=default --reporters=jest-junit",
-    "test:ci": "jest --ci  --passWithNoTests --reporters=default --reporters=jest-junit",
-    "version": "git add -A plugin/src",
+    "test:ci": "jest --ci --passWithNoTests --reporters=default --reporters=jest-junit",
+    "docs": "./scripts/make-docs.sh && npm run update:eslint-docs",
+    "update:eslint-docs": "eslint-doc-generator",
+    "build": "tsc",
+    "prepare": "npm run build",
+    "version": "git add -A src",
     "postversion": "git push && git push --tags",
-    "remove-hooks": "del-cli ./.husky/"
+    "remove-hooks": "del-cli ./.husky/",
+    "release:dry-run": "semantic-release --dry-run --no-ci",
+    "test:release": "node scripts/test-release.js"
   },
   "dependencies": {
-    "reflect-metadata": "0.1.13",
-    "typescript-memoize": "1.1.0"
+    "requireindex": "1.2.0"
   },
   "devDependencies": {
-    "@blumintinc/eslint-plugin-blumint": "file:plugin/lib",
     "@semantic-release/changelog": "6.0.1",
     "@semantic-release/commit-analyzer": "9.0.2",
     "@semantic-release/git": "10.0.1",
@@ -59,8 +66,11 @@
     "dotenv-cli": "5.0.0",
     "eslint": "8.11.0",
     "eslint-config-prettier": "8.5.0",
+    "eslint-doc-generator": "1.0.0",
     "eslint-import-resolver-typescript": "3.5.5",
+    "eslint-plugin-eslint-plugin": "5.0.0",
     "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-node": "11.1.0",
     "eslint-plugin-jsdoc": "44.0.0",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-security": "1.5.0",
@@ -68,6 +78,7 @@
     "jest": "29.3.1",
     "jest-junit": "14.0.0",
     "jsonc-eslint-parser": "2.3.0",
+    "npm-run-all": "4.1.5",
     "prettier": "2.7.1",
     "remark-cli": "10.0.1",
     "remark-lint": "9.1.1",
@@ -75,7 +86,15 @@
     "semantic-release": "19.0.3",
     "ts-jest": "29.0.5",
     "ts-node": "10.9.1",
-    "typescript": "4.9.5"
+    "typescript": "4.9.5",
+    "@types/jest": "^29.3.1",
+    "@semantic-release/exec": "^6.0.3"
+  },
+  "peerDependencies": {
+    "eslint": ">=7"
+  },
+  "engines": {
+    "node": "^20.0.0"
   },
   "config": {
     "commitizen": {
@@ -90,5 +109,6 @@
     "suiteNameTemplate": "{filepath}",
     "classNameTemplate": "{classname}",
     "titleTemplate": "{title}"
-  }
+  },
+  "license": "ISC"
 }

package/CHANGELOG.md

@@ -1,63 +0,0 @@
-## [1.0.2](https://github.com/BluMintInc/eslint-custom-rules/compare/v1.0.1...v1.0.2) (2024-11-13)
-
-
-### Bug Fixes
-
-* **package.json:** use public access ([6d78460](https://github.com/BluMintInc/eslint-custom-rules/commit/6d78460c8b28cd852229b0b59759d48620ab483d))
-
-## [1.0.1](https://github.com/BluMintInc/eslint-custom-rules/compare/v1.0.0...v1.0.1) (2024-11-13)
-
-
-### Bug Fixes
-
-* **package.json:** change package name ([8a44bd7](https://github.com/BluMintInc/eslint-custom-rules/commit/8a44bd74c8f4c908fea404a69a02c6ac8f1df407))
-* **package.json:** remove np char ([39ec15d](https://github.com/BluMintInc/eslint-custom-rules/commit/39ec15d21b76f79086dc245d487ee9f605fbf839))
-
-# 1.0.0 (2024-11-13)
-
-
-### Bug Fixes
-
-* **.releaserc.json:** update repo url to current repo ([e9b9139](https://github.com/BluMintInc/eslint-custom-rules/commit/e9b913904909639dd0faf44b1f210d4a2ae64f73))
-* **husky:** remove husky ([ad7ecb3](https://github.com/BluMintInc/eslint-custom-rules/commit/ad7ecb33522a991d026af04c3f19beb96c4fd5dc))
-* **package.json:** add back iun remove-hooks for github actions ([41b5ea1](https://github.com/BluMintInc/eslint-custom-rules/commit/41b5ea1d7d269d8568ddf23465e6cc8589ae91c5))
-* **package.json:** use plugin/src instead of src ([1d9d2f6](https://github.com/BluMintInc/eslint-custom-rules/commit/1d9d2f6410094a8a7402a2ca51645f7746c8c369))
-* **plugin/package-lock.json): only lint /src; fix(package.json:** upgrade engine to node v20 ([c654c8e](https://github.com/BluMintInc/eslint-custom-rules/commit/c654c8e6f0546e4f133fdca463b86f0d22e75c81))
-* **plugin:** typo for rule definition ([a1d33b9](https://github.com/BluMintInc/eslint-custom-rules/commit/a1d33b90428a989a56244218bc4115c2ba479327))
-* **release:** version to 0.1.24 ([78f4e28](https://github.com/BluMintInc/eslint-custom-rules/commit/78f4e281d2bc82e64403c053d514e75c23920915))
-* **require-memo:** detect exported functions ([06f19b4](https://github.com/BluMintInc/eslint-custom-rules/commit/06f19b48f7dbedf83d84b31a64ffdd3f05a8b41a))
-* **require-memo:** edge cases + additional tests ([908587b](https://github.com/BluMintInc/eslint-custom-rules/commit/908587beaf9020d60558f2b48916cf0bca140a34))
-* **require-memo:** use src/util/memo instead of React memo ([3a1de04](https://github.com/BluMintInc/eslint-custom-rules/commit/3a1de0416a2a2833a3c23220d7616063ff2ea493))
-* **setting.json:** codeActionsOnSave value change ([5557d2f](https://github.com/BluMintInc/eslint-custom-rules/commit/5557d2f2bdee222a03b4b4330d39f5a12b5e8684))
-
-
-### Features
-
-* **0.1.16:** release v0.1.16 ([bfe4b1a](https://github.com/BluMintInc/eslint-custom-rules/commit/bfe4b1a8d815c2367fad83e50e4245ddce0d95fc))
-* **0.1.17:** bump version ([eca598f](https://github.com/BluMintInc/eslint-custom-rules/commit/eca598fd863b48a4c4a1cd4a7770f3bf63c86669))
-* **actions:** upgrade actions to node v20 ([e3417fa](https://github.com/BluMintInc/eslint-custom-rules/commit/e3417faee3b2b0badffb58a041a5d01fe550d83d))
-* **array-methods-this-context:** implement rule + docs ([4db3cfb](https://github.com/BluMintInc/eslint-custom-rules/commit/4db3cfb74fc801e55af3009a547585afc462432a))
-* **ASTHelpers:** class with helpers for AST traversal ([e0c02ea](https://github.com/BluMintInc/eslint-custom-rules/commit/e0c02ea3f629ec06f8834d4ba88ed53610cf19f7))
-* **BLU-2402:** implement no-async-foreach ([1901988](https://github.com/BluMintInc/eslint-custom-rules/commit/1901988dbfec805fb8b9e99b88c1cd050a67e616))
-* **BLU-2406:** implement no-useless-fragment ([559ecea](https://github.com/BluMintInc/eslint-custom-rules/commit/559ecea7d4e37d24c194065eb07f625c4bd5c59c))
-* **class-methods-read-top-to-bottom:** implement rule ([80c5a37](https://github.com/BluMintInc/eslint-custom-rules/commit/80c5a37f5af0fac04ff847f463edb6999ce9ed5e))
-* **ClassGraphBuilder:** builds a graph of class member nodes & their dependencies ([cff1588](https://github.com/BluMintInc/eslint-custom-rules/commit/cff15884688893af253ecaa7fe246134b484f59a))
-* **ClassGraphSorter:** base class + configurable readability sorter ([536abd9](https://github.com/BluMintInc/eslint-custom-rules/commit/536abd930e8702698f725d98379445912818c4fd))
-* **Dockerfile:** upgrade to node v20 and npm 10.4.0 ([e936c60](https://github.com/BluMintInc/eslint-custom-rules/commit/e936c60850449269062322c96319b88a67fa9fab))
-* **dynamic-https-errors:** implement rule file & test suite ([c7e2266](https://github.com/BluMintInc/eslint-custom-rules/commit/c7e2266a2dedb6b8661fbdba1cf938c5753c67d4))
-* **dynamic-https-errors:** include in index ([85fd0ed](https://github.com/BluMintInc/eslint-custom-rules/commit/85fd0ed34b443d9c5deee02daf96003ff4c9f6c7))
-* **export-if-in-doubt:** implement rule, tests, docs ([3985661](https://github.com/BluMintInc/eslint-custom-rules/commit/39856610ca0089bf8aef3a14f4c506f0844176da))
-* **extract-global-constants:** implement rule, tests, docs ([96f425a](https://github.com/BluMintInc/eslint-custom-rules/commit/96f425a52bdbd2672a2cb0ac68b8964583784df5))
-* **generic-starts-with-t:** implement rule + docs ([2f5c8f3](https://github.com/BluMintInc/eslint-custom-rules/commit/2f5c8f360365c4e3a65b0bdc1b4eb4a49ef06fe5))
-* **no-async-array-filter:** implement rule ([47f77a4](https://github.com/BluMintInc/eslint-custom-rules/commit/47f77a43f779f58540ca4b382afa2a839f1a35b4))
-* **no-async-array-filter:** implement rule + docs ([9b67bc7](https://github.com/BluMintInc/eslint-custom-rules/commit/9b67bc7e29ebe4b75e7a9e71f5c4cf16f475778c))
-* **no-conditional-literals-in-jsx.ts:** implement new rule for conditional text ([9638f37](https://github.com/BluMintInc/eslint-custom-rules/commit/9638f376f593a1122c7e29d011e14d7b9a036292))
-* **no-filter-without-return:** implement rule + docs ([3106714](https://github.com/BluMintInc/eslint-custom-rules/commit/3106714e9413b0ba4080cacf8387e10de7325e26))
-* **no-misused-switch-case:** implement rule, tests, docs ([06c9768](https://github.com/BluMintInc/eslint-custom-rules/commit/06c9768bc560b88a6f125157c3bfd8ec8ff012f2))
-* **no-unpinned-dependencies:** implement rule ([b4f2f47](https://github.com/BluMintInc/eslint-custom-rules/commit/b4f2f47b597aeee6d76f338d8327d52b36a43948))
-* **prefer-fragment-shorthand:** implement rule + docs ([6088af1](https://github.com/BluMintInc/eslint-custom-rules/commit/6088af155fa0f65606db67da0b6f3f2c2bb10b31))
-* **prefer-type-over-interface:** implement rule + docs ([71c9f6e](https://github.com/BluMintInc/eslint-custom-rules/commit/71c9f6e32c56fdbb5c5eec9dcfa4c1c03d45547e))
-* **require-memo:** add autofix for `function` ([485c278](https://github.com/BluMintInc/eslint-custom-rules/commit/485c2784ff6c620173ddcf5f3ec431346ccaacd6))
-* **scripts:** implement make-docs util script ([4ad01ef](https://github.com/BluMintInc/eslint-custom-rules/commit/4ad01eff771baa1487957b22f12e253b71a948e0))
-* **v0.1.15:** include require-memo rule ([84abe13](https://github.com/BluMintInc/eslint-custom-rules/commit/84abe136bf05e1a98878f3b24b086638c4bf823e))
-* **v0.1.1:** update readme for release ([1e1df2a](https://github.com/BluMintInc/eslint-custom-rules/commit/1e1df2a5e969a2a86353e74c641b8e484b2aa7cf))

package/assets/logo.svg

@@ -1,26 +0,0 @@
-<svg width="283" height="459" viewBox="0 0 283 459" fill="none" xmlns="http://www.w3.org/2000/svg">
-  <path d="M68.1796 0.729006L96.9887 19.0694C97.3939 19.3478 97.7274 19.7321 97.9583 20.1866C98.1892 20.6411 98.3099 21.1511 98.3094 21.6694C98.3335 36.063 98.4877 135.258 98.5263 159.755C98.5275 160.233 98.6318 160.704 98.8311 161.13C99.0303 161.556 99.3189 161.927 99.6739 162.212C100.029 162.497 100.441 162.689 100.877 162.773C101.312 162.856 101.76 162.829 102.185 162.693C163.751 143.49 234.07 173.041 265.52 232.165C283.961 266.829 286.998 312.058 275.006 350.205C273.83 353.949 272.861 361.094 270.224 363.944C264.883 372.832 259.022 381.342 252.675 389.424C252.675 389.424 241.521 403.641 231.071 413.474C212.476 430.982 161.567 451.725 111.507 432.381C101.481 428.476 27.9277 352.327 16.9719 340.934C16.567 340.512 16.2866 339.971 16.1657 339.378C16.0448 338.785 16.0888 338.167 16.2923 337.601L34.4829 287.202C34.6497 286.743 34.9162 286.334 35.2601 286.009C35.604 285.684 36.0152 285.453 36.4591 285.335L80.8658 273.485C81.2855 273.372 81.7236 273.363 82.1467 273.46C82.5699 273.557 82.967 273.757 83.308 274.044C83.6489 274.331 83.9248 274.698 84.1147 275.118C84.3045 275.537 84.4034 275.997 84.4037 276.464L84.4278 290.156V290.457C84.7073 293.416 89.6093 337.777 131.404 345.848C174.639 354.168 191.938 334.054 200.575 315.339C208.538 298.091 172.619 245.405 166.97 237.267C166.736 236.931 166.441 236.651 166.103 236.443C165.765 236.236 165.391 236.105 165.004 236.06L54.5534 222.904C53.8171 222.817 53.1411 222.425 52.6687 221.809C52.1963 221.194 51.9647 220.404 52.0229 219.607L68.1796 0.729006Z" fill="url(#paint0_linear_3084_32866)" />
-  <path d="M103.119 402.374C80.9466 385.038 66.3468 351.238 71.1235 321.384C75.553 293.726 97.0165 270.18 122.64 264.47C124.572 264.036 126.526 263.72 128.491 263.524L128.896 263.482C136.969 262.791 145.088 263.883 152.755 266.693C160.423 269.504 167.479 273.972 173.491 279.826C185.112 291.266 192.978 306.289 196.665 322.788C196.699 322.95 196.916 323.022 196.993 322.882C207.635 303.788 212.899 283.138 208.898 260.789C205.605 242.776 196.897 226.438 184.124 214.306C171.722 202.596 156.004 195.451 139.833 192.029C116.807 187.152 89.9697 189.278 69.3786 202.362C69.2563 202.44 69.117 202.481 68.9749 202.482C68.8328 202.484 68.6929 202.444 68.5695 202.368C68.4462 202.292 68.3436 202.182 68.2724 202.049C68.2012 201.917 68.1638 201.766 68.164 201.613L68.2845 0.892842C68.2852 0.864877 68.2805 0.837058 68.2708 0.811136C68.261 0.785213 68.2464 0.761745 68.2278 0.74221C68.2093 0.722674 68.1872 0.707493 68.1629 0.69762C68.1386 0.687747 68.1128 0.683396 68.0869 0.684841L6.93071 0.91364C6.05178 0.915 5.18174 1.10346 4.37045 1.46821C3.55915 1.83297 2.82255 2.36686 2.20285 3.03928C1.58315 3.7117 1.09253 4.50944 0.759112 5.38679C0.425692 6.26413 0.256022 7.20383 0.259828 8.15204C0.259828 19.7792 0.298389 30.8396 0.312849 42.472C0.356229 70.032 0.399603 94.3108 0.442983 121.897L0.712902 300.012C0.751462 325.711 -0.106498 352.824 9.3889 376.972C16.831 395.926 28.6689 412.499 43.4326 425.504C68.0483 447.198 99.8265 458.638 131.489 458.95C241.867 460.51 268.811 372.11 271.438 361.981C271.447 361.935 271.442 361.887 271.423 361.845C271.404 361.803 271.373 361.769 271.334 361.749C271.295 361.728 271.251 361.723 271.208 361.733C271.166 361.743 271.128 361.768 271.1 361.804C221.633 441.905 136.406 428.4 103.119 402.374Z" fill="url(#paint1_linear_3084_32866)" />
-  <defs>
-    <linearGradient id="paint0_linear_3084_32866" x1="0.0485188" y1="230.006" x2="282.008" y2="229.588" gradientUnits="userSpaceOnUse">
-      <stop stop-color="#007EFF" />
-      <stop offset="0.04" stop-color="#0D8AFF" />
-      <stop offset="0.17" stop-color="#32AEFF" />
-      <stop offset="0.28" stop-color="#49C4FF" />
-      <stop offset="0.35" stop-color="#51CCFF" />
-      <stop offset="0.48" stop-color="#4CA7FF" />
-      <stop offset="0.63" stop-color="#4681FF" />
-      <stop offset="0.78" stop-color="#4265FF" />
-      <stop offset="0.9" stop-color="#4055FF" />
-      <stop offset="1" stop-color="#3F4FFF" />
-    </linearGradient>
-    <linearGradient id="paint1_linear_3084_32866" x1="0.565232" y1="230.022" x2="271.222" y2="229.628" gradientUnits="userSpaceOnUse">
-      <stop stop-color="#3200FF" />
-      <stop offset="0.41" stop-color="#0064E9" />
-      <stop offset="0.5" stop-color="#0D76ED" />
-      <stop offset="0.72" stop-color="#2BA1F7" />
-      <stop offset="0.9" stop-color="#3EBCFD" />
-      <stop offset="1" stop-color="#45C6FF" />
-    </linearGradient>
-  </defs>
-</svg>

package/jest.config.js

@@ -1,13 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  verbose: true,
-  reporters: ['default', 'jest-junit'],
-  testEnvironment: 'node',
-  roots: ['<rootDir>'],
-  testPathIgnorePatterns: ['<rootDir>/node_modules/'],
-  moduleNameMapper: {
-    '^src/(.*)$': '<rootDir>/src/$1',
-  },
-};

package/plugin/README.md

@@ -1,80 +0,0 @@
-# @blumintinc/eslint-plugin-blumint
-
-Custom eslint rules for use at BluMint
-
-## Installation
-
-You'll first need to install [ESLint](https://eslint.org/):
-
-```sh
-npm i eslint --save-dev
-```
-
-Next, install `@blumintinc/eslint-plugin-blumint`:
-
-```sh
-npm install @blumintinc/eslint-plugin-blumint --save-dev
-```
-
-## Usage
-
-Add `@blumintinc/blumint` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
-
-```json
-{
-    "plugins": [
-        "@blumintinc/blumint"
-    ]
-}
-```
-
-
-Then configure the rules you want to use under the rules section.
-
-```json
-{
-    "rules": {
-        "blumint/rule-name": "error"
-    }
-}
-```
-
-Or use the recommended config:
-
-```json
-{
-    "extends": ["some-other-plugin", "plugin:@blumintinc/blumint/recommended"]
-}
-```
-
-## Rules
-
-<!-- begin auto-generated rules list -->
-
-💼 Configurations enabled in.\
-⚠️ Configurations set to warn in.\
-✅ Set in the `recommended` configuration.\
-🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
-
-| Name                                                                               | Description                                                                                                                                     | 💼 | ⚠️ | 🔧 |
-| :--------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------- | :- | :- | :- |
-| [array-methods-this-context](docs/rules/array-methods-this-context.md)             | Prevent misuse of Array methods in OOP                                                                                                          |    | ✅  |    |
-| [class-methods-read-top-to-bottom](docs/rules/class-methods-read-top-to-bottom.md) | Ensures classes read linearly from top to bottom.                                                                                               |    | ✅  | 🔧 |
-| [dynamic-https-errors](docs/rules/dynamic-https-errors.md)                         | Dynamic error details should only be in the third argument of the HttpsError constructor. The second argument is hashed to produce a unique id. |    | ✅  |    |
-| [export-if-in-doubt](docs/rules/export-if-in-doubt.md)                             | All top-level const definitions, type definitions, and functions should be exported                                                             |    |    |    |
-| [extract-global-constants](docs/rules/extract-global-constants.md)                 | Extract constants/functions to the global scope when possible                                                                                   |    |    |    |
-| [generic-starts-with-t](docs/rules/generic-starts-with-t.md)                       | Enforce TypeScript generic types to start with T                                                                                                |    | ✅  |    |
-| [no-async-array-filter](docs/rules/no-async-array-filter.md)                       | Disallow async callbacks for Array.filter                                                                                                       | ✅  |    |    |
-| [no-async-foreach](docs/rules/no-async-foreach.md)                                 | Disallow Array.forEach with an async callback function                                                                                          | ✅  |    |    |
-| [no-conditional-literals-in-jsx](docs/rules/no-conditional-literals-in-jsx.md)     | Disallow use of conditional literals in JSX code                                                                                                | ✅  |    |    |
-| [no-filter-without-return](docs/rules/no-filter-without-return.md)                 | Disallow Array.filter callbacks without an explicit return (if part of a block statement)                                                       | ✅  |    |    |
-| [no-misused-switch-case](docs/rules/no-misused-switch-case.md)                     | Prevent misuse of logical OR in switch case statements                                                                                          | ✅  |    |    |
-| [no-unpinned-dependencies](docs/rules/no-unpinned-dependencies.md)                 | Enforces pinned dependencies                                                                                                                    | ✅  |    | 🔧 |
-| [no-useless-fragment](docs/rules/no-useless-fragment.md)                           | Prevent unnecessary use of React fragments                                                                                                      |    | ✅  | 🔧 |
-| [prefer-fragment-shorthand](docs/rules/prefer-fragment-shorthand.md)               | Prefer <> shorthand for <React.Fragment>                                                                                                        |    | ✅  | 🔧 |
-| [prefer-type-over-interface](docs/rules/prefer-type-over-interface.md)             | Prefer using type alias over interface                                                                                                          |    | ✅  | 🔧 |
-| [require-memo](docs/rules/require-memo.md)                                         | React components must be memoized                                                                                                               | ✅  |    | 🔧 |
-
-<!-- end auto-generated rules list -->
-
-

package/plugin/docs/rules/array-methods-this-context.md

@@ -1,30 +0,0 @@
-# Prevent misuse of Array methods in OOP (`@blumintinc/blumint/array-methods-this-context`)
-
-⚠️ This rule _warns_ in the ✅ `recommended` config.
-
-<!-- end auto-generated rule header -->
-
-This rule disallows the direct use of class methods in Array methods like 'map', 'filter', 'forEach', 'reduce', 'some', 'every'. Instead, arrow functions should be used to preserve the 'this' context.
-
-## Rule Details
-
-This rule enforces that no class methods are directly used in Array methods. It also prefers the use of arrow functions over `bind(this)`
-
-### Examples of incorrect code for this rule:
-
-```typescript
-['a', 'b', 'c'].map(this.processItem)
-['a', 'b', 'c'].map(this.processItem, otherArgument)
-['a', 'b', 'c'].filter(this.checkItem)
-['a', 'b', 'c'].forEach(this.printItem)
-['a', 'b', 'c'].some(this.testItem)
-['a', 'b', 'c'].every(this.validateItem)
-['a', 'b', 'c'].reduce(this.combineItems)
-['a', 'b', 'c'].map(function(item) { return this.processItem(item) }.bind(this))
-```
-
-### Examples of correct code for this rule:
-```typescript
-['a', 'b', 'c'].map((item) => this.processItem(item))
-['a', 'b', 'c'].map(processItem)
-```

package/plugin/docs/rules/class-methods-read-top-to-bottom.md

@@ -1,46 +0,0 @@
-# Ensures classes read linearly from top to bottom (`@blumintinc/blumint/class-methods-read-top-to-bottom`)
-
-⚠️ This rule _warns_ in the ✅ `recommended` config.
-
-🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
-
-<!-- end auto-generated rule header -->
-
-This rule enforces an ordering of class methods according to BluMint's code style.
-
-## Rule Details
-
-This rule warns for classes that don't follow the 'top to bottom' ordering - such that properties appear at the top of the class, the constructor (if present) follows, and other methods follow in a top-to-bottom order.
-
-### Examples of incorrect code for this rule:
-
-```typescript
-class IncorrectlyOrdered {
-    field1: string;
-    field2: number;
-    methodA() {
-    this.methodB();
-    }
-    constructor() {
-    this.methodA();
-    this.methodC();
-    }
-    methodB() {}
-    methodC() {}
-}
-```
-
-### Examples of correct code for this rule:
-```typescript
-class CorrectlyOrdered {
-    field1: string;
-    field2: number;
-    constructor() {
-        this.methodA();
-    }
-    methodA() {
-        this.methodB();
-    }
-    methodB() {}
-}
-```

package/plugin/docs/rules/dynamic-https-errors.md

@@ -1,23 +0,0 @@
-# Dynamic error details should only be in the third argument of the HttpsError constructor. The second argument is hashed to produce a unique id (`@blumintinc/blumint/dynamic-https-errors`)
-
-⚠️ This rule _warns_ in the ✅ `recommended` config.
-
-<!-- end auto-generated rule header -->
-
-This rule warns against the use of template literals in the `message` field of the `HttpsError` constructor, and suggests their use in the `details` field instead.
-
-## Rule Details
-
-Examples of **incorrect** code for this rule:
-
-```typescript
-throw new https.HttpsError('foo', `Error: ${bar}`, 'baz');
-throw new HttpsError('foo', `Error: ${bar}`, 'baz');
-```
-
-Examples of **correct** code for this rule:
-
-```typescript
-throw new https.HttpsError('foo', 'bar', 'baz');
-throw new https.HttpsError('foo', 'bar', `Details: ${baz}`);
-```

package/plugin/docs/rules/export-if-in-doubt.md

@@ -1,26 +0,0 @@
-# All top-level const definitions, type definitions, and functions should be exported (`@blumintinc/blumint/export-if-in-doubt`)
-
-<!-- end auto-generated rule header -->
-
-This rule enforces that all top-level const definitions, type definitions, and functions should always be exported. If not done, this rule will trigger a warning message suggesting to export the declaration.
-
-## Rule Details
-
-This rule targets `VariableDeclaration`, `FunctionDeclaration`, and `TSTypeAliasDeclaration` at the top-level of the file. It will issue a warning if these are not part of an `ExportNamedDeclaration`.
-
-### Examples of incorrect code for this rule:
-
-```typescript
-const someVar = "Hello, world!";
-function someFunc() { return someVar; }
-type SomeType = { val: number };
-```
-
-### Examples of correct code for this rule:
-
-```typescript
-export const someVar = "Hello, world!";
-export function someFunc() { return someVar; }
-export type SomeType = { val: number };
-```
-

package/plugin/docs/rules/extract-global-constants.md

@@ -1,33 +0,0 @@
-# Extract constants/functions to the global scope when possible (`@blumintinc/blumint/extract-global-constants`)
-
-<!-- end auto-generated rule header -->
-
-This rule suggests that if a constant or a function within a function or block scope doesn't depend on any other identifiers in that scope, it should be moved to the global scope. This aims to improve the readability of the code and the possibility of reuse.
-
-## Rule Details
-
-This rule enforces that all `const` declarations and `FunctionDeclaration` at a non-global scope, which have no dependencies on other identifiers within the scope, should be extracted to the global scope.
-
-### Examples of incorrect code for this rule:
-
-```typescript
-function someFunc() {
-  const SOME_CONST = "Hello, world!";
-}
-
-function parentFunc() {
-  function childFunc() { return "Hello, world!"; }
-}
-```
-
-### Examples of correct code for this rule:
-
-```typescript
-const SOME_CONST = "Hello, world!";
-function someFunc() { /* ... */ }
-
-function childFunc() { return "Hello, world!"; }
-function parentFunc() { /* ... */ }
-```
-
-In the correct examples, each declaration is moved to the global scope since they don't depend on any identifier in their previous block or function scope. This aligns with the rule and promotes potential reuse of these declarations.

package/plugin/docs/rules/generic-starts-with-t.md

@@ -1,33 +0,0 @@
-# Enforce TypeScript generic types to start with T (`@blumintinc/blumint/generic-starts-with-t`)
-
-⚠️ This rule _warns_ in the ✅ `recommended` config.
-
-<!-- end auto-generated rule header -->
-
-This rule enforces that all TypeScript generic types start with the letter "T".
-
-## Rule Details
-
-Generics are a way of creating reusable code components that work with a variety of types as opposed to a single one. By convention, generic type parameters often start with the letter "T". This makes it easier to recognize them as generic types and not regular variables or types.
-
-This rule enforces that all TypeScript generic types start with the letter "T".
-
-Examples of **incorrect** code for this rule:
-
-```typescript
-type GenericType<Param> = Param[];
-type GenericType<TParam, Param> = [TParam, Param];
-type GenericType<P> = P[];
-```
-
-Examples of **correct** code for this rule:
-
-```typescript
-type GenericType<TParam> = TParam[];
-type GenericType<TParam1, TParam2> = [TParam1, TParam2];
-type GenericType<T> = T[];
-```
-
-## When Not To Use It
-If you have a different convention for naming generic types in your codebase, you may want to disable this rule.
-

package/plugin/docs/rules/no-async-array-filter.md

@@ -1,32 +0,0 @@
-# Disallow async callbacks for Array.filter (`@blumintinc/blumint/no-async-array-filter`)
-
-💼 This rule is enabled in the ✅ `recommended` config.
-
-<!-- end auto-generated rule header -->
-
-Async callbacks in array filters are dangerous and not picked up by the standard eslint rules.
-
-## Rule Details
-
-This rule prevents the use of async callbacks in Array.filter. These will return a Promise object, which is truthy, thus rendering the filter function useless.
-
-Examples of **incorrect** code for this rule:
-
-```typescript
-
-['a'].filter(async (x) => true)
-['a'].filter(async function(x) {
-        return true
-      })
-```
-
-Examples of **correct** code for this rule:
-
-```typescript
-
-['a'].filter((x) => true)
-['a'].filter(function (x) {
-      return true
-    })
-```
-