Merge branch 'stevearc:master' into snacks-auto-place-cursor

Author: YosefBayoude

.github/workflows/tests.yml

@@ -11,7 +11,7 @@ on:
 jobs:
   luacheck:
     name: Luacheck
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
 
@@ -27,7 +27,7 @@ jobs:
 
   typecheck:
     name: typecheck
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: stevearc/nvim-typecheck-action@v2
@@ -37,7 +37,7 @@ jobs:
 
   stylua:
     name: StyLua
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - name: Stylua
@@ -52,11 +52,11 @@ jobs:
       matrix:
         include:
           - nvim_tag: v0.9.4
-          - nvim_tag: v0.10.0
           - nvim_tag: v0.10.4
+          - nvim_tag: v0.11.0
 
     name: Run tests
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     env:
       NVIM_TAG: ${{ matrix.nvim_tag }}
     steps:
@@ -83,7 +83,7 @@ jobs:
 
   update_docs:
     name: Update docs
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
 
@@ -120,7 +120,7 @@ jobs:
       - run_tests
       - typecheck
       - update_docs
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: googleapis/release-please-action@v4
         id: release

lua/aerial/backends/treesitter/extensions.lua

@@ -18,7 +18,7 @@ local default_methods = {
   get_parent = function(stack, match, node)
     for i = #stack, 1, -1 do
       local last_node = stack[i].node
-      if vim.treesitter.is_ancestor(last_node, node) then
+      if last_node == node or vim.treesitter.is_ancestor(last_node, node) then
         return stack[i].item, last_node, i
       else
         table.remove(stack, i)

lua/aerial/backends/treesitter/init.lua

@@ -11,6 +11,9 @@ local M = {}
 -- start (optional): The location of the start of this symbol (default @symbol)
 -- end (optional): The location of the end of this symbol (default @start)
 
+---@param bufnr? integer
+---@return boolean
+---@return string? msg
 M.is_supported = function(bufnr)
   local lang = helpers.get_buf_lang(bufnr)
   if not helpers.has_parser(lang) then
@@ -22,28 +25,23 @@ M.is_supported = function(bufnr)
   return true, nil
 end
 
-M.fetch_symbols_sync = function(bufnr)
-  bufnr = bufnr or 0
-  local extensions = require("aerial.backends.treesitter.extensions")
-  local get_node_text = vim.treesitter.get_node_text
-  local include_kind = config.get_filter_kind_map(bufnr)
-  local parser = helpers.get_parser(bufnr)
-  local items = {}
-  if not parser then
-    backends.set_symbols(bufnr, items, { backend_name = "treesitter", lang = "unknown" })
-    return
-  end
-  local lang = parser:lang()
-  local syntax_tree = parser:parse()[1]
-  local query = helpers.get_query(lang)
-  if not query or not syntax_tree then
+---@param bufnr integer
+---@param lang string
+---@param query vim.treesitter.Query
+---@param syntax_tree? TSTree
+local function set_symbols_from_treesitter(bufnr, lang, query, syntax_tree)
+  if not syntax_tree then
     backends.set_symbols(
       bufnr,
-      items,
+      {},
       { backend_name = "treesitter", lang = lang, syntax_tree = syntax_tree }
     )
     return
   end
+  local extensions = require("aerial.backends.treesitter.extensions")
+  local get_node_text = vim.treesitter.get_node_text
+  local include_kind = config.get_filter_kind_map(bufnr)
+  local items = {}
   -- This will track a loose hierarchy of recent node+items.
   -- It is used to determine node parents for the tree structure.
   local stack = {}
@@ -79,26 +77,33 @@ M.fetch_symbols_sync = function(bufnr)
     local name_match = match.name or {}
     local selection_match = match.selection or {}
     local symbol_node = (match.symbol or match.type or {}).node
+    if not symbol_node then
+      goto continue
+    end
     -- The location capture groups are optional. We default to the
     -- location of the @symbol capture
     local start_node = (match.start or {}).node or symbol_node
     local end_node = (match["end"] or {}).node or start_node
     local parent_item, parent_node, level = ext.get_parent(stack, match, symbol_node)
     -- Sometimes our queries will match the same node twice.
     -- Detect that (symbol_node == parent_node), and skip dupes.
-    if not symbol_node or symbol_node == parent_node then
+    if symbol_node == parent_node then
       goto continue
     end
     local kind = match.kind
     if not kind then
-      vim.api.nvim_err_writeln(
-        string.format("Missing 'kind' metadata in query file for language %s", lang)
+      vim.api.nvim_echo(
+        { { string.format("Missing 'kind' metadata in query file for language %s", lang) } },
+        true,
+        { err = true }
       )
       break
     elseif not vim.lsp.protocol.SymbolKind[kind] then
-      vim.api.nvim_err_writeln(
-        string.format("Invalid 'kind' metadata '%s' in query file for language %s", kind, lang)
-      )
+      vim.api.nvim_echo({
+        {
+          string.format("Invalid 'kind' metadata '%s' in query file for language %s", kind, lang),
+        },
+      }, true, { err = true })
       break
     end
     local range = helpers.range_from_nodes(start_node, end_node)
@@ -166,12 +171,71 @@ M.fetch_symbols_sync = function(bufnr)
   )
 end
 
-M.fetch_symbols = M.fetch_symbols_sync
+---@param bufnr integer
+---@return nil|vim.treesitter.LanguageTree parser
+---@return nil|vim.treesitter.Query query
+local function get_lang_and_query(bufnr)
+  local parser = helpers.get_parser(bufnr)
+  if not parser then
+    backends.set_symbols(bufnr, {}, { backend_name = "treesitter", lang = "unknown" })
+    return
+  end
+  local lang = parser:lang()
+  local query = helpers.get_query(lang)
+  if not query then
+    backends.set_symbols(bufnr, {}, { backend_name = "treesitter", lang = lang })
+    return
+  end
+  return parser, query
+end
+
+---@param bufnr? integer
+M.fetch_symbols_sync = function(bufnr)
+  bufnr = bufnr or 0
+  local parser, query = get_lang_and_query(bufnr)
+  if not parser or not query then
+    return
+  end
+  local lang = parser:lang()
+  local syntax_tree = parser:parse()[1]
+  set_symbols_from_treesitter(bufnr, lang, query, syntax_tree)
+end
+
+---@param bufnr? integer
+M.fetch_symbols = function(bufnr)
+  if not bufnr or bufnr == 0 then
+    bufnr = vim.api.nvim_get_current_buf()
+  end
+  local parser, query = get_lang_and_query(bufnr)
+  if not parser or not query then
+    return
+  end
+  local lang = parser:lang()
+  local syntax_trees = parser:parse(nil, function(err, syntax_trees)
+    if err then
+      vim.api.nvim_echo(
+        { { string.format("Error parsing buffer: %s", err) } },
+        true,
+        { err = true }
+      )
+      backends.set_symbols(bufnr, {}, { backend_name = "treesitter", lang = lang })
+      return
+    else
+      assert(syntax_trees)
+      set_symbols_from_treesitter(bufnr, lang, query, syntax_trees[1])
+    end
+  end)
+  if syntax_trees then
+    set_symbols_from_treesitter(bufnr, lang, query, syntax_trees[1])
+  end
+end
 
+---@param bufnr integer
 M.attach = function(bufnr)
   util.add_change_watcher(bufnr, "treesitter")
 end
 
+---@param bufnr integer
 M.detach = function(bufnr)
   util.remove_change_watcher(bufnr, "treesitter")
 end

lua/aerial/highlight.lua

@@ -62,7 +62,7 @@ M.get_highlight = function(symbol, is_icon, is_collapsed)
 end
 
 ---@param name string
----@return vim.api.keyset.hl_info
+---@return vim.api.keyset.get_hl_info
 local function get_hl_by_name(name)
   return vim.api.nvim_get_hl(0, { name = name, link = false })
 end

lua/aerial/nav_view.lua

@@ -199,14 +199,14 @@ local function render_symbols(panel)
     table.insert(lines, text)
     local text_cols = vim.api.nvim_strwidth(text)
     table.insert(highlights, { "Aerial" .. item.kind .. "Icon", i - 1, 0, kind:len() })
-    table.insert(highlights, { "Aerial" .. item.kind, i - 1, kind:len(), -1 })
+    table.insert(highlights, { "Aerial" .. item.kind, i - 1, kind:len(), text:len() })
     max_len = math.max(max_len, text_cols)
   end
 
   -- If there are no symbols in this section, add some indicator of that
   if #lines == 0 then
     table.insert(lines, "<none>")
-    table.insert(highlights, { "Comment", 0, 0, -1 })
+    table.insert(highlights, { "Comment", 0, 0, 6 })
   end
 
   vim.bo[bufnr].modifiable = true
@@ -217,7 +217,11 @@ local function render_symbols(panel)
   local ns = vim.api.nvim_create_namespace("aerial")
   vim.api.nvim_buf_clear_namespace(bufnr, ns, 0, -1)
   for _, hl in ipairs(highlights) do
-    vim.api.nvim_buf_add_highlight(bufnr, ns, unpack(hl))
+    local hl_group, line, col, end_col = unpack(hl)
+    vim.api.nvim_buf_set_extmark(bufnr, ns, line, col, {
+      end_col = end_col,
+      hl_group = hl_group,
+    })
   end
   panel.width = max_len
   panel.height = #lines

lua/aerial/render.lua

@@ -166,7 +166,7 @@ M.update_aerial_buffer = function(buf)
         group = name_hl,
         row = row,
         col_start = string_len[spacing] + string_len[kind],
-        col_end = -1,
+        col_end = text:len(),
       })
     end
     max_len = math.max(max_len, text_cols)
