@clipboard-health/eslint-plugin 0.4.0 → 0.5.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clipboard-health/eslint-plugin",
   "description": "Clipboard's ESLint Plugin",
-  "version": "0.4.0",
+  "version": "0.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>;
+    "forbid-object-assign": import("@typescript-eslint/utils/dist/ts-eslint").RuleModule<"objectAssignReturnValueUsed", unknown[], unknown, import("@typescript-eslint/utils/dist/ts-eslint").RuleListener>;
 };

package/src/index.js

@@ -3,9 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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 forbid_object_assign_1 = tslib_1.__importDefault(require("./lib/rules/forbid-object-assign"));
 const require_http_module_factory_1 = tslib_1.__importDefault(require("./lib/rules/require-http-module-factory"));
 exports.rules = {
     "enforce-ts-rest-in-controllers": enforce_ts_rest_in_controllers_1.default,
     "require-http-module-factory": require_http_module_factory_1.default,
+    "forbid-object-assign": forbid_object_assign_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,oGAAkE;AAClE,kHAA+E;AAElE,QAAA,KAAK,GAAG;IACnB,gCAAgC,EAAE,wCAA0B;IAC5D,6BAA6B,EAAE,qCAAwB;IACvD,sBAAsB,EAAE,8BAAkB;CAC3C,CAAC"}

package/src/lib/rules/forbid-object-assign/index.d.ts

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

package/src/lib/rules/forbid-object-assign/index.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const utils_1 = require("@typescript-eslint/utils");
+const createRule_1 = tslib_1.__importDefault(require("../../createRule"));
+const tsEsTreeTypeGuards_1 = require("../tsEsTreeTypeGuards");
+function reportViolationIfObjectAssignReturnValueUsed(context, expression) {
+    const unwrappedExpression = unwrapExpression(expression);
+    if (isObjectAssignCall(unwrappedExpression)) {
+        context.report({
+            node: unwrappedExpression,
+            messageId: "objectAssignReturnValueUsed",
+        });
+    }
+}
+// Returns true iff the expression is the invocation of `Object.assign`
+function isObjectAssignCall(expression) {
+    // Verify that the passed in expression is a function call
+    if (expression.type !== utils_1.AST_NODE_TYPES.CallExpression) {
+        return false;
+    }
+    // Verify that the expression is a member function on an object, e.g. x.call() or f().call()
+    const { callee } = expression;
+    if (!(0, tsEsTreeTypeGuards_1.isMemberExpression)(callee)) {
+        return false;
+    }
+    // Verify that the function call is on an object identity, e.g. X.call() (but not f().call())
+    const { object } = callee;
+    if (!(0, tsEsTreeTypeGuards_1.isIdentifierExpression)(object)) {
+        return false;
+    }
+    // Verify that the function call is on the identifier referring to Object, e.g. Object.call()
+    if (object.name !== "Object") {
+        return false;
+    }
+    // Verify that the function being called is "assign"
+    const { property } = callee;
+    return property.type === utils_1.AST_NODE_TYPES.Identifier && property.name === "assign";
+}
+/*
+ * Unwraps some wrapped expressions to get to the base expression. For example,
+ * Unwraps "return x as Type" to "return x" and unwraps "(x)!" to "x"
+ * This is necessary so that our rule can lint the underlying expression for violations
+ *
+ * If you want to reuse this in a wider use case, you may have to expand this to specifically deal
+ * with parentheses and other cases.
+ */
+function unwrapExpression(expression) {
+    if ((0, tsEsTreeTypeGuards_1.isTypescriptTypedExpression)(expression) || (0, tsEsTreeTypeGuards_1.isNonNullAssertion)(expression)) {
+        return unwrapExpression(expression.expression);
+    }
+    return expression;
+}
+const rule = (0, createRule_1.default)({
+    name: "forbid-object-assign",
+    defaultOptions: [],
+    meta: {
+        type: "problem",
+        docs: {
+            description: "Favor object spread operator {...obj} over Object.assign",
+        },
+        schema: [],
+        messages: {
+            objectAssignReturnValueUsed: "Use the object spread operator. Object.assign mutates the first argument which is confusing. See https://www.notion.so/BP-TypeScript-Style-Guide-5d4c24aea08a4b9f9feb03550f2c5310?source=copy_link#2568643321f4805ba04ecce1082b2b38 for more information.",
+        },
+    },
+    create(context) {
+        return {
+            VariableDeclarator(node) {
+                if (node.init === null) {
+                    return;
+                }
+                reportViolationIfObjectAssignReturnValueUsed(context, node.init);
+            },
+            AssignmentExpression(node) {
+                const rightHandSideOfAssignment = node.right;
+                reportViolationIfObjectAssignReturnValueUsed(context, rightHandSideOfAssignment);
+            },
+            ReturnStatement(node) {
+                if (node.argument === null) {
+                    return;
+                }
+                reportViolationIfObjectAssignReturnValueUsed(context, node.argument);
+            },
+            MemberExpression(node) {
+                reportViolationIfObjectAssignReturnValueUsed(context, node.object);
+            },
+            TemplateLiteral(node) {
+                node.expressions.forEach((expression) => {
+                    reportViolationIfObjectAssignReturnValueUsed(context, expression);
+                });
+            },
+            ArrayExpression(node) {
+                node.elements.forEach((expression) => {
+                    if (expression === null) {
+                        return;
+                    }
+                    if (expression.type === utils_1.AST_NODE_TYPES.SpreadElement) {
+                        reportViolationIfObjectAssignReturnValueUsed(context, expression.argument);
+                    }
+                    else {
+                        reportViolationIfObjectAssignReturnValueUsed(context, expression);
+                    }
+                });
+            },
+            CallExpression(node) {
+                node.arguments.forEach((argument) => {
+                    if (argument.type === utils_1.AST_NODE_TYPES.SpreadElement) {
+                        reportViolationIfObjectAssignReturnValueUsed(context, argument.argument);
+                    }
+                    else {
+                        reportViolationIfObjectAssignReturnValueUsed(context, argument);
+                    }
+                });
+            },
+        };
+    },
+});
+exports.default = rule;
+//# sourceMappingURL=index.js.map

package/src/lib/rules/forbid-object-assign/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/eslint-plugin/src/lib/rules/forbid-object-assign/index.ts"],"names":[],"mappings":";;;AACA,oDAA0D;AAG1D,0EAA0C;AAC1C,8DAK+B;AAE/B,SAAS,4CAA4C,CACnD,OAAwE,EACxE,UAA+B;IAE/B,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACzD,IAAI,kBAAkB,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC5C,OAAO,CAAC,MAAM,CAAC;YACb,IAAI,EAAE,mBAAmB;YACzB,SAAS,EAAE,6BAA6B;SACzC,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,uEAAuE;AACvE,SAAS,kBAAkB,CAAC,UAA+B;IACzD,0DAA0D;IAC1D,IAAI,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,cAAc,EAAE,CAAC;QACtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4FAA4F;IAC5F,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IAC9B,IAAI,CAAC,IAAA,uCAAkB,EAAC,MAAM,CAAC,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6FAA6F;IAC7F,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAC1B,IAAI,CAAC,IAAA,2CAAsB,EAAC,MAAM,CAAC,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6FAA6F;IAC7F,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,oDAAoD;IACpD,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAC5B,OAAO,QAAQ,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC;AACnF,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,gBAAgB,CAAC,UAA+B;IACvD,IAAI,IAAA,gDAA2B,EAAC,UAAU,CAAC,IAAI,IAAA,uCAAkB,EAAC,UAAU,CAAC,EAAE,CAAC;QAC9E,OAAO,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,MAAM,IAAI,GAAG,IAAA,oBAAU,EAAC;IACtB,IAAI,EAAE,sBAAsB;IAC5B,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,0DAA0D;SACxE;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,2BAA2B,EACzB,2PAA2P;SAC9P;KACF;IAED,MAAM,CAAC,OAAwE;QAC7E,OAAO;YACL,kBAAkB,CAAC,IAAiC;gBAClD,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBACvB,OAAO;gBACT,CAAC;gBAED,4CAA4C,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACnE,CAAC;YACD,oBAAoB,CAAC,IAAmC;gBACtD,MAAM,yBAAyB,GAAG,IAAI,CAAC,KAAK,CAAC;gBAC7C,4CAA4C,CAAC,OAAO,EAAE,yBAAyB,CAAC,CAAC;YACnF,CAAC;YACD,eAAe,CAAC,IAA8B;gBAC5C,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;oBAC3B,OAAO;gBACT,CAAC;gBAED,4CAA4C,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvE,CAAC;YACD,gBAAgB,CAAC,IAA+B;gBAC9C,4CAA4C,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACrE,CAAC;YACD,eAAe,CAAC,IAA8B;gBAC5C,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;oBACtC,4CAA4C,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;gBACpE,CAAC,CAAC,CAAC;YACL,CAAC;YACD,eAAe,CAAC,IAA8B;gBAC5C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;oBACnC,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;wBACxB,OAAO;oBACT,CAAC;oBAED,IAAI,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,aAAa,EAAE,CAAC;wBACrD,4CAA4C,CAAC,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;oBAC7E,CAAC;yBAAM,CAAC;wBACN,4CAA4C,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;oBACpE,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;YACD,cAAc,CAAC,IAA6B;gBAC1C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;oBAClC,IAAI,QAAQ,CAAC,IAAI,KAAK,sBAAc,CAAC,aAAa,EAAE,CAAC;wBACnD,4CAA4C,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBAC3E,CAAC;yBAAM,CAAC;wBACN,4CAA4C,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAClE,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,kBAAe,IAAI,CAAC"}

package/src/lib/rules/tsEsTreeTypeGuards.d.ts

@@ -0,0 +1,5 @@
+import type { TSESTree } from "@typescript-eslint/utils";
+export declare function isMemberExpression(expression: TSESTree.Expression | TSESTree.Super): expression is TSESTree.MemberExpression;
+export declare function isIdentifierExpression(expression: TSESTree.Expression): expression is TSESTree.Identifier;
+export declare function isTypescriptTypedExpression(expression: TSESTree.Expression): expression is TSESTree.TSAsExpression | TSESTree.TSTypeAssertion;
+export declare function isNonNullAssertion(expression: TSESTree.Expression): expression is TSESTree.TSNonNullExpression;

package/src/lib/rules/tsEsTreeTypeGuards.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMemberExpression = isMemberExpression;
+exports.isIdentifierExpression = isIdentifierExpression;
+exports.isTypescriptTypedExpression = isTypescriptTypedExpression;
+exports.isNonNullAssertion = isNonNullAssertion;
+const utils_1 = require("@typescript-eslint/utils");
+function isMemberExpression(expression) {
+    return expression.type === utils_1.AST_NODE_TYPES.MemberExpression;
+}
+function isIdentifierExpression(expression) {
+    return expression.type === utils_1.AST_NODE_TYPES.Identifier;
+}
+function isTypescriptTypedExpression(expression) {
+    return (expression.type === utils_1.AST_NODE_TYPES.TSAsExpression ||
+        expression.type === utils_1.AST_NODE_TYPES.TSTypeAssertion);
+}
+function isNonNullAssertion(expression) {
+    return expression.type === utils_1.AST_NODE_TYPES.TSNonNullExpression;
+}
+//# sourceMappingURL=tsEsTreeTypeGuards.js.map

package/src/lib/rules/tsEsTreeTypeGuards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsEsTreeTypeGuards.js","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin/src/lib/rules/tsEsTreeTypeGuards.ts"],"names":[],"mappings":";;AAGA,gDAIC;AAED,wDAIC;AAED,kEAOC;AAED,gDAIC;AA3BD,oDAA0D;AAE1D,SAAgB,kBAAkB,CAChC,UAAgD;IAEhD,OAAO,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,gBAAgB,CAAC;AAC7D,CAAC;AAED,SAAgB,sBAAsB,CACpC,UAA+B;IAE/B,OAAO,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,CAAC;AACvD,CAAC;AAED,SAAgB,2BAA2B,CACzC,UAA+B;IAE/B,OAAO,CACL,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,cAAc;QACjD,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,eAAe,CACnD,CAAC;AACJ,CAAC;AAED,SAAgB,kBAAkB,CAChC,UAA+B;IAE/B,OAAO,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,mBAAmB,CAAC;AAChE,CAAC"}