@avi2dg/checks 0.4.0 → 0.5.0

package/README.md

@@ -80,6 +80,48 @@ export default {
 The registry version is pinned by the consumer's lockfile; bump
 `@avi2dg/checks` to adopt a new release.
 
+## Effect rules
+
+The base config loads the `effect-channel` plugin and turns on
+`effect-channel/no-error-channel-escape`, which refuses `Effect.ignore`,
+`Effect.ignoreCause`, the `Effect.catchCause` family, and an
+`Effect.catch` whose handler takes no error or names it `_`.
+
+Two more rules ship off, because a repository writes only some of its
+paths in Effect: code a host loads without `node_modules`, such as a
+hook bundle or this oxlint plugin, cannot import it.
+
+- `effect-channel/no-throw` refuses a `throw` statement.
+- `effect-channel/no-try-catch` refuses a `try` statement with a
+  `catch` clause. `try`/`finally` stays allowed.
+
+Each refusal says what to write instead: a `Schema.TaggedError` failed
+through `Effect.fail`, a throwing call wrapped in `Effect.try` or
+`Effect.tryPromise`, and recovery by tag with `Effect.catchTag`.
+
+A repository turns them on for the paths it writes in Effect through an
+`overrides` entry in its root `.oxlintrc.json`:
+
+```json
+{
+  "extends": ["./node_modules/@avi2dg/checks/oxlintrc.json"],
+  "plugins": ["typescript", "oxc", "eslint", "import"],
+  "overrides": [
+    {
+      "files": ["src/**"],
+      "rules": {
+        "effect-channel/no-throw": "error",
+        "effect-channel/no-try-catch": "error"
+      }
+    }
+  ]
+}
+```
+
+oxlint resolves `files` against the directory of the config that holds
+the override, so a config passed with `-c` from outside the repository
+matches nothing and reports nothing.
+
 ## Test layout
 
 `checks-test-layout` fails unless the repo holds this shape, and names the
@@ -527,7 +569,7 @@ a tag off `main` and reruns the build, `dist/` check, lint, typecheck
 and tests before it publishes:
 
 ```sh
-git tag v0.4.0 && git push origin v0.4.0
+git tag v0.5.0 && git push origin v0.5.0
 ```
 
 The `release` workflow publishes the tagged version through npm

package/dist/index.js

@@ -69,10 +69,52 @@ var rule = {
 };
 var no_error_channel_escape_default = rule;
 
+// effect-channel/no-throw.ts
+var rule2 = {
+  meta: {
+    type: "problem",
+    docs: { description: "Disallow throw, which fails outside Effect's error channel" }
+  },
+  create(context) {
+    return {
+      ThrowStatement(node) {
+        context.report({
+          node,
+          message: "throw escapes the error channel: no type records the failure, so no caller has to answer for it. Define the failure with Schema.TaggedError and fail with it through Effect.fail, so it stays in E for Effect.catchTag to handle"
+        });
+      }
+    };
+  }
+};
+var no_throw_default = rule2;
+
+// effect-channel/no-try-catch.ts
+var rule3 = {
+  meta: {
+    type: "problem",
+    docs: { description: "Disallow a try statement with a catch clause, which recovers outside Effect's error channel" }
+  },
+  create(context) {
+    return {
+      CatchClause(node) {
+        context.report({
+          node,
+          message: "catch recovers outside the error channel: it takes whatever was thrown as unknown, bugs included. Wrap the throwing call in Effect.try or Effect.tryPromise, whose catch maps the cause to a Schema.TaggedError, and recover by tag with Effect.catchTag"
+        });
+      }
+    };
+  }
+};
+var no_try_catch_default = rule3;
+
 // effect-channel/index.ts
 var plugin = {
   meta: { name: "effect-channel" },
-  rules: { "no-error-channel-escape": no_error_channel_escape_default }
+  rules: {
+    "no-error-channel-escape": no_error_channel_escape_default,
+    "no-throw": no_throw_default,
+    "no-try-catch": no_try_catch_default
+  }
 };
 var effect_channel_default = plugin;
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avi2dg/checks",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Deterministic checks shared across the captain's TypeScript repos",
   "license": "MIT",
   "repository": {