@clipboard-health/eslint-plugin 2.5.31 → 2.5.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clipboard-health/eslint-plugin",
-  "version": "2.5.31",
+  "version": "2.5.32",
   "description": "Clipboard's ESLint Plugin",
   "keywords": [
     "eslint",

package/src/index.d.ts

@@ -2,6 +2,9 @@ export declare const rules: {
     "enforce-ts-rest-in-controllers": import("@typescript-eslint/utils/ts-eslint").RuleModule<"callNotFromPackage" | "decoratorNotFromPackage" | "missingDecorator" | "missingReturn", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
         name: string;
     };
+    "no-cross-contract-imports": import("@typescript-eslint/utils/ts-eslint").RuleModule<"noCrossContractImport", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+        name: string;
+    };
     "require-http-module-factory": import("@typescript-eslint/utils/ts-eslint").RuleModule<"noImport" | "requireFactory" | "wrongPackage", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
         name: string;
     };

package/src/index.js

@@ -3,11 +3,13 @@ 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 no_cross_contract_imports_1 = tslib_1.__importDefault(require("./lib/rules/no-cross-contract-imports"));
 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"));
 const require_zod_import_in_contracts_1 = tslib_1.__importDefault(require("./lib/rules/require-zod-import-in-contracts"));
 exports.rules = {
     "enforce-ts-rest-in-controllers": enforce_ts_rest_in_controllers_1.default,
+    "no-cross-contract-imports": no_cross_contract_imports_1.default,
     "require-http-module-factory": require_http_module_factory_1.default,
     "require-run-validators-with-upsert": require_run_validators_with_upsert_1.default,
     "require-zod-import-in-contracts": require_zod_import_in_contracts_1.default,

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;AAC/E,gIAA4F;AAC5F,0HAAsF;AAEzE,QAAA,KAAK,GAAG;IACnB,gCAAgC,EAAE,wCAA0B;IAC5D,6BAA6B,EAAE,qCAAwB;IACvD,oCAAoC,EAAE,4CAA8B;IACpE,iCAAiC,EAAE,yCAA2B;CAC/D,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/eslint-plugin/src/index.ts"],"names":[],"mappings":";;;;AAAA,wHAAoF;AACpF,8GAA2E;AAC3E,kHAA+E;AAC/E,gIAA4F;AAC5F,0HAAsF;AAEzE,QAAA,KAAK,GAAG;IACnB,gCAAgC,EAAE,wCAA0B;IAC5D,2BAA2B,EAAE,mCAAsB;IACnD,6BAA6B,EAAE,qCAAwB;IACvD,oCAAoC,EAAE,4CAA8B;IACpE,iCAAiC,EAAE,yCAA2B;CAC/D,CAAC"}

package/src/lib/rules/no-cross-contract-imports/index.d.ts

@@ -0,0 +1,4 @@
+declare const rule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"noCrossContractImport", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
+    name: string;
+};
+export default rule;

