Ban Effect escape hatches

Rhys Sullivan committed 6 months ago

Commit 427d4e21 parent 10d34f84 files · +57 −0Browse files

Showing the changes to scripts (2 of 4 files). Show all

Unified · Split

2 files

 import noConditionalTests from "./oxlint-plugin-executor/rules/no-conditional-tests.js";
 import noCrossPackageRelativeImports from "./oxlint-plugin-executor/rules/no-cross-package-relative-imports.js";
 import noDoubleCast from "./oxlint-plugin-executor/rules/no-double-cast.js";
+import noEffectEscapeHatch from "./oxlint-plugin-executor/rules/no-effect-escape-hatch.js";
 import noEffectInternalTags from "./oxlint-plugin-executor/rules/no-effect-internal-tags.js";
 import noErrorConstructor from "./oxlint-plugin-executor/rules/no-error-constructor.js";
 import noInlineObjectTypeAssertion from "./oxlint-plugin-executor/rules/no-inline-object-type-assertion.js";
     "no-double-cast": noDoubleCast,
     "no-cross-package-relative-imports": noCrossPackageRelativeImports,
     "require-reactivity-keys": requireReactivityKeys,
+    "no-effect-escape-hatch": noEffectEscapeHatch,
     "no-effect-internal-tags": noEffectInternalTags,
     "no-error-constructor": noErrorConstructor,
     "no-ts-nocheck": noTsNocheck,

@@ -0,0 +1,33 @@
	1	import { getPropertyName, isTestLike, unwrapExpression } from "../utils.js";
	2
	3	const escapeHatches = new Set(["die", "dieMessage", "orDie", "orDieWith"]);
	4
	5	const message =
	6	"Do not collapse Effect failures with die/orDie escape hatches. Keep typed errors in the Effect error channel; at true runtime edges use a narrow boundary suppression. Skill: wrdn-effect-typed-errors.";
	7
	8	const isEffectEscapeHatch = (node) => {
	9	const expression = unwrapExpression(node);
	10	if (expression?.type !== "MemberExpression") return false;
	11	const property = getPropertyName(expression.property);
	12	return escapeHatches.has(property);
	13	};
	14
	15	export default {
	16	meta: {
	17	type: "problem",
	18	docs: {
	19	description: "Disallow Effect die/orDie escape hatches outside test code.",
	20	},
	21	},
	22	create(context) {
	23	if (isTestLike(context.filename)) return {};
	24
	25	return {
	26	MemberExpression(node) {
	27	if (isEffectEscapeHatch(node)) {
	28	context.report({ node, message });
	29	}
	30	},
	31	};
	32	},
	33	};