Make document root assertions grammar agnostic

Currently the approach to checking if a node represents the document
root is to check if its `type` is `"source"`. While a lot of grammars do
this by convension it's not part of any spec and some grammars call it
something else - like `"program"`.

This replaces all these assertions with a comparison to see if the node
is :equal() to the tree :root() which is completely grammar agnostic.

Author: julienvincent

lua/nvim-paredit/api/barfing.lua

@@ -1,5 +1,6 @@
 local ts_context = require("nvim-paredit.treesitter.context")
 local ts_forms = require("nvim-paredit.treesitter.forms")
+local ts_utils = require("nvim-paredit.treesitter.utils")
 local traversal = require("nvim-paredit.utils.traversal")
 local indentation = require("nvim-paredit.indentation")
 local common = require("nvim-paredit.utils.common")
@@ -43,7 +44,7 @@ function M.barf_forwards(opts)
   end
 
   local form = traversal.find_closest_form_with_children(current_form, context)
-  if not form or form:type() == "source" then
+  if not form or ts_utils.is_document_root(form) then
     return
   end
 
@@ -117,7 +118,7 @@ function M.barf_backwards(opts)
   end
 
   local form = traversal.find_closest_form_with_children(current_form, context)
-  if not form or form:type() == "source" then
+  if not form or ts_utils.is_document_root(form) then
     return
   end
 

lua/nvim-paredit/api/motions.lua

@@ -223,7 +223,7 @@ local function move_to_parent_form_edge(direction)
     target_form = root:parent()
   end
 
-  if not target_form or target_form:type() == "source" then
+  if not target_form or ts_utils.is_document_root(target_form) then
     return
   end
 

lua/nvim-paredit/api/raising.lua

@@ -1,5 +1,6 @@
 local ts_context = require("nvim-paredit.treesitter.context")
 local ts_forms = require("nvim-paredit.treesitter.forms")
+local ts_utils = require("nvim-paredit.treesitter.utils")
 
 local M = {}
 
@@ -16,19 +17,18 @@ function M.raise_form()
   end
 
   local parent = current_form:parent()
-  if not parent or parent:type() == "source" then
+  if not parent or ts_utils.is_document_root(parent) then
     return
   end
 
   local replace_text = vim.treesitter.get_node_text(current_form, 0)
 
   local parent_range = { parent:range() }
+  -- stylua: ignore
   vim.api.nvim_buf_set_text(
     0,
-    parent_range[1],
-    parent_range[2],
-    parent_range[3],
-    parent_range[4],
+    parent_range[1], parent_range[2],
+    parent_range[3], parent_range[4],
     vim.fn.split(replace_text, "\n")
   )
   vim.api.nvim_win_set_cursor(0, { parent_range[1] + 1, parent_range[2] })
@@ -43,19 +43,18 @@ function M.raise_element()
   local current_node = ts_forms.get_node_root(context.node, context)
 
   local parent = current_node:parent()
-  if not parent or parent:type() == "source" then
+  if not parent or ts_utils.is_document_root(parent) then
     return
   end
 
   local replace_text = vim.treesitter.get_node_text(current_node, 0)
 
   local parent_range = { parent:range() }
+  -- stylua: ignore
   vim.api.nvim_buf_set_text(
     0,
-    parent_range[1],
-    parent_range[2],
-    parent_range[3],
-    parent_range[4],
+    parent_range[1], parent_range[2],
+    parent_range[3], parent_range[4],
     vim.fn.split(replace_text, "\n")
   )
   vim.api.nvim_win_set_cursor(0, { parent_range[1] + 1, parent_range[2] })

lua/nvim-paredit/api/wrap.lua

@@ -21,7 +21,7 @@ local function find_parent_form(element, opts)
     parent = nearest_form:parent()
   end
 
-  if parent and parent:type() ~= "source" then
+  if parent and not ts_utils.is_document_root(parent) then
     return ts_forms.find_nearest_form(parent, {
       captures = opts.captures,
       use_source = false,
@@ -106,7 +106,7 @@ function M.wrap_enclosing_form_under_cursor(prefix, suffix)
     return
   end
 
-  if not use_direct_parent and form:type() ~= "source" then
+  if not use_direct_parent and not ts_utils.is_document_root(form) then
     form = find_parent_form(current_element, context)
   end
 

lua/nvim-paredit/indentation/native.lua

@@ -1,5 +1,6 @@
 local ts_context = require("nvim-paredit.treesitter.context")
 local ts_forms = require("nvim-paredit.treesitter.forms")
+local ts_utils = require("nvim-paredit.treesitter.utils")
 local traversal = require("nvim-paredit.utils.traversal")
 local utils = require("nvim-paredit.indentation.utils")
 local common = require("nvim-paredit.utils.common")
@@ -102,7 +103,7 @@ local function indent_barf(event)
   local lines = utils.find_affected_lines(node, utils.get_node_line_range(node_range))
 
   local delta
-  if parent:type() == "source" then
+  if ts_utils.is_document_root(parent) then
     delta = node_range[2]
   else
     local row

lua/nvim-paredit/treesitter/utils.lua

@@ -2,13 +2,17 @@ local common = require("nvim-paredit.utils.common")
 
 local M = {}
 
+function M.is_document_root(node)
+  return node and node:tree():root():equal(node)
+end
+
 -- Find the root node of the tree `node` is a member of, excluding the root
 -- 'source' document.
 function M.find_local_root(node)
   local current = node
   while true do
     local next = current:parent()
-    if not next or next:type() == "source" then
+    if not next or M.is_document_root(next) then
       break
     end
     current = next

lua/nvim-paredit/utils/traversal.lua

@@ -49,7 +49,7 @@ end
 
 function M.find_closest_form_with_children(current_node, opts)
   local form = ts_forms.get_form_inner(current_node, opts)
-  if form:named_child_count() > 0 and current_node:type() ~= "source" then
+  if form:named_child_count() > 0 and not ts_utils.is_document_root(current_node) then
     return form
   end