package/src/lib/rules/no-cross-contract-imports/index.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * @fileoverview Forbid contract packages from importing other contract packages.
+ * Cross-contract dependencies pin one contract into another's dependencies,
+ * vendoring duplicate copies into every consumer and risking dependency cycles.
+ */
+const node_fs_1 = require("node:fs");
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const utils_1 = require("@typescript-eslint/utils");
+const createRule_1 = require("../../createRule");
+const CONTRACT_PACKAGE_PATTERN = /^@clipboard-health\/(?:contract-|api-contract-|flag-)/;
+const SHARED_CONTRACT_PACKAGE = "@clipboard-health/contract-core";
+const packageNameCache = new Map();
+/**
+ * Walks up from `directory` to the nearest package.json that declares a `name`.
+ * Skips nameless manifests (e.g. `{"type":"module"}` build-output markers).
+ */
+function nearestPackageName(directory) {
+    if (packageNameCache.has(directory)) {
+        return packageNameCache.get(directory);
+    }
+    let name;
+    const manifestPath = node_path_1.default.join(directory, "package.json");
+    try {
+        // eslint-disable-next-line security/detect-non-literal-fs-filename -- resolves the linted file's own package.json
+        const manifest = JSON.parse((0, node_fs_1.readFileSync)(manifestPath, "utf8"));
+        if (typeof manifest === "object" &&
+            manifest !== null &&
+            "name" in manifest &&
+            typeof manifest.name === "string") {
+            name = manifest.name;
+        }
+    }
+    catch {
+        // No package.json in this directory; keep walking up.
+    }
+    if (name === undefined) {
+        const parent = node_path_1.default.dirname(directory);
+        name = parent === directory ? undefined : nearestPackageName(parent);
+    }
+    packageNameCache.set(directory, name);
+    return name;
+}
+function isBannedSpecifier(specifier) {
+    return (CONTRACT_PACKAGE_PATTERN.test(specifier) &&
+        specifier !== SHARED_CONTRACT_PACKAGE &&
+        !specifier.startsWith(`${SHARED_CONTRACT_PACKAGE}/`));
+}
+const rule = (0, createRule_1.createRule)({
+    name: "no-cross-contract-imports",
+    defaultOptions: [],
+    meta: {
+        type: "problem",
+        docs: {
+            description: "Forbid contract packages from importing other contract packages; contracts own the shape of their inputs and outputs",
+        },
+        schema: [],
+        messages: {
+            noCrossContractImport: "Contract packages must not depend on '{{specifier}}'. Cross-contract imports (including type-only imports and re-exports) pin another contract into this package's dependencies, vendoring duplicate copies into every consumer and risking dependency cycles. Import shared primitives from @clipboard-health/contract-core, or duplicate the schema locally — type-checking and response validation catch drift.",
+        },
+    },
+    create(context) {
+        // context.filename requires ESLint >=8.40; fall back for older 8.x hosts.
+        const filename = context.filename ?? context.getFilename();
+        const packageName = nearestPackageName(node_path_1.default.dirname(filename));
+        if (packageName === undefined || !CONTRACT_PACKAGE_PATTERN.test(packageName)) {
+            return {};
+        }
+        function checkSpecifier(node, specifier) {
+            const isSelfImport = specifier === packageName || specifier.startsWith(`${packageName}/`);
+            if (!isSelfImport && isBannedSpecifier(specifier)) {
+                context.report({
+                    node,
+                    messageId: "noCrossContractImport",
+                    data: { specifier },
+                });
+            }
+        }
+        return {
+            ImportDeclaration(node) {
+                checkSpecifier(node, node.source.value);
+            },
+            ExportNamedDeclaration(node) {
+                if (node.source) {
+                    checkSpecifier(node, node.source.value);
+                }
+            },
+            ExportAllDeclaration(node) {
+                checkSpecifier(node, node.source.value);
+            },
+            ImportExpression(node) {
+                if (node.source.type === utils_1.AST_NODE_TYPES.Literal && typeof node.source.value === "string") {
+                    checkSpecifier(node, node.source.value);
+                }
+            },
+            CallExpression(node) {
+                const [argument] = node.arguments;
+                if (node.callee.type === utils_1.AST_NODE_TYPES.Identifier &&
+                    node.callee.name === "require" &&
+                    argument?.type === utils_1.AST_NODE_TYPES.Literal &&
+                    typeof argument.value === "string") {
+                    checkSpecifier(node, argument.value);
+                }
+            },
+            TSImportEqualsDeclaration(node) {
+                if (node.moduleReference.type === utils_1.AST_NODE_TYPES.TSExternalModuleReference &&
+                    node.moduleReference.expression.type === utils_1.AST_NODE_TYPES.Literal &&
+                    typeof node.moduleReference.expression.value === "string") {
+                    checkSpecifier(node, node.moduleReference.expression.value);
+                }
+            },
+        };
+    },
+});
+exports.default = rule;
+//# sourceMappingURL=index.js.map

