Feat: Expose full context information via API

[wzj-zz]

Thank you for this great plugin! I'd like to request an API to expose full context information

1. All collected context information (including visible range near cursor)

int main(void) {
  if() { //Invisible
    if() { //Invisible
      if() { //visible
        [cursor pos]
      }
    }
  }
}

that can get context like:

int main(void) {
     if() {
      if() {
        if() { //visible

This would make it easier to export context for analyzing trigger conditions of specific code.

[apollo1321]

@lewis6991, what do you think about adding full support for this feature? Would you be open to merging it if a pull request is submitted? I've been using a custom patch for a while and can share it here in the comments if anyone's interested. Just a heads up—this patch requires occasional updates to stay compatible.

diff --git a/lua/treesitter-context.lua b/lua/treesitter-context.lua
index 2e78047..896ccda 100644
--- a/lua/treesitter-context.lua
+++ b/lua/treesitter-context.lua
@@ -285,7 +290,7 @@ function M.go_to_context(depth)
   depth = depth or 1
   local line = api.nvim_win_get_cursor(0)[1]
   local context = nil
-  local contexts = require('treesitter-context.context').get() or {}
+  local contexts = require('treesitter-context.context').get(nil, true) or {}
 
   for idx = #contexts, 1, -1 do
     local c = contexts[idx]
diff --git a/lua/treesitter-context/context.lua b/lua/treesitter-context/context.lua
index 09c261f..eb7aea3 100644
--- a/lua/treesitter-context/context.lua
+++ b/lua/treesitter-context/context.lua
@@ -314,7 +314,7 @@ end
 
 --- @param winid? integer
 --- @return Range4[]?, string[]?
-function M.get(winid)
+function M.get(winid, add_all)
   winid = winid or api.nvim_get_current_win()
   local bufnr = api.nvim_win_get_buf(winid)
 
@@ -348,10 +348,10 @@ function M.get(winid)
   local context_lines = {} --- @type string[][]
   local contexts_height = 0
 
-  for offset = 0, max_lines do
+  for offset = 0, 0 do
     local node_row = row + offset
     local col0 = offset == 0 and col or 0
-    local line_range = { node_row, col0, node_row, col0 + 1 }
+    local line_range = { row, col0, row, col0 + 1 }
 
     context_ranges = {}
     context_lines = {}
@@ -370,7 +370,7 @@ function M.get(winid)
         local contexts_end_row = top_row + separator_offset + num_context_lines
 
         -- Only process the parent if it is not in view.
-        if parent_start_row < contexts_end_row then
+        if parent_start_row < row then
           local range0 = context_range(parent, bufnr, query)
           if range0 and range_is_valid(range0) then
             local range, lines = get_text_for_range(range0, bufnr)
@@ -390,6 +390,12 @@ function M.get(winid)
           end
         end
       end
+
+      local contexts_end_row = top_row + math.min(max_lines, contexts_height)
+
+      if row >= contexts_end_row then
+        break
+      end
     end
 
     local contexts_end_row = top_row + math.min(max_lines, contexts_height)
@@ -399,6 +405,10 @@ function M.get(winid)
     end
   end
 
+  if top_row == 0 and not add_all then
+    return nil, nil
+  end
+
   local trim = contexts_height - max_lines
   if trim > 0 then
     trim_contexts(context_ranges, context_lines, trim, config.trim_scope == 'outer')