@@ -184,7 +184,10 @@ M.update_aerial_buffer = function(buf)
   local ns = vim.api.nvim_create_namespace("aerial")
   vim.api.nvim_buf_clear_namespace(aer_bufnr, ns, 0, -1)
   for _, hl in ipairs(highlights) do
-    vim.api.nvim_buf_add_highlight(aer_bufnr, ns, hl.group, hl.row - 1, hl.col_start, hl.col_end)
+    vim.api.nvim_buf_set_extmark(aer_bufnr, ns, hl.row - 1, hl.col_start, {
+      end_col = hl.col_end,
+      hl_group = hl.group,
+    })
   end
   M.update_highlights(bufnr)
   vim.b[aer_bufnr].rendered = true

lua/aerial/util.lua

@@ -180,9 +180,14 @@ M.flash_highlight = function(bufnr, lnum, durationMs, hl_group)
   if durationMs == true or durationMs == 1 then
     durationMs = 300
   end
-  local ns = vim.api.nvim_buf_add_highlight(bufnr, 0, hl_group, lnum - 1, 0, -1)
+  local ns = vim.api.nvim_create_namespace("AerialFlashHighlight")
+  local line = vim.api.nvim_buf_get_lines(bufnr, lnum - 1, lnum, true)[1]
+  local ext_id = vim.api.nvim_buf_set_extmark(bufnr, ns, lnum - 1, 0, {
+    end_col = #line,
+    hl_group = hl_group,
+  })
   local remove_highlight = function()
