Replace deprecated vim.api.nvim_buf_add_highlight with vim.hl.range

Author: SidOfc

doc/carbon.txt

@@ -40,7 +40,7 @@ USAGE                                                               *carbon-usag
   directly anywhere in your |$MYVIMRC| file since such packages are
   automatically loaded.
 
-  Carbon replaces |netrw| by default and remaps NetRW's |Explore| and |Lexplore|
+  Carbon replaces |netrw| by default and remaps NetRW's |Explore| and Lexplore
   commands to Carbon's |carbon-command-Carbon| and |carbon-command-Lcarbon| commands
   respectively. For more specific usage and configuration information, see:
 
@@ -817,9 +817,9 @@ UTIL                                                                 *carbon-uti
 
   Signature: `require('carbon.util').add_highlight(`{buf}, {...}`)`
 
-  Calls |nvim_buf_add_highlight| like this:
+  Calls |vim.hl.range| like this:
 
-  `vim.api.nvim_buf_add_highlight(`{buf}, <ns_id>, {...}`)`
+  `vim.hl.range(`{buf}, <ns_id>, {...}`)`
 
   <ns_id> will be set to |carbon-constant-hl|.
 
@@ -1520,16 +1520,15 @@ VIEW                                                                 *carbon-vie
     <number end_column>,
   }
 <
-  |carbon-view-render| uses |nvim_buf_add_highlight| to set the highlights.
+  |carbon-view-render| uses |vim.hl.range| to set the highlights.
   It is called the following way:
 
-  `vim.api.nvim_buf_add_highlight(`
+  `vim.hl.range(`
     |carbon-view-buffer|,
     |carbon-constant-hl|,
     `highlight[1],`
-    `lnum - 1,`
-    `highlight[2],`
-    `highlight[3],`
+    `{lnum - 1, highlight[2]},`
+    `{lnum - 1, highlight[3]},`
   `)`
 
   Property: `path`
@@ -1817,7 +1816,7 @@ VIEW                                                                 *carbon-vie
 
   Highlights a region from {start} to {finish} with {group} for {duration}
   milliseconds. {start} and {finish} must be values accepted by
-  |vim.highlight.range|.
+  |vim.hl.range|.
 
   See |carbon-view-flash-bang| for more information about customizing the
   highlighting properties when entries are revealed.

lua/carbon/util.lua

@@ -203,7 +203,7 @@ function util.clear_extmarks(buf, ...)
 end
 
 function util.add_highlight(buf, ...)
-  vim.api.nvim_buf_add_highlight(buf, constants.hl, ...)
+  vim.hl.range(buf, constants.hl, ...)
 end
 
 function util.window_neighbors(window_id, sides)

lua/carbon/view.lua

@@ -58,8 +58,18 @@ local function create_insert_move(ctx)
 
     vim.api.nvim_buf_set_lines(0, ctx.edit_lnum, ctx.edit_lnum + 1, 1, { text })
     util.clear_extmarks(0, { ctx.edit_lnum, 0 }, { ctx.edit_lnum, -1 }, {})
-    util.add_highlight(0, 'CarbonDir', ctx.edit_lnum, 0, last_slash_col)
-    util.add_highlight(0, 'CarbonFile', ctx.edit_lnum, last_slash_col, -1)
+    util.add_highlight(
+      0,
+      'CarbonDir',
+      { ctx.edit_lnum, 0 },
+      { ctx.edit_lnum, last_slash_col }
+    )
+    util.add_highlight(
+      0,
+      'CarbonFile',
+      { ctx.edit_lnum, last_slash_col },
+      { ctx.edit_lnum, -1 }
+    )
     util.cursor(ctx.edit_lnum + 1, math.max(ctx.edit_col, vim.fn.col('.')))
   end
 end
@@ -378,14 +388,7 @@ function view:render()
   end
 
   for _, hl in ipairs(hls) do
-    vim.api.nvim_buf_add_highlight(
-      buf,
-      constants.hl,
-      hl[1],
-      hl[2],
-      hl[3],
-      hl[4]
-    )
+    vim.hl.range(buf, constants.hl, hl[1], { hl[2], hl[3] }, { hl[2], hl[4] })
   end
 
   if cursor then
@@ -409,7 +412,7 @@ end
 function view:focus_flash(duration, group, start, finish)
   local buf = self:buffer()
 
-  vim.highlight.range(buf, constants.hl_tmp, group, start, finish, {})
+  vim.hl.range(buf, constants.hl_tmp, group, start, finish, {})
 
   vim.defer_fn(function()
     if vim.api.nvim_buf_is_valid(buf) then
@@ -857,7 +860,12 @@ function view:delete()
   end
 
   util.clear_extmarks(0, { lnum_idx, highlight[2] }, { lnum_idx, -1 }, {})
-  util.add_highlight(0, 'CarbonDanger', lnum_idx, highlight[2], -1)
+  util.add_highlight(
+    0,
+    'CarbonDanger',
+    { lnum_idx, highlight[2] },
+    { lnum_idx, -1 }
+  )
 
   vim.cmd.redraw()
 
@@ -891,7 +899,7 @@ function view:delete()
     util.clear_extmarks(0, { lnum_idx, 0 }, { lnum_idx, -1 }, {})
 
     for _, lhl in ipairs(cursor.line.highlights) do
-      util.add_highlight(0, lhl[1], lnum_idx, lhl[2], lhl[3])
+      util.add_highlight(0, lhl[1], { lnum_idx, lhl[2] }, { lnum_idx, lhl[3] })
     end
 
     self:render()
@@ -924,7 +932,12 @@ function view:move()
   end
 
   util.clear_extmarks(0, { lnum_idx, start_hl }, { lnum_idx, -1 }, {})
-  util.add_highlight(0, 'CarbonPending', lnum_idx, start_hl, -1)
+  util.add_highlight(
+    0,
+    'CarbonPending',
+    { lnum_idx, start_hl },
+    { lnum_idx, -1 }
+  )
   vim.cmd.redraw({ bang = true })
   vim.cmd.echohl('CarbonPending')