@clipboard-health/eslint-config 6.3.9 → 6.4.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/eslint-config",
   "description": "Our ESLint configuration.",
-  "version": "6.3.9",
+  "version": "6.4.0",
   "bugs": "https://github.com/ClipboardHealth/core-utils/issues",
   "keywords": [
     "config",
@@ -18,6 +18,7 @@
     "eslint-config-xo": "^0.45.0",
     "eslint-config-xo-react": "^0.27",
     "eslint-config-xo-typescript": "^1",
+    "eslint-plugin-check-file": "^2.8.0",
     "eslint-plugin-eslint-comments": "^3",
     "eslint-plugin-expect-type": "^0.4",
     "eslint-plugin-import": "^2",

package/src/index.d.ts

@@ -8,6 +8,18 @@ export declare let overrides: ({
             message: string;
             selector: string;
         })[];
+        "check-file/folder-match-with-fex"?: never;
+        "@clipboard-health/enforce-ts-rest-in-controllers"?: never;
+        "@clipboard-health/require-http-module-factory"?: never;
+    };
+} | {
+    files: string[];
+    rules: {
+        "check-file/folder-match-with-fex": (string | {
+            "*.job.ts": string;
+        })[];
+        "@typescript-eslint/no-unsafe-assignment"?: never;
+        "no-restricted-syntax"?: never;
         "@clipboard-health/enforce-ts-rest-in-controllers"?: never;
         "@clipboard-health/require-http-module-factory"?: never;
     };
@@ -17,6 +29,7 @@ export declare let overrides: ({
         "@clipboard-health/enforce-ts-rest-in-controllers": string;
         "@typescript-eslint/no-unsafe-assignment"?: never;
         "no-restricted-syntax"?: never;
+        "check-file/folder-match-with-fex"?: never;
         "@clipboard-health/require-http-module-factory"?: never;
     };
 } | {
@@ -25,6 +38,7 @@ export declare let overrides: ({
         "@clipboard-health/require-http-module-factory": string;
         "@typescript-eslint/no-unsafe-assignment"?: never;
         "no-restricted-syntax"?: never;
+        "check-file/folder-match-with-fex"?: never;
         "@clipboard-health/enforce-ts-rest-in-controllers"?: never;
     };
 })[];

package/src/index.js

@@ -47,6 +47,7 @@ const isOutsideCoreUtilsMonorepo = (() => {
     }
 })();
 const plugins = [
+    "check-file",
     "expect-type",
     "jest",
     "no-only-tests",
@@ -93,6 +94,18 @@ module.exports = {
                 "no-restricted-syntax": baseNoRestrictedSyntax,
             },
         },