package/src/lib/rules/no-cross-contract-imports/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/eslint-plugin/src/lib/rules/no-cross-contract-imports/index.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,qCAAuC;AACvC,kEAA6B;AAE7B,oDAAyE;AAEzE,iDAA8C;AAE9C,MAAM,wBAAwB,GAAG,uDAAuD,CAAC;AACzF,MAAM,uBAAuB,GAAG,iCAAiC,CAAC;AAElE,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAA8B,CAAC;AAE/D;;;GAGG;AACH,SAAS,kBAAkB,CAAC,SAAiB;IAC3C,IAAI,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QACpC,OAAO,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,IAAwB,CAAC;IAC7B,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IAC1D,IAAI,CAAC;QACH,kHAAkH;QAClH,MAAM,QAAQ,GAAY,IAAI,CAAC,KAAK,CAAC,IAAA,sBAAY,EAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;QACzE,IACE,OAAO,QAAQ,KAAK,QAAQ;YAC5B,QAAQ,KAAK,IAAI;YACjB,MAAM,IAAI,QAAQ;YAClB,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,EACjC,CAAC;YACD,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,sDAAsD;IACxD,CAAC;IAED,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,mBAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACvC,IAAI,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,gBAAgB,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACtC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,iBAAiB,CAAC,SAAiB;IAC1C,OAAO,CACL,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC;QACxC,SAAS,KAAK,uBAAuB;QACrC,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,uBAAuB,GAAG,CAAC,CACrD,CAAC;AACJ,CAAC;AAED,MAAM,IAAI,GAAG,IAAA,uBAAU,EAAC;IACtB,IAAI,EAAE,2BAA2B;IACjC,cAAc,EAAE,EAAE;IAClB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,sHAAsH;SACzH;QACD,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACR,qBAAqB,EACnB,oZAAoZ;SACvZ;KACF;IAED,MAAM,CAAC,OAAO;QACZ,0EAA0E;QAC1E,MAAM,QAAQ,GAAI,OAAmC,CAAC,QAAQ,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QACxF,MAAM,WAAW,GAAG,kBAAkB,CAAC,mBAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/D,IAAI,WAAW,KAAK,SAAS,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7E,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,SAAS,cAAc,CAAC,IAAmB,EAAE,SAAiB;YAC5D,MAAM,YAAY,GAAG,SAAS,KAAK,WAAW,IAAI,SAAS,CAAC,UAAU,CAAC,GAAG,WAAW,GAAG,CAAC,CAAC;YAC1F,IAAI,CAAC,YAAY,IAAI,iBAAiB,CAAC,SAAS,CAAC,EAAE,CAAC;gBAClD,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,SAAS,EAAE,uBAAuB;oBAClC,IAAI,EAAE,EAAE,SAAS,EAAE;iBACpB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO;YACL,iBAAiB,CAAC,IAAI;gBACpB,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;YACD,sBAAsB,CAAC,IAAI;gBACzB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;oBAChB,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;YACD,oBAAoB,CAAC,IAAI;gBACvB,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,CAAC;YACD,gBAAgB,CAAC,IAAI;gBACnB,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACzF,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;YACD,cAAc,CAAC,IAAI;gBACjB,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;gBAClC,IACE,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;oBAC9C,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS;oBAC9B,QAAQ,EAAE,IAAI,KAAK,sBAAc,CAAC,OAAO;oBACzC,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ,EAClC,CAAC;oBACD,cAAc,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;YACH,CAAC;YACD,yBAAyB,CAAC,IAAI;gBAC5B,IACE,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,sBAAc,CAAC,yBAAyB;oBACtE,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO;oBAC/D,OAAO,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,KAAK,KAAK,QAAQ,EACzD,CAAC;oBACD,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC9D,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;kBAEY,IAAI"}