pkgcheck/bash: sort captures by line and column

It has been observed that the order of nodes returned by tree-sitter's
QueryCursor is not necessarily in order wrt line and column in the
source, but it appears that some of pkgcheck's usage of tree-sitter
assumes that captured nodes are returned in order.

There doesn't appear to any features in QueryCursor (or other places)
that allows one to specify that returned nodes should be ordered in a
specific way, so instead we introduce a decorator on QueryCursor that
takes dict of captured nodes and sorts each list of nodes by line and
column.

Signed-off-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz>

Author: laumann

src/pkgcheck/bash/__init__.py

@@ -19,8 +19,32 @@ def query(query_str: str) -> "QueryCursor":
 
 parser = Parser(language=lang)
 
+
+class SortedQuery:
+    """
+    Sort query results by line and column. It's been observed that
+    query results are not consistently returned in the same order
+    """
+
+    def __init__(self, query_cursor: QueryCursor):
+        self._query_cursor = query_cursor
+
+    def captures(self, node):
+        # QueryCursor.captures() returns a dict of lists, we decorate
+        # it and return the sorted lists
+        caps = self._query_cursor.captures(node)
+        return {
+            key: sorted(nodes, key=lambda n: (n.start_point.row, n.start_point.column))
+            for key, nodes in caps.items()
+        }
+
+
+def sorted_query(query_str: str):
+    return SortedQuery(query(query_str))
+
+
 # various parse tree queries
-cmd_query = query("(command) @call")
+cmd_query = sorted_query("(command) @call")
 func_query = query("(function_definition) @func")
 var_assign_query = query("(variable_assignment) @assign")
 var_expansion_query = query("(expansion) @exp")