@onrails/eslint-plugin 0.1.0 → 0.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onrails/eslint-plugin",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "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",
@@ -49,9 +49,9 @@
     }
   },
   "scripts": {
-    "typecheck": "echo 'noop (js plugin)'",
+    "typecheck": "tsc --noEmit",
     "test": "bun test",
-    "check": "bun test"
+    "check": "bun run typecheck && bun test"
   },
   "devDependencies": {
     "@typescript-eslint/parser": "^8.60.0",

package/src/index.js

@@ -6,9 +6,48 @@
  * for TypeScript files; without it the rules never fire.
  */
 
+/**
+ * Loose AST-node shape — typescript-eslint nodes (TSTypeReference, …) are not
+ * part of ESLint's bundled estree types, so rules narrow on `type` manually.
+ *
+ * @param {{ type: string; name?: string } | null | undefined} node
+ * @param {string} name
+ * @returns {boolean}
+ */
 const isIdentifierNamed = (node, name) =>
-  node && node.type === "Identifier" && node.name === name;
+  Boolean(node && node.type === "Identifier" && node.name === name);
+
+/**
+ * Minimal structural view of `@typescript-eslint/parser`'s TSTypeReference —
+ * only the fields these rules read. ESLint's bundled types know estree alone,
+ * so TS-AST visitors type their own slice and bridge at report boundaries.
+ *
+ * @typedef {object} TsTypeReference
+ * @property {string} type
+ * @property {{ type: string; name?: string }} typeName
+ * @property {{ params: TsTypeReference[] } | undefined} [typeArguments]
+ */
+
+/**
+ * Safe: TS-AST nodes carry the same range/loc contract ESLint needs; the
+ * bundled estree types just cannot name them.
+ *
+ * @param {TsTypeReference} node
+ * @returns {import('eslint').Rule.Node}
+ */
+const asReportable = (node) =>
+  /** @type {import('eslint').Rule.Node} */ (/** @type {unknown} */ (node));
 
+/**
+ * Safe: the `TSTypeReference` visitor key guarantees the parser produced a
+ * typescript-eslint TSTypeReference node.
+ *
+ * @param {import('eslint').Rule.Node} node
+ * @returns {TsTypeReference}
+ */
+const asTsTypeReference = (node) => /** @type {TsTypeReference} */ (/** @type {unknown} */ (node));
+
+/** @type {import('eslint').Rule.RuleModule} */
 const noPromiseResult = {
   meta: {
     type: "problem",
@@ -25,18 +64,19 @@ const noPromiseResult = {
   create(context) {
     const sourceCode = context.sourceCode;
     return {
-      TSTypeReference(node) {
-        if (!isIdentifierNamed(node.typeName, "Promise")) return;
-        const args = node.typeArguments?.params;
+      TSTypeReference(/** @type {import('eslint').Rule.Node} */ node) {
+        const typeRef = asTsTypeReference(node);
+        if (!isIdentifierNamed(typeRef.typeName, "Promise")) return;
+        const args = typeRef.typeArguments?.params;
         const inner = args?.[0];
-        if (!inner || inner.type !== "TSTypeReference") return;
+        if (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";
+        const okText = okT ? sourceCode.getText(asReportable(okT)) : "T";
+        const errText = errT ? sourceCode.getText(asReportable(errT)) : "E";
 
         context.report({
           node,
@@ -49,15 +89,18 @@ const noPromiseResult = {
   },
 };
 
+/** @type {import('eslint').Rule.RuleModule} */
 const noUnsafeUnwrap = {
   meta: {
     type: "suggestion",
     docs: {
-      description: "Discourage _unsafeUnwrap / _unsafeUnwrapErr outside tests.",
+      description:
+        "Discourage _unsafeUnwrap / _unsafeUnwrapErr and unwrapOk / unwrapErr / unwrap outside tests. Matching is name-based; same-named functions from other libraries are flagged too.",
     },
     schema: [],
     messages: {
-      unsafe: "Avoid _unsafeUnwrap* — use match(), resolve(), or yieldResult() in tryGen.",
+      unsafe:
+        "Avoid _unsafeUnwrap* and unwrap* outside tests — use match(), resolve(), or yieldResult() in tryGen.",
     },
   },
   create(context) {
@@ -74,6 +117,16 @@ const noUnsafeUnwrap = {
           context.report({ node, messageId: "unsafe" });
         }
       },
+      CallExpression(node) {
+        if (
+          node.callee.type === "Identifier" &&
+          (node.callee.name === "unwrapOk" ||
+            node.callee.name === "unwrapErr" ||
+            node.callee.name === "unwrap")
+        ) {
+          context.report({ node, messageId: "unsafe" });
+        }
+      },
     };
   },
 };