@clipboard-health/eslint-plugin 1.4.3 → 1.5.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/eslint-plugin",
   "description": "Clipboard's ESLint Plugin",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "dependencies": {
     "@typescript-eslint/utils": "8.33.0",
     "tslib": "2.8.1"

package/src/index.d.ts

@@ -1,4 +1,5 @@
 export declare const rules: {
     "enforce-ts-rest-in-controllers": import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"missingDecorator" | "missingReturn" | "decoratorNotFromPackage" | "callNotFromPackage", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
     "require-http-module-factory": import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"requireFactory" | "wrongPackage" | "noImport", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+    "require-run-validators-with-upsert": import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"missingRunValidators" | "runValidatorsFalse", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
 };

package/src/index.js

@@ -4,8 +4,10 @@ exports.rules = void 0;
 const tslib_1 = require("tslib");
 const enforce_ts_rest_in_controllers_1 = tslib_1.__importDefault(require("./lib/rules/enforce-ts-rest-in-controllers"));
 const require_http_module_factory_1 = tslib_1.__importDefault(require("./lib/rules/require-http-module-factory"));
+const require_run_validators_with_upsert_1 = tslib_1.__importDefault(require("./lib/rules/require-run-validators-with-upsert"));
 exports.rules = {
     "enforce-ts-rest-in-controllers": enforce_ts_rest_in_controllers_1.default,
     "require-http-module-factory": require_http_module_factory_1.default,
+    "require-run-validators-with-upsert": require_run_validators_with_upsert_1.default,
 };
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/eslint-plugin/src/index.ts"],"names":[],"mappings":";;;;AAAA,wHAAoF;AACpF,kHAA+E;AAElE,QAAA,KAAK,GAAG;IACnB,gCAAgC,EAAE,wCAA0B;IAC5D,6BAA6B,EAAE,qCAAwB;CACxD,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/eslint-plugin/src/index.ts"],"names":[],"mappings":";;;;AAAA,wHAAoF;AACpF,kHAA+E;AAC/E,gIAA4F;AAE/E,QAAA,KAAK,GAAG;IACnB,gCAAgC,EAAE,wCAA0B;IAC5D,6BAA6B,EAAE,qCAAwB;IACvD,oCAAoC,EAAE,4CAA8B;CACrE,CAAC"}

package/src/lib/rules/require-run-validators-with-upsert/index.d.ts

@@ -0,0 +1,2 @@
+declare const rule: import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"missingRunValidators" | "runValidatorsFalse", [], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
+export default rule;

package/src/lib/rules/require-run-validators-with-upsert/index.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * @fileoverview Rule to require runValidators: true when upsert: true is used in Mongoose operations
+ */
+const utils_1 = require("@typescript-eslint/utils");
+const createRule_1 = tslib_1.__importDefault(require("../../createRule"));
+const UPSERT_METHODS = new Set([
+    "updateOne",
+    "updateMany",
+    "findOneAndUpdate",
+    "findByIdAndUpdate",
+    "findOneAndReplace",
+    "replaceOne",
+]);
+const hasPropertyWithValue = (property, name, value) => property.type === utils_1.AST_NODE_TYPES.Property &&
+    property.key.type === utils_1.AST_NODE_TYPES.Identifier &&
+    property.key.name === name &&
+    property.value.type === utils_1.AST_NODE_TYPES.Literal &&
+    property.value.value === value;
+const findProperty = (objectExpression, name) => objectExpression.properties.find((property) => property.type === utils_1.AST_NODE_TYPES.Property &&
+    property.key.type === utils_1.AST_NODE_TYPES.Identifier &&
+    property.key.name === name);
+const hasUpsertTrue = (objectExpression) => objectExpression.properties.some((property) => hasPropertyWithValue(property, "upsert", true));
+const hasRunValidatorsTrue = (objectExpression) => objectExpression.properties.some((property) => hasPropertyWithValue(property, "runValidators", true));
+const hasRunValidatorsFalse = (objectExpression) => objectExpression.properties.some((property) => hasPropertyWithValue(property, "runValidators", false));
+const hasRunValidatorsProperty = (objectExpression) => objectExpression.properties.some((property) => property.type === utils_1.AST_NODE_TYPES.Property &&
+    property.key.type === utils_1.AST_NODE_TYPES.Identifier &&
+    property.key.name === "runValidators");
+const rule = (0, createRule_1.default)({
+    name: "require-run-validators-with-upsert",
+    defaultOptions: [],
+    meta: {
+        type: "problem",
+        docs: {
+            description: "Require runValidators: true when upsert: true is used in Mongoose update operations",
+        },
+        schema: [],
+        messages: {
+            missingRunValidators: "Mongoose upsert operations must include 'runValidators: true' to ensure schema validation on inserted documents. Add 'runValidators: true' to the options object.",
+            runValidatorsFalse: "Mongoose upsert operations should not have 'runValidators: false'. Schema validation should be enabled for upserts to ensure data integrity.",
+        },
+    },
+    create(context) {
+        return {
+            CallExpression(node) {
+                if (node.callee.type !== utils_1.AST_NODE_TYPES.MemberExpression) {
+                    return;
+                }
+                const { property } = node.callee;
+                if (property.type !== utils_1.AST_NODE_TYPES.Identifier) {
+                    return;
+                }
+                const methodName = property.name;
+                if (!UPSERT_METHODS.has(methodName)) {
+                    return;
+                }
+                for (const argument of node.arguments) {
+                    if (argument.type !== utils_1.AST_NODE_TYPES.ObjectExpression) {
+                        continue;
+                    }
+                    if (!hasUpsertTrue(argument)) {
+                        continue;
+                    }
+                    if (hasRunValidatorsTrue(argument)) {
+                        continue;
+                    }
+                    if (hasRunValidatorsFalse(argument)) {
+                        const runValidatorsProperty = findProperty(argument, "runValidators");
+                        if (runValidatorsProperty) {
+                            context.report({
+                                node: runValidatorsProperty,
+                                messageId: "runValidatorsFalse",
+                            });
+                        }
+                        continue;
+                    }
+                    // If runValidators is present with a non-literal value (e.g., a variable),
+                    // we consider it valid since the developer is explicitly setting it
+                    if (hasRunValidatorsProperty(argument)) {
+                        continue;
+                    }
+                    // runValidators is missing
+                    const upsertProperty = findProperty(argument, "upsert");
+                    if (upsertProperty) {
+                        context.report({
+                            node: upsertProperty,
+                            messageId: "missingRunValidators",
+                        });
+                    }
+                }
+            },
+        };
+    },
+});
+exports.default = rule;
+//# sourceMappingURL=index.js.map

package/src/lib/rules/require-run-validators-with-upsert/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/eslint-plugin/src/lib/rules/require-run-validators-with-upsert/index.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,oDAAyE;AAEzE,0EAA0C;AAE1C,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC;IAC7B,WAAW;IACX,YAAY;IACZ,kBAAkB;IAClB,mBAAmB;IACnB,mBAAmB;IACnB,YAAY;CACb,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,CAC3B,QAAuC,EACvC,IAAY,EACZ,KAAc,EACL,EAAE,CACX,QAAQ,CAAC,IAAI,KAAK,sBAAc,CAAC,QAAQ;IACzC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;IAC/C,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI;IAC1B,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO;IAC9C,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC;AAEjC,MAAM,YAAY,GAAG,CACnB,gBAA2C,EAC3C,IAAY,EACmB,EAAE,CACjC,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAC9B,CAAC,QAAQ,EAAiC,EAAE,CAC1C,QAAQ,CAAC,IAAI,KAAK,sBAAc,CAAC,QAAQ;IACzC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;IAC/C,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAC7B,CAAC;AAEJ,MAAM,aAAa,GAAG,CAAC,gBAA2C,EAAW,EAAE,CAC7E,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,oBAAoB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;AAEjG,MAAM,oBAAoB,GAAG,CAAC,gBAA2C,EAAW,EAAE,CACpF,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC5C,oBAAoB,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC,CACtD,CAAC;AAEJ,MAAM,qBAAqB,GAAG,CAAC,gBAA2C,EAAW,EAAE,CACrF,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAC5C,oBAAoB,CAAC,QAAQ,EAAE,eAAe,EAAE,KAAK,CAAC,CACvD,CAAC;AAEJ,MAAM,wBAAwB,GAAG,CAAC,gBAA2C,EAAW,EAAE,CACxF,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAC9B,CAAC,QAAQ,EAAE,EAAE,CACX,QAAQ,CAAC,IAAI,KAAK,sBAAc,CAAC,QAAQ;IACzC,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;IAC/C,QAAQ,CAAC,GAAG,CAAC,IAAI,KAAK,eAAe,CACxC,CAAC;AAEJ,MAAM,IAAI,GAAG,IAAA,oBAAU,EAAC;IACtB,IAAI,EAAE,oCAAoC;IAC1C,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,qFAAqF;SACxF;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,oBAAoB,EAClB,mKAAmK;YACrK,kBAAkB,EAChB,8IAA8I;SACjJ;KACF;IAED,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,cAAc,CAAC,IAAI;gBACjB,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,gBAAgB,EAAE,CAAC;oBACzD,OAAO;gBACT,CAAC;gBAED,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;gBACjC,IAAI,QAAQ,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;oBAChD,OAAO;gBACT,CAAC;gBAED,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAEjC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;oBACpC,OAAO;gBACT,CAAC;gBAED,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;oBACtC,IAAI,QAAQ,CAAC,IAAI,KAAK,sBAAc,CAAC,gBAAgB,EAAE,CAAC;wBACtD,SAAS;oBACX,CAAC;oBAED,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC7B,SAAS;oBACX,CAAC;oBAED,IAAI,oBAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACnC,SAAS;oBACX,CAAC;oBAED,IAAI,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACpC,MAAM,qBAAqB,GAAG,YAAY,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;wBACtE,IAAI,qBAAqB,EAAE,CAAC;4BAC1B,OAAO,CAAC,MAAM,CAAC;gCACb,IAAI,EAAE,qBAAqB;gCAC3B,SAAS,EAAE,oBAAoB;6BAChC,CAAC,CAAC;wBACL,CAAC;wBACD,SAAS;oBACX,CAAC;oBAED,2EAA2E;oBAC3E,oEAAoE;oBACpE,IAAI,wBAAwB,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACvC,SAAS;oBACX,CAAC;oBAED,2BAA2B;oBAC3B,MAAM,cAAc,GAAG,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;oBACxD,IAAI,cAAc,EAAE,CAAC;wBACnB,OAAO,CAAC,MAAM,CAAC;4BACb,IAAI,EAAE,cAAc;4BACpB,SAAS,EAAE,sBAAsB;yBAClC,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,IAAI,CAAC"}