eslint-plugin-absolute 0.1.2 → 0.1.4

package/dist/index.js

@@ -1162,43 +1162,69 @@ var no_button_navigation_default = {
     schema: []
   },
   create(context) {
+    function urlUsesAllowedLocation(argNode) {
+      let allowed = false;
+      const visited = new WeakSet;
+      function check(n) {
+        if (allowed || !n || typeof n !== "object" || visited.has(n))
+          return;
+        visited.add(n);
+        if (n.type === "MemberExpression" && n.object.type === "MemberExpression" && n.object.object.type === "Identifier" && n.object.object.name === "window" && n.object.property.type === "Identifier" && n.object.property.name === "location" && n.property.type === "Identifier" && (n.property.name === "pathname" || n.property.name === "search" || n.property.name === "hash")) {
+          allowed = true;
+          return;
+        }
+        for (const key of Object.keys(n)) {
+          if (key === "parent")
+            continue;
+          const child = n[key];
+          if (Array.isArray(child)) {
+            child.forEach((c) => check(c));
+          } else {
+            check(child);
+          }
+        }
+      }
+      check(argNode);
+      return allowed;
+    }
     function containsWindowNavigation(node) {
-      let found = false;
+      let reason = null;
+      const visited = new WeakSet;
+      let sawReplaceCall = false;
+      let sawAllowedLocationRead = false;
       function inspect(n, parent) {
-        if (found || !n || typeof n !== "object")
+        if (reason || !n || typeof n !== "object" || visited.has(n))
           return;
+        visited.add(n);
         if (n.type === "MemberExpression" && n.object.type === "Identifier" && n.object.name === "window" && n.property.type === "Identifier" && n.property.name === "open") {
-          found = true;
+          reason = "window.open";
           return;
         }
         if (n.type === "AssignmentExpression" && n.left.type === "MemberExpression") {
           const left = n.left;
           if (left.object.type === "Identifier" && left.object.name === "window" && left.property.type === "Identifier" && left.property.name === "location") {
-            found = true;
+            reason = "assignment to window.location";
             return;
           }
           if (left.object.type === "MemberExpression" && left.object.object.type === "Identifier" && left.object.object.name === "window" && left.object.property.type === "Identifier" && left.object.property.name === "location") {
-            found = true;
+            reason = "assignment to window.location sub-property";
             return;
           }
         }
         if (n.type === "MemberExpression" && n.object.type === "MemberExpression" && n.object.object.type === "Identifier" && n.object.object.name === "window" && n.object.property.type === "Identifier" && n.object.property.name === "location" && n.property.type === "Identifier" && n.property.name === "replace") {
           if (parent && parent.type === "CallExpression") {
-            found = true;
+            reason = "window.location.replace";
             return;
           }
         }
         if (n.type === "MemberExpression" && n.object.type === "MemberExpression" && n.object.object.type === "Identifier" && n.object.object.name === "window" && n.object.property.type === "Identifier" && n.object.property.name === "history" && n.property.type === "Identifier" && (n.property.name === "pushState" || n.property.name === "replaceState")) {
-          if (parent && parent.type === "CallExpression" && Array.isArray(parent.arguments) && parent.arguments.length >= 3) {
-            const urlArg = parent.arguments[2];
-            if (!urlUsesAllowedLocation(urlArg)) {
-              found = true;
-              return;
-            }
-          }
+          sawReplaceCall = true;
+        }
+        if (n.type === "MemberExpression" && n.object.type === "MemberExpression" && n.object.object.type === "Identifier" && n.object.object.name === "window" && n.object.property.type === "Identifier" && n.object.property.name === "location" && n.property.type === "Identifier" && (n.property.name === "search" || n.property.name === "pathname" || n.property.name === "hash")) {
+          sawAllowedLocationRead = true;
         }
         for (const key of Object.keys(n)) {
-          if (key === "parent")
+          if (key === "parent" || reason)
             continue;
           const child = n[key];
           if (Array.isArray(child)) {
@@ -1206,33 +1232,21 @@ var no_button_navigation_default = {
           } else {
             inspect(child, n);
           }
-        }
-      }
-      function urlUsesAllowedLocation(argNode) {
-        let allowed = false;
-        function check(n) {
-          if (allowed || !n || typeof n !== "object")
+          if (reason)
             return;
-          if (n.type === "MemberExpression" && n.object.type === "MemberExpression" && n.object.object.type === "Identifier" && n.object.object.name === "window" && n.object.property.type === "Identifier" && n.object.property.name === "location" && n.property.type === "Identifier" && (n.property.name === "pathname" || n.property.name === "search" || n.property.name === "hash")) {
-            allowed = true;
-            return;
-          }
-          for (const key of Object.keys(n)) {
-            if (key === "parent")
-              continue;
-            const c = n[key];
-            if (Array.isArray(c)) {
-              c.forEach(check);
-            } else {
-              check(c);
-            }
-          }
         }
-        check(argNode);
-        return allowed;
       }
       inspect(node.type === "ArrowFunctionExpression" || node.type === "FunctionExpression" ? node.body : node, null);
-      return found;
+      if (reason) {
+        return { shouldReport: true, reason };
+      }
+      if (sawReplaceCall && !sawAllowedLocationRead) {
+        return {
+          shouldReport: true,
+          reason: "history.replace/pushState without reading window.location"
+        };
+      }
+      return { shouldReport: false, reason: null };
     }
     return {
       JSXElement(node) {
@@ -1241,11 +1255,14 @@ var no_button_navigation_default = {
           for (const attr of openingElement.attributes) {
             if (attr.type === "JSXAttribute" && attr.name.name === "onClick" && attr.value?.type === "JSXExpressionContainer") {
               const expr = attr.value.expression;
-              if ((expr.type === "ArrowFunctionExpression" || expr.type === "FunctionExpression") && containsWindowNavigation(expr)) {
-                context.report({
-                  node: attr,
-                  message: "Use an anchor tag for navigation instead of a button with an onClick handler that changes the path. Only query/hash updates are allowed."
-                });
+              if (expr.type === "ArrowFunctionExpression" || expr.type === "FunctionExpression") {
+                const { shouldReport, reason } = containsWindowNavigation(expr);
+                if (shouldReport) {
+                  context.report({
+                    node: attr,
+                    message: `Use an anchor tag for navigation instead of a button whose onClick handler changes the path. ` + `Detected: ${reason}. Only query/hash updates (reading window.location.search, .pathname, or .hash) are allowed.`
+                  });
+                }
               }
             }
           }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-absolute",
-	"version": "0.1.2",
+	"version": "0.1.4",
 	"description": "ESLint plugin for AbsoluteJS",
 	"repository": {
 		"type": "git",

package/src/rules/no-button-navigation.js

@@ -10,11 +10,65 @@ export default {
 		schema: []
 	},
 	create(context) {
+		/**
+		 * Returns true if the given AST subtree contains a MemberExpression of
+		 * the form `window.location.pathname`, `window.location.search`, or `window.location.hash`.
+		 */
+		function urlUsesAllowedLocation(argNode) {
+			let allowed = false;
+			const visited = new WeakSet();
+
+			function check(n) {
+				if (allowed || !n || typeof n !== "object" || visited.has(n))
+					return;
+				visited.add(n);
+
+				if (
+					n.type === "MemberExpression" &&
+					n.object.type === "MemberExpression" &&
+					n.object.object.type === "Identifier" &&
+					n.object.object.name === "window" &&
+					n.object.property.type === "Identifier" &&
+					n.object.property.name === "location" &&
+					n.property.type === "Identifier" &&
+					(n.property.name === "pathname" ||
+						n.property.name === "search" ||
+						n.property.name === "hash")
+				) {
+					allowed = true;
+					return;
+				}
+
+				for (const key of Object.keys(n)) {
+					if (key === "parent") continue;
+					const child = n[key];
+					if (Array.isArray(child)) {
+						child.forEach((c) => check(c));
+					} else {
+						check(child);
+					}
+				}
+			}
+
+			check(argNode);
+			return allowed;
+		}
+
+		/**
+		 * Returns an object { shouldReport, reason } after inspecting the
+		 * function body for forbidden patterns.  - shouldReport is true if
+		 * we must flag.  - reason explains which pattern was found.
+		 */
 		function containsWindowNavigation(node) {
-			let found = false;
+			let reason = null;
+			const visited = new WeakSet();
+			let sawReplaceCall = false;
+			let sawAllowedLocationRead = false;
 
 			function inspect(n, parent) {
-				if (found || !n || typeof n !== "object") return;
+				if (reason || !n || typeof n !== "object" || visited.has(n))
+					return;
+				visited.add(n);
 
 				// 1) window.open(...)
 				if (
@@ -24,11 +78,11 @@ export default {
 					n.property.type === "Identifier" &&
 					n.property.name === "open"
 				) {
-					found = true;
+					reason = "window.open";
 					return;
 				}
 
-				// 2) Assignment to window.location or window.location.something (e.g. window.location = "...", window.location.href = "...")
+				// 2) Assignment to window.location or window.location.*
 				if (
 					n.type === "AssignmentExpression" &&
 					n.left.type === "MemberExpression"
@@ -42,11 +96,11 @@ export default {
 						left.property.type === "Identifier" &&
 						left.property.name === "location"
 					) {
-						found = true;
+						reason = "assignment to window.location";
 						return;
 					}
 
-					// window.location.href = ...  OR  window.location.pathname = ...
+					// window.location.href = ...  OR  window.location.pathname =
 					if (
 						left.object.type === "MemberExpression" &&
 						left.object.object.type === "Identifier" &&
@@ -54,13 +108,12 @@ export default {
 						left.object.property.type === "Identifier" &&
 						left.object.property.name === "location"
 					) {
-						// any assignment to a sub-property of window.location (href, pathname, etc.) = navigation
-						found = true;
+						reason = "assignment to window.location sub-property";
 						return;
 					}
 				}
 
-				// 3) window.location.replace(...)  (or any call on window.location.* besides .search/.hash)
+				// 3) window.location.replace(...) (or any call on window.location besides .search/.hash)
 				if (
 					n.type === "MemberExpression" &&
 					n.object.type === "MemberExpression" &&
@@ -71,14 +124,13 @@ export default {
 					n.property.type === "Identifier" &&
 					n.property.name === "replace"
 				) {
-					// parent should be a CallExpression
 					if (parent && parent.type === "CallExpression") {
-						found = true;
+						reason = "window.location.replace";
 						return;
 					}
 				}
 
-				// 4) window.history.pushState(...) or window.history.replaceState(...)
+				// 4) window.history.pushState(...) or replaceState(...)
 				if (
 					n.type === "MemberExpression" &&
 					n.object.type === "MemberExpression" &&
@@ -90,69 +142,38 @@ export default {
 					(n.property.name === "pushState" ||
 						n.property.name === "replaceState")
 				) {
-					if (
-						parent &&
-						parent.type === "CallExpression" &&
-						Array.isArray(parent.arguments) &&
-						parent.arguments.length >= 3
-					) {
-						const urlArg = parent.arguments[2];
-						if (!urlUsesAllowedLocation(urlArg)) {
-							found = true;
-							return;
-						}
-						// If urlArg references window.location.pathname/search/hash → allowed
-					}
+					sawReplaceCall = true;
+				}
+
+				// 5) Reading window.location.search, .pathname, or .hash
+				if (
+					n.type === "MemberExpression" &&
+					n.object.type === "MemberExpression" &&
+					n.object.object.type === "Identifier" &&
+					n.object.object.name === "window" &&
+					n.object.property.type === "Identifier" &&
+					n.object.property.name === "location" &&
+					n.property.type === "Identifier" &&
+					(n.property.name === "search" ||
+						n.property.name === "pathname" ||
+						n.property.name === "hash")
+				) {
+					sawAllowedLocationRead = true;
 				}
 
-				// Recurse into all child nodes
+				// Recurse into children
 				for (const key of Object.keys(n)) {
-					if (key === "parent") continue;
+					if (key === "parent" || reason) continue;
 					const child = n[key];
 					if (Array.isArray(child)) {
 						child.forEach((c) => inspect(c, n));
 					} else {
 						inspect(child, n);
 					}
+					if (reason) return;
 				}
 			}
 
-			function urlUsesAllowedLocation(argNode) {
-				let allowed = false;
-
-				function check(n) {
-					if (allowed || !n || typeof n !== "object") return;
-					// Look for window.location.pathname, .search, or .hash anywhere
-					if (
-						n.type === "MemberExpression" &&
-						n.object.type === "MemberExpression" &&
-						n.object.object.type === "Identifier" &&
-						n.object.object.name === "window" &&
-						n.object.property.type === "Identifier" &&
-						n.object.property.name === "location" &&
-						n.property.type === "Identifier" &&
-						(n.property.name === "pathname" ||
-							n.property.name === "search" ||
-							n.property.name === "hash")
-					) {
-						allowed = true;
-						return;
-					}
-					for (const key of Object.keys(n)) {
-						if (key === "parent") continue;
-						const c = n[key];
-						if (Array.isArray(c)) {
-							c.forEach(check);
-						} else {
-							check(c);
-						}
-					}
-				}
-
-				check(argNode);
-				return allowed;
-			}
-
 			inspect(
 				node.type === "ArrowFunctionExpression" ||
 					node.type === "FunctionExpression"
@@ -160,7 +181,17 @@ export default {
 					: node,
 				null
 			);
-			return found;
+
+			if (reason) {
+				return { shouldReport: true, reason };
+			}
+			if (sawReplaceCall && !sawAllowedLocationRead) {
+				return {
+					shouldReport: true,
+					reason: "history.replace/pushState without reading window.location"
+				};
+			}
+			return { shouldReport: false, reason: null };
 		}
 
 		return {
@@ -178,15 +209,19 @@ export default {
 						) {
 							const expr = attr.value.expression;
 							if (
-								(expr.type === "ArrowFunctionExpression" ||
-									expr.type === "FunctionExpression") &&
-								containsWindowNavigation(expr)
+								expr.type === "ArrowFunctionExpression" ||
+								expr.type === "FunctionExpression"
 							) {
-								context.report({
-									node: attr,
-									message:
-										"Use an anchor tag for navigation instead of a button with an onClick handler that changes the path. Only query/hash updates are allowed."
-								});
+								const { shouldReport, reason } =
+									containsWindowNavigation(expr);
+								if (shouldReport) {
+									context.report({
+										node: attr,
+										message:
+											`Use an anchor tag for navigation instead of a button whose onClick handler changes the path. ` +
+											`Detected: ${reason}. Only query/hash updates (reading window.location.search, .pathname, or .hash) are allowed.`
+									});
+								}
 							}
 						}
 					}