@onrails/biome-plugin 0.1.0

package/README.md

@@ -0,0 +1,33 @@
+# @onrails/biome-plugin
+
+Biome GritQL rules for `@onrails/result` boundaries — mirrors `@onrails/eslint-plugin` for projects that lint with Biome.
+
+## Install
+
+```bash
+bun add -d @onrails/biome-plugin @biomejs/biome
+```
+
+## Use
+
+Reference the rule files in `biome.json` plugins:
+
+```jsonc
+{
+  "plugins": [
+    "./node_modules/@onrails/biome-plugin/rules/no-promise-result.grit",
+    "./node_modules/@onrails/biome-plugin/rules/no-unsafe-unwrap.grit"
+  ]
+}
+```
+
+## Rules
+
+| Rule | What it catches |
+|------|------------------|
+| `no-promise-result` | `Promise<Result<T, E>>` in any type position — return `ResultAsync<T, E>` and use `fromAsync` / `tryAsync` at the boundary |
+| `no-unsafe-unwrap`  | `._unsafeUnwrap()` / `._unsafeUnwrapErr()` calls — use `match` / `resolve` / `yieldResult` instead |
+
+## Tests
+
+Fixtures under `fixtures/{valid,invalid}/`. Tests in `src/rules.spec.ts` shell out to `biome lint --reporter=json` and assert message substrings.

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@onrails/biome-plugin",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Biome GritQL plugin: boundary diagnostics for @onrails/result (Promise<Result<…>>, _unsafeUnwrap*).",
+  "license": "MIT",
+  "author": "Alan R. Soares",
+  "homepage": "https://github.com/alanrsoares/onrails/tree/main/packages/biome-plugin#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alanrsoares/onrails.git",
+    "directory": "packages/biome-plugin"
+  },
+  "bugs": {
+    "url": "https://github.com/alanrsoares/onrails/issues"
+  },
+  "keywords": [
+    "biome",
+    "biome-plugin",
+    "gritql",
+    "result",
+    "onrails",
+    "boundary",
+    "lint"
+  ],
+  "engines": {
+    "node": ">=18",
+    "bun": ">=1.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "files": [
+    "rules",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    "./rules/no-promise-result.grit": "./rules/no-promise-result.grit",
+    "./rules/no-unsafe-unwrap.grit": "./rules/no-unsafe-unwrap.grit"
+  },
+  "scripts": {
+    "typecheck": "echo 'noop (grit files only)'",
+    "test": "bun test",
+    "check": "bun test"
+  },
+  "peerDependencies": {
+    "@biomejs/biome": ">=2.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.15"
+  }
+}

package/rules/no-promise-result.grit

@@ -0,0 +1,16 @@
+// @onrails/biome-plugin: no-promise-result
+//
+// Flag `Promise<Result<T, E>>` in type annotations and return types.
+// Public APIs should expose `ResultAsync<T, E>` instead — the boundary
+// helper (`fromAsync` / `tryAsync`) handles the lift.
+
+engine biome(1.0)
+language js
+
+`Promise<Result<$ok, $err>>` as $t where {
+  register_diagnostic(
+    span = $t,
+    message = "Promise<Result<…>> in a type position — use ResultAsync<T, E> at the boundary (fromAsync / tryAsync).",
+    severity = "warn"
+  )
+}

package/rules/no-unsafe-unwrap.grit

@@ -0,0 +1,19 @@
+// @onrails/biome-plugin: no-unsafe-unwrap
+//
+// Flag `._unsafeUnwrap()` and `._unsafeUnwrapErr()` calls — they throw
+// on the unhappy branch and bypass railway semantics. Prefer `match`,
+// `resolve`, or `yieldResult` inside `tryGen`.
+
+engine biome(1.0)
+language js
+
+or {
+  `$_._unsafeUnwrap()` as $call,
+  `$_._unsafeUnwrapErr()` as $call
+} where {
+  register_diagnostic(
+    span = $call,
+    message = "Avoid _unsafeUnwrap* — use match(), resolve(), or yieldResult() in tryGen.",
+    severity = "warn"
+  )
+}