@onrails/eslint-plugin 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alan R. Soares
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,57 @@
+# @onrails/eslint-plugin
+
+ESLint rules for `@onrails/result` boundaries. Replaces the unmaintained `eslint-plugin-neverthrow`.
+
+## Install
+
+```bash
+bun add -d @onrails/eslint-plugin
+```
+
+## Flat config (ESLint 9+)
+
+```js
+// eslint.config.js
+import onrails from "@onrails/eslint-plugin";
+
+export default [
+  {
+    plugins: { "@onrails": onrails },
+    rules: {
+      "@onrails/no-promise-result": "warn",
+      "@onrails/no-unsafe-unwrap": "warn",
+    },
+  },
+];
+```
+
+Or use the recommended preset:
+
+```js
+import onrails from "@onrails/eslint-plugin";
+
+export default [
+  {
+    plugins: { "@onrails": onrails },
+    rules: {
+      ...onrails.configs.recommended.rules,
+    },
+  },
+];
+```
+
+## Rules
+
+| Rule | What it does |
+|---|---|
+| `@onrails/no-promise-result` | Flags `Promise<Result<…>>` in source — public APIs should return `ResultAsync` |
+| `@onrails/no-unsafe-unwrap` | Flags `_unsafeUnwrap*` outside test files |
+
+## Caveats (v0)
+
+- Current rules are **text-scan only**. They catch the common cases but miss `Promise<Result<…>>` hidden inside complex generics. A `@typescript-eslint`-powered AST rule is planned.
+- Spec files (`*.spec.ts`) are exempted from `no-unsafe-unwrap`.
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@onrails/eslint-plugin",
+  "version": "0.1.0",
+  "description": "ESLint rules for @onrails/result boundaries — flags Promise<Result<…>> in public APIs and _unsafeUnwrap*. Replaces unmaintained eslint-plugin-neverthrow.",
+  "license": "MIT",
+  "author": "Alan R. Soares",
+  "homepage": "https://github.com/alanrsoares/onrails/tree/main/packages/eslint-plugin#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alanrsoares/onrails.git",
+    "directory": "packages/eslint-plugin"
+  },
+  "bugs": {
+    "url": "https://github.com/alanrsoares/onrails/issues"
+  },
+  "keywords": [
+    "eslint",
+    "eslint-plugin",
+    "result",
+    "neverthrow",
+    "onrails",
+    "boundary",
+    "lint"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./src/index.js",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "peerDependencies": {
+    "eslint": "^10.4.0"
+  },
+  "peerDependenciesMeta": {
+    "@typescript-eslint/parser": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "typecheck": "echo 'noop (js plugin)'",
+    "test": "bun test",
+    "check": "bun test"
+  },
+  "devDependencies": {
+    "@typescript-eslint/parser": "^8.60.0",
+    "eslint": "^10.4.0"
+  }
+}

package/src/index.js

@@ -0,0 +1,105 @@
+/**
+ * @onrails/eslint-plugin — boundary rules for `@onrails/result`.
+ *
+ * Rules are written against the TypeScript-ESLint AST (`TSTypeReference`,
+ * `MemberExpression`, …). Consumers must use `@typescript-eslint/parser`
+ * for TypeScript files; without it the rules never fire.
+ */
+
+const isIdentifierNamed = (node, name) =>
+  node && node.type === "Identifier" && node.name === name;
+
+const noPromiseResult = {
+  meta: {
+    type: "problem",
+    fixable: "code",
+    docs: {
+      description:
+        "Disallow Promise<Result<…>> in public signatures — return ResultAsync<T, E> instead.",
+    },
+    schema: [],
+    messages: {
+      use: "Promise<Result<{{ok}}, {{err}}>> in public API — return ResultAsync<{{ok}}, {{err}}> and use fromAsync()/tryAsync() at the boundary.",
+    },
+  },
+  create(context) {
+    const sourceCode = context.sourceCode;
+    return {
+      TSTypeReference(node) {
+        if (!isIdentifierNamed(node.typeName, "Promise")) return;
+        const args = node.typeArguments?.params;
+        const inner = args?.[0];
+        if (!inner || inner.type !== "TSTypeReference") return;
+        if (!isIdentifierNamed(inner.typeName, "Result")) return;
+
+        const innerArgs = inner.typeArguments?.params;
+        const okT = innerArgs?.[0];
+        const errT = innerArgs?.[1];
+        const okText = okT ? sourceCode.getText(okT) : "T";
+        const errText = errT ? sourceCode.getText(errT) : "E";
+
+        context.report({
+          node,
+          messageId: "use",
+          data: { ok: okText, err: errText },
+          fix: (fixer) => fixer.replaceText(node, `ResultAsync<${okText}, ${errText}>`),
+        });
+      },
+    };
+  },
+};
+
+const noUnsafeUnwrap = {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Discourage _unsafeUnwrap / _unsafeUnwrapErr outside tests.",
+    },
+    schema: [],
+    messages: {
+      unsafe: "Avoid _unsafeUnwrap* — use match(), resolve(), or yieldResult() in tryGen.",
+    },
+  },
+  create(context) {
+    const filename = context.filename.replace(/\\/g, "/");
+    if (filename.includes(".spec.") || filename.includes(".test.")) {
+      return {};
+    }
+    return {
+      MemberExpression(node) {
+        if (
+          node.property.type === "Identifier" &&
+          (node.property.name === "_unsafeUnwrap" || node.property.name === "_unsafeUnwrapErr")
+        ) {
+          context.report({ node, messageId: "unsafe" });
+        }
+      },
+    };
+  },
+};
+
+/** @type {import('eslint').ESLint.Plugin} */
+const plugin = {
+  meta: {
+    name: "@onrails/eslint-plugin",
+    version: "0.0.0",
+  },
+  rules: {
+    "no-promise-result": noPromiseResult,
+    "no-unsafe-unwrap": noUnsafeUnwrap,
+  },
+};
+
+export default plugin;
+
+export const configs = {
+  recommended: {
+    plugins: {
+      "@onrails/result": plugin,
+    },
+    rules: {
+      "@onrails/result/no-promise-result": "warn",
+      "@onrails/result/no-unsafe-unwrap": "warn",
+    },
+  },
+};