helper, update grammar

Author: juleswritescode

crates/pgt_treesitter/src/context/mod.rs

@@ -826,6 +826,42 @@ impl<'a> TreesitterContext<'a> {
             .unwrap_or(0)
     }
 
+    /// Returns true if the node under the cursor matches the field_name OR has a parent that matches the field_name.
+    pub fn node_under_cursor_is_within_field_name(&self, name: &str) -> bool {
+        self.node_under_cursor
+            .as_ref()
+            .map(|n| match n {
+                NodeUnderCursor::TsNode(node) => {
+                    // It might seem weird that we have to check for the field_name from the parent,
+                    // but TreeSitter wants it this way, since nodes often can only be named in
+                    // the context of their parents.
+                    let root_node = self.tree.root_node();
+                    let mut cursor = node.walk();
+                    let mut parent = node.parent();
+
+                    while let Some(p) = parent {
+                        if p == root_node {
+                            break;
+                        }
+
+                        if p.children_by_field_name(name, &mut cursor).any(|c| {
+                            let r = c.range();
+                            // if the parent range contains the node range, the node is of the field_name.
+                            r.start_byte <= node.start_byte() && r.end_byte >= node.end_byte()
+                        }) {
+                            return true;
+                        } else {
+                            parent = p.parent();
+                        }
+                    }
+
+                    return false;
+                }
+                NodeUnderCursor::CustomNode { .. } => false,
+            })
+            .unwrap_or(false)
+    }
+
     pub fn get_mentioned_relations(&self, key: &Option<String>) -> Option<&HashSet<String>> {
         if let Some(key) = key.as_ref() {
             let sanitized_key = key.replace('"', "");
@@ -1214,4 +1250,26 @@ mod tests {
             _ => unreachable!(),
         }
     }
+
+    #[test]
+    fn tryout_node_field() {
+        let query = format!(
+            r#"create table foo (id int not null, compfoo som{}e_type);"#,
+            QueryWithCursorPosition::cursor_marker()
+        );
+
+        let (position, text) = QueryWithCursorPosition::from(query).get_text_and_position();
+
+        let tree = get_tree(text.as_str());
+
+        let params = TreeSitterContextParams {
+            position: (position as u32).into(),
+            text: &text,
+            tree: &tree,
+        };
+
+        let ctx = TreesitterContext::new(params);
+
+        assert!(ctx.node_under_cursor_is_within_field_name("custom_type"));
+    }
 }

crates/pgt_treesitter_grammar/grammar.js

@@ -484,7 +484,7 @@ module.exports = grammar({
 
     keyword_array: (_) => make_keyword("array"), // not included in _type since it's a constructor literal
 
-    _type: ($) =>
+    type: ($) =>
       prec.left(
         seq(
           choice(
@@ -857,7 +857,7 @@ module.exports = grammar({
       seq(
         optional($._argmode),
         optional($.identifier),
-        $._type,
+        $.type,
         optional(seq(choice($.keyword_default, "="), $.literal))
       ),
 
@@ -1234,8 +1234,8 @@ module.exports = grammar({
         $.function_arguments,
         $.keyword_returns,
         choice(
-          $._type,
-          seq($.keyword_setof, $._type),
+          $.type,
+          seq($.keyword_setof, $.type),
           seq($.keyword_table, $.column_definitions),
           $.keyword_trigger
         ),
@@ -1275,7 +1275,7 @@ module.exports = grammar({
     function_declaration: ($) =>
       seq(
         $.identifier,
-        $._type,
+        $.type,
         optional(
           seq(
             ":=",
@@ -1523,7 +1523,7 @@ module.exports = grammar({
         $.object_reference,
         repeat(
           choice(
-            seq($.keyword_as, $._type),
+            seq($.keyword_as, $.type),
             seq(
               $.keyword_increment,
               optional($.keyword_by),
@@ -1781,7 +1781,7 @@ module.exports = grammar({
           seq(
             optional(seq($.keyword_set, $.keyword_data)),
             $.keyword_type,
-            field("type", $._type)
+            field("type", $.type)
           ),
           seq(
             $.keyword_set,
@@ -1975,7 +1975,7 @@ module.exports = grammar({
         choice(
           repeat1(
             choice(
-              seq($.keyword_as, $._type),
+              seq($.keyword_as, $.type),
               seq($.keyword_increment, optional($.keyword_by), $.literal),
               seq(
                 $.keyword_minvalue,
@@ -2057,7 +2057,7 @@ module.exports = grammar({
           ),
           seq(
             choice(
-              seq($.keyword_add, $.keyword_attribute, $.identifier, $._type),
+              seq($.keyword_add, $.keyword_attribute, $.identifier, $.type),
               seq(
                 $.keyword_drop,
                 $.keyword_attribute,
@@ -2070,7 +2070,7 @@ module.exports = grammar({
                 $.identifier,
                 optional(seq($.keyword_set, $.keyword_data)),
                 $.keyword_type,
-                $._type
+                $.type
               )
             ),
             optional(seq($.keyword_collate, $.identifier)),
@@ -2624,7 +2624,7 @@ module.exports = grammar({
     column_definition: ($) =>
       seq(
         field("name", $._column),
-        field("type", $._type),
+        field("type", $.type),
         repeat($._column_constraint)
       ),
 
@@ -2810,7 +2810,7 @@ module.exports = grammar({
         field("name", $.identifier)
       ),
 
-    implicit_cast: ($) => seq($._expression, "::", $._type),
+    implicit_cast: ($) => seq($._expression, "::", $.type),
 
     // Postgres syntax for intervals
     interval: ($) => seq($.keyword_interval, $._literal_string),
@@ -2819,7 +2819,7 @@ module.exports = grammar({
       seq(
         field("name", $.keyword_cast),
         wrapped_in_parenthesis(
-          seq(field("parameter", $._expression), $.keyword_as, $._type)
+          seq(field("parameter", $._expression), $.keyword_as, $.type)
         )
       ),