+        {
+            // Enforce that job files are located under the logic folder to follow the three-tier architecture
+            files: ["src/modules/**/*.job.ts"],
+            rules: {
+                "check-file/folder-match-with-fex": [
+                    "error",
+                    {
+                        "*.job.ts": "**/logic/**/",
+                    },
+                ],
+            },
+        },
         ...(isOutsideCoreUtilsMonorepo
             ? [
                 {

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/eslint-config/src/index.js"],"names":[],"mappings":";AAAA,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;AAClC,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AAE9B,MAAM,sBAAsB,GAAG;IAC7B,OAAO;IACP;QACE,2DAA2D;QAC3D,qJAAqJ;QACrJ,OAAO,EACL,wKAAwK;QAC1K,QAAQ,EAAE,gBAAgB;KAC3B;IACD;QACE,OAAO,EACL,iGAAiG;QACnG,QAAQ,EAAE,kBAAkB;KAC7B;IACD;QACE,OAAO,EACL,8FAA8F;QAChG,QAAQ,EAAE,eAAe;KAC1B;IACD;QACE,QAAQ,EAAE,mBAAmB;QAC7B,OAAO,EACL,2IAA2I;KAC9I;CACF,CAAC;AAEF,MAAM,4BAA4B,GAChC,+LAA+L,CAAC;AAElM;;;;;;;;;;;;GAYG;AACH,MAAM,0BAA0B,GAAG,CAAC,GAAG,EAAE;IACvC,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;QACpE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;QACzE,OAAO,WAAW,CAAC,IAAI,KAAK,8BAA8B,CAAC;IAC7D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC,EAAE,CAAC;AAEL,MAAM,OAAO,GAAG;IACd,aAAa;IACb,MAAM;IACN,eAAe;IACf,oBAAoB;IACpB,oBAAoB;CACrB,CAAC;AAEF,sFAAsF;AACtF,IAAI,0BAA0B,EAAE,CAAC;IAC/B,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,CAAC,OAAO,GAAG;IACf,OAAO,EAAE;QACP,oBAAoB;QACpB,8CAA8C;QAC9C,uCAAuC;QACvC,oCAAoC;QACpC,gCAAgC;QAChC,yBAAyB;QACzB,mBAAmB;QACnB,2BAA2B;QAC3B,sBAAsB;QACtB,yCAAyC;QACzC,6BAA6B;QAC7B,4BAA4B;QAC5B,IAAI;QACJ,qBAAqB;QACrB,UAAU;KACX;IACD,SAAS,EAAE;QACT;YACE,KAAK,EAAE;gBACL,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,YAAY;aACb;YACD,KAAK,EAAE;gBACL,wCAAwC;gBACxC,yCAAyC,EAAE,KAAK;gBAChD,sBAAsB,EAAE,sBAAsB;aAC/C;SACF;QACD,GAAG,CAAC,0BAA0B;YAC5B,CAAC,CAAC;gBACE;oBACE,KAAK,EAAE,CAAC,oBAAoB,EAAE,qBAAqB,CAAC;oBACpD,KAAK,EAAE;wBACL,kDAAkD,EAAE,OAAO;qBAC5D;iBACF;gBACD;oBACE,KAAK,EAAE,CAAC,gBAAgB,CAAC;oBACzB,KAAK,EAAE;wBACL,+CAA+C,EAAE,OAAO;qBACzD;iBACF;aACF;YACH,CAAC,CAAC,EAAE,CAAC;KACR;IACD,MAAM,EAAE,2BAA2B;IACnC,OAAO;IACP,KAAK,EAAE;QACL,wCAAwC;QACxC,8BAA8B,EAAE,KAAK;QACrC,gDAAgD,EAAE,KAAK;QACvD,oDAAoD,EAAE,KAAK;QAC3D,qCAAqC,EAAE,KAAK;QAC5C,wDAAwD;QACxD,qCAAqC,EAAE,OAAO;QAC9C,sCAAsC;QAEtC,wGAAwG;QACxG,gDAAgD,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC;QAExE,2BAA2B;QAC3B,sCAAsC,EAAE,KAAK;QAE7C,yCAAyC;QACzC,mCAAmC,EAAE,KAAK;QAE1C,oDAAoD;QACpD,mCAAmC,EAAE;YACnC,MAAM;YACN,EAAE,iBAAiB,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,yBAAyB,EAAE,IAAI,EAAE;SACtF;QACD,iCAAiC,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;QAEtD,wFAAwF;QACxF,sBAAsB,EAAE,KAAK;QAE7B,iEAAiE;QACjE,wBAAwB,EAAE,KAAK;QAE/B,+BAA+B;QAC/B,mBAAmB,EAAE,KAAK;QAE1B,eAAe;QACf,KAAK,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC;QAEvB,8BAA8B;QAC9B,mBAAmB,EAAE,KAAK;QAE1B,iBAAiB,EAAE,CAAC,OAAO,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAEpE,6CAA6C;QAC7C,mCAAmC,EAAE,KAAK;QAE1C,sCAAsC;QACtC,sBAAsB,EAAE,KAAK;QAE7B,uBAAuB;QACvB,8BAA8B,EAAE,KAAK;QACrC,oBAAoB,EAAE;YACpB,OAAO;YACP;gBACE,mBAAmB,EAAE;oBACnB,QAAQ;oBACR,mBAAmB;oBACnB,gBAAgB;oBAChB,gBAAgB;oBAChB,iBAAiB;oBACjB,0BAA0B;oBAC1B,4BAA4B;oBAC5B,gBAAgB;oBAChB,cAAc;iBACf;aACF;SACF;QAED,8BAA8B;QAC9B,qBAAqB,EAAE,KAAK;QAE5B,8BAA8B;QAC9B,yBAAyB,EAAE,KAAK;QAEhC,kCAAkC;QAClC,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAExD,2DAA2D;QAC3D,kBAAkB,EAAE,MAAM;QAE1B,sEAAsE;QACtE,6BAA6B,EAAE,OAAO;QAEtC,uBAAuB,EAAE;YACvB,OAAO;YACP;gBACE,KAAK,EAAE;oBACL,yDAAyD;oBACzD;wBACE,WAAW,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;wBACrC,OAAO,EACL,+HAA+H;wBACjI,IAAI,EAAE,SAAS;qBAChB;oBACD;wBACE,IAAI,EAAE,aAAa;wBACnB,OAAO,EACL,+IAA+I;qBAClJ;iBACF;aACF;SACF;QAED,0BAA0B,EAAE;YAC1B,OAAO;YACP;gBACE,MAAM,EAAE,QAAQ;gBAChB,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EACL,2PAA2P;aAC9P;SACF;QAED,sBAAsB,EAAE;YACtB,GAAG,sBAAsB;YACzB;gBACE,QAAQ,EAAE,uEAAuE;gBACjF,OAAO,EAAE,4BAA4B;aACtC;YACD;gBACE,QAAQ,EAAE,wEAAwE;gBAClF,OAAO,EAAE,4BAA4B;aACtC;SACF;QAED,wBAAwB;QACxB,YAAY,EAAE,OAAO;QAErB,0EAA0E;QAC1E,6EAA6E;QAC7E,+CAA+C;QAC/C,aAAa,EAAE,KAAK;QAEpB,6EAA6E;QAC7E,qEAAqE;QACrE,iBAAiB,EAAE,KAAK;QAExB,4BAA4B;QAC5B,WAAW,EAAE,KAAK;QAElB,yDAAyD;QACzD,sBAAsB,EAAE,KAAK;QAE7B,YAAY;QACZ,YAAY,EAAE,KAAK;QAEnB,2DAA2D;QAC3D,sBAAsB,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAEvE;;;WAGG;QACH,kBAAkB,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC;QAC3C,kCAAkC,EAAE,KAAK;QAEzC,4BAA4B,EAAE,MAAM;QAEpC,2BAA2B;QAC3B,4BAA4B,EAAE,MAAM;QAEpC,yCAAyC;QACzC,qCAAqC,EAAE,KAAK;QAE5C,qCAAqC;QACrC,2BAA2B,EAAE,KAAK;QAElC,qCAAqC;QACrC,yBAAyB,EAAE,KAAK;QAEhC,wCAAwC;QACxC,iBAAiB,EAAE,KAAK;QAExB,8BAA8B;QAC9B,uBAAuB,EAAE,KAAK;QAE9B,8CAA8C;QAC9C,+BAA+B,EAAE;YAC/B,OAAO;YACP,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE;SACrD;KACF;IACD,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE;CAC7C,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/eslint-config/src/index.js"],"names":[],"mappings":";AAAA,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;AAClC,MAAM,EAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AAE9B,MAAM,sBAAsB,GAAG;IAC7B,OAAO;IACP;QACE,2DAA2D;QAC3D,qJAAqJ;QACrJ,OAAO,EACL,wKAAwK;QAC1K,QAAQ,EAAE,gBAAgB;KAC3B;IACD;QACE,OAAO,EACL,iGAAiG;QACnG,QAAQ,EAAE,kBAAkB;KAC7B;IACD;QACE,OAAO,EACL,8FAA8F;QAChG,QAAQ,EAAE,eAAe;KAC1B;IACD;QACE,QAAQ,EAAE,mBAAmB;QAC7B,OAAO,EACL,2IAA2I;KAC9I;CACF,CAAC;AAEF,MAAM,4BAA4B,GAChC,+LAA+L,CAAC;AAElM;;;;;;;;;;;;GAYG;AACH,MAAM,0BAA0B,GAAG,CAAC,GAAG,EAAE;IACvC,IAAI,CAAC;QACH,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC;QACpE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;QACzE,OAAO,WAAW,CAAC,IAAI,KAAK,8BAA8B,CAAC;IAC7D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC,EAAE,CAAC;AAEL,MAAM,OAAO,GAAG;IACd,YAAY;IACZ,aAAa;IACb,MAAM;IACN,eAAe;IACf,oBAAoB;IACpB,oBAAoB;CACrB,CAAC;AAEF,sFAAsF;AACtF,IAAI,0BAA0B,EAAE,CAAC;IAC/B,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,CAAC,OAAO,GAAG;IACf,OAAO,EAAE;QACP,oBAAoB;QACpB,8CAA8C;QAC9C,uCAAuC;QACvC,oCAAoC;QACpC,gCAAgC;QAChC,yBAAyB;QACzB,mBAAmB;QACnB,2BAA2B;QAC3B,sBAAsB;QACtB,yCAAyC;QACzC,6BAA6B;QAC7B,4BAA4B;QAC5B,IAAI;QACJ,qBAAqB;QACrB,UAAU;KACX;IACD,SAAS,EAAE;QACT;YACE,KAAK,EAAE;gBACL,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,YAAY;gBACZ,WAAW;gBACX,YAAY;aACb;YACD,KAAK,EAAE;gBACL,wCAAwC;gBACxC,yCAAyC,EAAE,KAAK;gBAChD,sBAAsB,EAAE,sBAAsB;aAC/C;SACF;QACD;YACE,kGAAkG;YAClG,KAAK,EAAE,CAAC,yBAAyB,CAAC;YAClC,KAAK,EAAE;gBACL,kCAAkC,EAAE;oBAClC,OAAO;oBACP;wBACE,UAAU,EAAE,cAAc;qBAC3B;iBACF;aACF;SACF;QACD,GAAG,CAAC,0BAA0B;YAC5B,CAAC,CAAC;gBACE;oBACE,KAAK,EAAE,CAAC,oBAAoB,EAAE,qBAAqB,CAAC;oBACpD,KAAK,EAAE;wBACL,kDAAkD,EAAE,OAAO;qBAC5D;iBACF;gBACD;oBACE,KAAK,EAAE,CAAC,gBAAgB,CAAC;oBACzB,KAAK,EAAE;wBACL,+CAA+C,EAAE,OAAO;qBACzD;iBACF;aACF;YACH,CAAC,CAAC,EAAE,CAAC;KACR;IACD,MAAM,EAAE,2BAA2B;IACnC,OAAO;IACP,KAAK,EAAE;QACL,wCAAwC;QACxC,8BAA8B,EAAE,KAAK;QACrC,gDAAgD,EAAE,KAAK;QACvD,oDAAoD,EAAE,KAAK;QAC3D,qCAAqC,EAAE,KAAK;QAC5C,wDAAwD;QACxD,qCAAqC,EAAE,OAAO;QAC9C,sCAAsC;QAEtC,wGAAwG;QACxG,gDAAgD,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC;QAExE,2BAA2B;QAC3B,sCAAsC,EAAE,KAAK;QAE7C,yCAAyC;QACzC,mCAAmC,EAAE,KAAK;QAE1C,oDAAoD;QACpD,mCAAmC,EAAE;YACnC,MAAM;YACN,EAAE,iBAAiB,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,yBAAyB,EAAE,IAAI,EAAE;SACtF;QACD,iCAAiC,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;QAEtD,wFAAwF;QACxF,sBAAsB,EAAE,KAAK;QAE7B,iEAAiE;QACjE,wBAAwB,EAAE,KAAK;QAE/B,+BAA+B;QAC/B,mBAAmB,EAAE,KAAK;QAE1B,eAAe;QACf,KAAK,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC;QAEvB,8BAA8B;QAC9B,mBAAmB,EAAE,KAAK;QAE1B,iBAAiB,EAAE,CAAC,OAAO,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAEpE,6CAA6C;QAC7C,mCAAmC,EAAE,KAAK;QAE1C,sCAAsC;QACtC,sBAAsB,EAAE,KAAK;QAE7B,uBAAuB;QACvB,8BAA8B,EAAE,KAAK;QACrC,oBAAoB,EAAE;YACpB,OAAO;YACP;gBACE,mBAAmB,EAAE;oBACnB,QAAQ;oBACR,mBAAmB;oBACnB,gBAAgB;oBAChB,gBAAgB;oBAChB,iBAAiB;oBACjB,0BAA0B;oBAC1B,4BAA4B;oBAC5B,gBAAgB;oBAChB,cAAc;iBACf;aACF;SACF;QAED,8BAA8B;QAC9B,qBAAqB,EAAE,KAAK;QAE5B,8BAA8B;QAC9B,yBAAyB,EAAE,KAAK;QAEhC,kCAAkC;QAClC,SAAS,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAExD,2DAA2D;QAC3D,kBAAkB,EAAE,MAAM;QAE1B,sEAAsE;QACtE,6BAA6B,EAAE,OAAO;QAEtC,uBAAuB,EAAE;YACvB,OAAO;YACP;gBACE,KAAK,EAAE;oBACL,yDAAyD;oBACzD;wBACE,WAAW,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;wBACrC,OAAO,EACL,+HAA+H;wBACjI,IAAI,EAAE,SAAS;qBAChB;oBACD;wBACE,IAAI,EAAE,aAAa;wBACnB,OAAO,EACL,+IAA+I;qBAClJ;iBACF;aACF;SACF;QAED,0BAA0B,EAAE;YAC1B,OAAO;YACP;gBACE,MAAM,EAAE,QAAQ;gBAChB,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EACL,2PAA2P;aAC9P;SACF;QAED,sBAAsB,EAAE;YACtB,GAAG,sBAAsB;YACzB;gBACE,QAAQ,EAAE,uEAAuE;gBACjF,OAAO,EAAE,4BAA4B;aACtC;YACD;gBACE,QAAQ,EAAE,wEAAwE;gBAClF,OAAO,EAAE,4BAA4B;aACtC;SACF;QAED,wBAAwB;QACxB,YAAY,EAAE,OAAO;QAErB,0EAA0E;QAC1E,6EAA6E;QAC7E,+CAA+C;QAC/C,aAAa,EAAE,KAAK;QAEpB,6EAA6E;QAC7E,qEAAqE;QACrE,iBAAiB,EAAE,KAAK;QAExB,4BAA4B;QAC5B,WAAW,EAAE,KAAK;QAElB,yDAAyD;QACzD,sBAAsB,EAAE,KAAK;QAE7B,YAAY;QACZ,YAAY,EAAE,KAAK;QAEnB,2DAA2D;QAC3D,sBAAsB,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;QAEvE;;;WAGG;QACH,kBAAkB,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC;QAC3C,kCAAkC,EAAE,KAAK;QAEzC,4BAA4B,EAAE,MAAM;QAEpC,2BAA2B;QAC3B,4BAA4B,EAAE,MAAM;QAEpC,yCAAyC;QACzC,qCAAqC,EAAE,KAAK;QAE5C,qCAAqC;QACrC,2BAA2B,EAAE,KAAK;QAElC,qCAAqC;QACrC,yBAAyB,EAAE,KAAK;QAEhC,wCAAwC;QACxC,iBAAiB,EAAE,KAAK;QAExB,8BAA8B;QAC9B,uBAAuB,EAAE,KAAK;QAE9B,8CAA8C;QAC9C,+BAA+B,EAAE;YAC/B,OAAO;YACP,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE;SACrD;KACF;IACD,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE;CAC7C,CAAC"}