-    pcall(vim.api.nvim_buf_clear_namespace, bufnr, ns, 0, -1)
+    vim.api.nvim_buf_del_extmark(bufnr, ns, ext_id)
   end
   vim.defer_fn(remove_highlight, durationMs)
 end

tests/treesitter_spec.lua

@@ -23,19 +23,32 @@ local function list_files(dir)
 end
 
 describe("treesitter", function()
+  local skip_tests = {}
+  if vim.fn.has("nvim-0.11") == 0 then
+    -- ABI version mismatch
+    table.insert(skip_tests, "enforce_test.c")
+  end
+
   for _, filename in ipairs(list_files("tests/treesitter")) do
+    if vim.tbl_contains(skip_tests, filename) then
+      print("Skipping test", filename)
+      goto continue
+    end
     local filepath = "./tests/treesitter/" .. filename
     local basename = vim.fn.fnamemodify(filename, ":r")
     local symbols_file = "./tests/symbols/" .. basename .. ".json"
-    it(filename, function()
-      util.test_file_symbols("treesitter", filepath, symbols_file)
-    end)
+    if not vim.env.TS_TEST or vim.env.TS_TEST == basename then
+      it(filename, function()
+        util.test_file_symbols("treesitter", filepath, symbols_file)
+      end)
+    end
 
-    if filename == "markdown_test.md" then
+    if filename == "markdown_test.md" and not vim.env.TS_TEST then
       it("<markdown backend> " .. filename, function()
         util.test_file_symbols("markdown", filepath, "./tests/symbols/markdown_backend.json")
       end)
     end
+    ::continue::
   end
 
   util.test_file_symbols("man", "./tests/man_test.txt", "./tests/symbols/man.json")