chore: resolve deprecated in 0.11

Author: alex-courtis

lua/nvim-tree/help.lua

@@ -85,7 +85,7 @@ end
 --- Compute all lines for the buffer
 ---@param map table keymap.get_keymap
 ---@return string[] lines of text
----@return { higroup:string, start:integer[], finish:integer[] }[] hl for lines: named arguments for vim.hl.range
+---@return HighlightRangeArgs[] hl_range_args for lines
 ---@return number maximum length of text
 local function compute(map)
   local head_lhs = "nvim-tree mappings"
@@ -132,7 +132,7 @@ local function compute(map)
   local width = #lines[1]
 
   -- header highlight, assume one character keys
-  local hl = {
+  local hl_range_args = {
     { higroup = "NvimTreeFolderName", start = { 0, 0, },         finish = { 0, #head_lhs, }, },
     { higroup = "NvimTreeFolderName", start = { 0, width - 1, }, finish = { 0, width, }, },
     { higroup = "NvimTreeFolderName", start = { 1, width - 1, }, finish = { 1, width, }, },
@@ -147,10 +147,10 @@ local function compute(map)
     width = math.max(#line, width)
 
     -- highlight lhs
-    table.insert(hl, { higroup = "NvimTreeFolderName", start = { i + 1, 1, }, finish = { i + 1, #l.lhs + 1, }, })
+    table.insert(hl_range_args, { higroup = "NvimTreeFolderName", start = { i + 1, 1, }, finish = { i + 1, #l.lhs + 1, }, })
   end
 
-  return lines, hl, width
+  return lines, hl_range_args, width
 end
 
 --- close the window and delete the buffer, if they exist
@@ -174,7 +174,7 @@ local function open()
   local map = keymap.get_keymap()
 
   -- text and highlight
-  local lines, hl, width = compute(map)
+  local lines, hl_range_args, width = compute(map)
 
   -- create the buffer
   M.bufnr = vim.api.nvim_create_buf(false, true)
@@ -189,11 +189,11 @@ local function open()
   end
 
   -- highlight it
-  for _, h in ipairs(hl) do
+  for _, args in ipairs(hl_range_args) do
     if vim.fn.has("nvim-0.11") == 1 then
-      vim.hl.range(M.bufnr, namespace_help_id, h.higroup, h.start, h.finish, {})
+      vim.hl.range(M.bufnr, namespace_help_id, args.higroup, args.start, args.finish, {})
     else
-      vim.api.nvim_buf_add_highlight(M.bufnr, -1, h.higroup, h.start[1], h.start[2], h.finish[2]) ---@diagnostic disable-line: deprecated
+      vim.api.nvim_buf_add_highlight(M.bufnr, -1, args.higroup, args.start[1], args.start[2], args.finish[2]) ---@diagnostic disable-line: deprecated
     end
   end
 

lua/nvim-tree/renderer/builder.lua

@@ -33,15 +33,9 @@ local BUILTIN_DECORATORS = {
   Cut = CutDecorator,
 }
 
----@class (exact) AddHighlightArgs
----@field group string[]
----@field line number
----@field col_start number
----@field col_end number
-
 ---@class (exact) Builder
 ---@field lines string[] includes icons etc.
----@field hl_args AddHighlightArgs[] line highlights
+---@field hl_range_args HighlightRangeArgs[] highlights for lines
 ---@field signs string[] line signs
 ---@field extmarks table[] extra marks for right icon placement
 ---@field virtual_lines table[] virtual lines for hidden count display
@@ -67,7 +61,7 @@ function Builder:new(args)
   self.explorer        = args.explorer
   self.index           = 0
   self.depth           = 0
-  self.hl_args         = {}
+  self.hl_range_args   = {}
   self.combined_groups = {}
   self.lines           = {}
   self.markers         = {}
@@ -106,7 +100,9 @@ end
 ---@param start number
 ---@param end_ number|nil
 function Builder:insert_highlight(groups, start, end_)
-  table.insert(self.hl_args, { groups, self.index, start, end_ or -1 })
+  for _, higroup in ipairs(groups) do
+    table.insert(self.hl_range_args, { higroup = higroup, start = { self.index, start, }, finish = { self.index, end_ or -1, } })
+  end
 end
 
 ---@private

lua/nvim-tree/renderer/init.lua

@@ -11,6 +11,8 @@ local namespace_highlights_id = vim.api.nvim_create_namespace("NvimTreeHighlight
 local namespace_extmarks_id = vim.api.nvim_create_namespace("NvimTreeExtmarks")
 local namespace_virtual_lines_id = vim.api.nvim_create_namespace("NvimTreeVirtualLines")
 
+---@alias HighlightRangeArgs { higroup:string, start:integer[], finish:integer[] }[] named arguments for vim.hl.range
+
 ---@class (exact) Renderer: Class
 ---@field explorer Explorer
 local Renderer = Class:extend()
@@ -30,19 +32,19 @@ end
 ---@private
 ---@param bufnr number
 ---@param lines string[]
----@param hl_args AddHighlightArgs[]
+---@param hl_range_args HighlightRangeArgs[]
 ---@param signs string[]
 ---@param extmarks table[] extra marks for right icon placement
 ---@param virtual_lines table[] virtual lines for hidden count display
-function Renderer:_draw(bufnr, lines, hl_args, signs, extmarks, virtual_lines)
+function Renderer:_draw(bufnr, lines, hl_range_args, signs, extmarks, virtual_lines)
   if vim.fn.has("nvim-0.10") == 1 then
     vim.api.nvim_set_option_value("modifiable", true, { buf = bufnr })
   else
     vim.api.nvim_buf_set_option(bufnr, "modifiable", true) ---@diagnostic disable-line: deprecated
   end
 
   vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, lines)
-  self:render_hl(bufnr, hl_args)
+  self:render_hl(bufnr, hl_range_args)
 
   if vim.fn.has("nvim-0.10") == 1 then
     vim.api.nvim_set_option_value("modifiable", false, { buf = bufnr })
@@ -77,16 +79,18 @@ function Renderer:_draw(bufnr, lines, hl_args, signs, extmarks, virtual_lines)
 end
 
 ---@private
-function Renderer:render_hl(bufnr, hl)
+---@param bufnr integer
+---@param hl_range_args HighlightRangeArgs[]
+function Renderer:render_hl(bufnr, hl_range_args)
   if not bufnr or not vim.api.nvim_buf_is_loaded(bufnr) then
     return
   end
   vim.api.nvim_buf_clear_namespace(bufnr, namespace_highlights_id, 0, -1)
-  for _, data in ipairs(hl) do
-    if type(data[1]) == "table" then
-      for _, group in ipairs(data[1]) do
-        vim.api.nvim_buf_add_highlight(bufnr, namespace_highlights_id, group, data[2], data[3], data[4])
-      end
+  for _, args in ipairs(hl_range_args) do
+    if vim.fn.has("nvim-0.11") == 1 then
+      vim.hl.range(bufnr, namespace_highlights_id, args.higroup, args.start, args.finish, {})
+    else
+      vim.api.nvim_buf_add_highlight(bufnr, namespace_highlights_id, args.higroup, args.start[1], args.start[2], args.finish[2]) ---@diagnostic disable-line: deprecated
     end
   end
 end
@@ -103,7 +107,7 @@ function Renderer:draw()
 
   local builder = Builder(self.explorer):build()
 
-  self:_draw(bufnr, builder.lines, builder.hl_args, builder.signs, builder.extmarks, builder.virtual_lines)
+  self:_draw(bufnr, builder.lines, builder.hl_range_args, builder.signs, builder.extmarks, builder.virtual_lines)
 
   if cursor and #builder.lines >= cursor[1] then
     vim.api.nvim_win_set_cursor(view.get_winnr() or 0, cursor)