@query-doctor/core 0.4.0 → 0.4.1

package/dist/index.js

@@ -27,12 +27,25 @@ function isANode(node) {
 }
 function parseNudges(node, stack) {
   const nudges = [];
-  if (is(node, "A_Star")) {
-    nudges.push({
-      kind: "AVOID_SELECT_STAR",
-      severity: "INFO",
-      message: "Avoid using SELECT *"
-    });
+  if (is(node, "SelectStmt")) {
+    const star = node.SelectStmt.targetList?.find(
+      (target) => {
+        if (!(is(target, "ResTarget") && target.ResTarget.val && is(target.ResTarget.val, "ColumnRef"))) {
+          return false;
+        }
+        return target.ResTarget.val.ColumnRef.fields?.some(
+          (field) => is(field, "A_Star")
+        ) ?? false;
+      }
+    );
+    if (star) {
+      nudges.push({
+        kind: "AVOID_SELECT_STAR",
+        severity: "INFO",
+        message: "Avoid using SELECT *",
+        location: star.ResTarget.location
+      });
+    }
   }
   if (is(node, "FuncCall")) {
     const inWhereClause = stack.some((item) => item === "whereClause");
@@ -42,7 +55,8 @@ function parseNudges(node, stack) {
         nudges.push({
           kind: "AVOID_FUNCTIONS_ON_COLUMNS_IN_WHERE",
           severity: "WARNING",
-          message: "Avoid using functions on columns in WHERE clause"
+          message: "Avoid using functions on columns in WHERE clause",
+          location: node.FuncCall.location
         });
       }
     }
@@ -58,18 +72,24 @@ function parseNudges(node, stack) {
           return is(fromItem, "RangeVar") || is(fromItem, "JoinExpr") && hasActualTablesInJoin(fromItem);
         });
         if (hasActualTables) {
+          const firstTable = node.SelectStmt.fromClause.find(
+            (item) => is(item, "RangeVar")
+          );
+          const fromLocation = firstTable?.RangeVar.location;
           if (!node.SelectStmt.whereClause) {
             nudges.push({
               kind: "MISSING_WHERE_CLAUSE",
               severity: "INFO",
-              message: "Missing WHERE clause"
+              message: "Missing WHERE clause",
+              location: fromLocation
             });
           }
           if (!node.SelectStmt.limitCount) {
             nudges.push({
               kind: "MISSING_LIMIT_CLAUSE",
               severity: "INFO",
-              message: "Missing LIMIT clause"
+              message: "Missing LIMIT clause",
+              location: fromLocation
             });
           }
         }
@@ -85,7 +105,8 @@ function parseNudges(node, stack) {
         nudges.push({
           kind: "USE_IS_NULL_NOT_EQUALS",
           severity: "WARNING",
-          message: "Use IS NULL instead of = or != or <> for NULL comparisons"
+          message: "Use IS NULL instead of = or != or <> for NULL comparisons",
+          location: node.A_Expr.location
         });
       }
     }
@@ -93,10 +114,15 @@ function parseNudges(node, stack) {
     if (isLikeOp && node.A_Expr.rexpr) {
       const patternString = getStringConstantValue(node.A_Expr.rexpr);
       if (patternString && patternString.startsWith("%")) {
+        let stringNode;
+        if (is(node.A_Expr.rexpr, "A_Const")) {
+          stringNode = node.A_Expr.rexpr.A_Const;
+        }
         nudges.push({
           kind: "AVOID_LEADING_WILDCARD_LIKE",
           severity: "WARNING",
-          message: "Avoid using LIKE with leading wildcards"
+          message: "Avoid using LIKE with leading wildcards",
+          location: stringNode?.location
         });
       }
     }
@@ -118,14 +144,15 @@ function parseNudges(node, stack) {
     }
   }
   if (is(node, "SelectStmt") && node.SelectStmt.fromClause && node.SelectStmt.fromClause.length > 1) {
-    const tableCount = node.SelectStmt.fromClause.filter(
+    const tables = node.SelectStmt.fromClause.filter(
       (item) => is(item, "RangeVar")
-    ).length;
-    if (tableCount > 1) {
+    );
+    if (tables.length > 1) {
       nudges.push({
         kind: "MISSING_JOIN_CONDITION",
         severity: "WARNING",
-        message: "Missing JOIN condition"
+        message: "Missing JOIN condition",
+        location: tables[1].RangeVar.location
       });
     }
   }
@@ -135,7 +162,8 @@ function parseNudges(node, stack) {
       nudges.push({
         kind: "CONSIDER_IN_INSTEAD_OF_MANY_ORS",
         severity: "WARNING",
-        message: "Consider using IN instead of many ORs"
+        message: "Consider using IN instead of many ORs",
+        location: node.BoolExpr.location
       });
     }
   }
@@ -151,7 +179,8 @@ function parseNudges(node, stack) {
         nudges.push({
           kind: "REPLACE_LARGE_IN_TUPLE_WITH_ANY_ARRAY",
           message: "`in (...)` queries with large tuples can often be replaced with `= ANY($1)` using a single parameter",
-          severity: "INFO"
+          severity: "INFO",
+          location: node.A_Expr.location
         });
       }
     }
@@ -265,7 +294,7 @@ var Walker = class _Walker {
     this.seenReferences = /* @__PURE__ */ new Map();
     this.shadowedAliases = [];
     this.nudges = [];
-    _Walker.traverse(root, [], (node, stack) => {
+    _Walker.traverse(root, (node, stack) => {
       const nodeNudges = parseNudges(node, stack);
       this.nudges = [...this.nudges, ...nodeNudges];
       if (is2(node, "CommonTableExpr")) {
@@ -458,7 +487,10 @@ var Walker = class _Walker {
     }
     this.highlights.push(ref);
   }
-  static traverse(node, stack, callback) {
+  static traverse(node, callback) {
+    _Walker.doTraverse(node, [], callback);
+  }
+  static doTraverse(node, stack, callback) {
     if (isANode2(node)) {
       callback(node, [...stack, getNodeKind(node)]);
     }
@@ -468,15 +500,19 @@ var Walker = class _Walker {
     if (Array.isArray(node)) {
       for (const item of node) {
         if (isANode2(item)) {
-          _Walker.traverse(item, stack, callback);
+          _Walker.doTraverse(item, stack, callback);
         }
       }
     } else if (isANode2(node)) {
       const keys = Object.keys(node);
-      _Walker.traverse(node[keys[0]], [...stack, getNodeKind(node)], callback);
+      _Walker.doTraverse(node[keys[0]], [...stack, getNodeKind(node)], callback);
     } else {
       for (const [key, child] of Object.entries(node)) {
-        _Walker.traverse(child, [...stack, key], callback);
+        _Walker.doTraverse(
+          child,
+          [...stack, key],
+          callback
+        );
       }
     }
   }