chore: plenary tests POC: add make entry, specify tests

* feat(mappings): add key map to close file buffer

* feat: implement Api.node.buffer.delete

* feat: implement Api.node.buffer.wipe

* refactor: add util fn for common delete ops on bufs

* fix: minor fixes

* refactor: fix lint issues

* fix: undo unintended ApiTreeToggleOpts change

* fix: change error message level to info

* fix: remove unused opts

* refactor: merge delete-buffer and wipe-buffer into single buffer file

* refactor: make wipe and delete fns take a node instead of a file path

* docs: update help with new API commands

* remove refactored utils.lua

* remove unused static setup

* tweak doc

---------

Co-authored-by: Alexander Courtis <alex@courtis.org>

.gitignore

@@ -1,4 +1,5 @@
 /luals-out/
 /luals/
+/plenary.nvim/
 # backup vim files
 *~

.luarc.json

@@ -4,7 +4,8 @@
   "workspace": {
     "library": [
       "$VIMRUNTIME/lua/vim",
-      "${3rd}/luv/library"
+      "${3rd}/luv/library",
+      "plenary.nvim"
     ]
   },
   "diagnostics": {

Makefile

@@ -43,6 +43,19 @@ help-update:
 help-check: help-update
 	git diff --exit-code doc/nvim-tree-lua.txt
 
+#
+# test
+#
+test: plenary.nvim
+	scripts/test.sh
+
+#
+# Dependencies
+#
+# no plenary tags or releases available
+plenary.nvim:
+	git clone git@github.com:nvim-lua/plenary.nvim.git
+
 
 .PHONY: all lint style check luacheck style-check style-doc luals style-fix help-update help-check
 

README.md

@@ -162,13 +162,13 @@ nvim-tree exposes a public API. This is non breaking, with additions made as nec
 
 See wiki [Recipes](https://github.com/nvim-tree/nvim-tree.lua/wiki/Recipes) and [Tips](https://github.com/nvim-tree/nvim-tree.lua/wiki/Tips) for ideas and inspiration.
 
-Please raise a [feature request](https://github.com/nvim-tree/nvim-tree.lua/issues/new?assignees=&labels=feature+request&template=feature_request.md&title=) if the API is insufficient for your needs. [Contributions](#Contributing) are always welcome.
+Please raise a [feature request](https://github.com/nvim-tree/nvim-tree.lua/issues/new?assignees=&labels=feature+request&template=feature_request.md&title=) if the API is insufficient for your needs. Contributions are always welcome, see below.
 
 You may also subscribe to events that nvim-tree will dispatch in a variety of situations, see [:help nvim-tree-events](doc/nvim-tree-lua.txt)
 
 ## Contributing
 
-PRs are always welcome. See [wiki](https://github.com/nvim-tree/nvim-tree.lua/wiki/Development) to get started.
+PRs are always welcome. See [CONTRIBUTING](CONTRIBUTING.md) and [wiki: Development](https://github.com/nvim-tree/nvim-tree.lua/wiki/Development) to get started.
 
 See [bug](https://github.com/nvim-tree/nvim-tree.lua/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and [PR Please](https://github.com/nvim-tree/nvim-tree.lua/issues?q=is%3Aopen+is%3Aissue+label%3A%22PR+please%22) issues if you are looking for some work to get you started.
 

doc/nvim-tree-lua.txt

@@ -1894,7 +1894,7 @@ tree.winid({opts})                              *nvim-tree-api.tree.winid()*
       • {opts} (table) optional parameters
 
     Options: ~
-      • {tabpage}        (number|nil)  tabpage, 0 or nil for current, default nil
+      • {tabpage} (number|nil)  tabpage, 0 or nil for current, default nil
 
     Return: ~
       (number) winid or nil if tree is not visible
@@ -2164,6 +2164,28 @@ node.run.cmd({node})                            *nvim-tree-api.node.run.cmd()*
 node.run.system({node})                      *nvim-tree-api.node.run.system()*
     Execute |nvim-tree.system_open|
 
+node.buffer.delete({node}, {opts})        *nvim-tree-api.node.buffer.delete()*
+    Deletes node's related buffer, if one exists.
+    Executes |:bdelete| or |:bdelete|!
+
+    Parameters: ~
+      • {node} (Node|nil) file or folder
+      • {opts} (table) optional parameters
+
+    Options: ~
+      • {force} (boolean) delete even if buffer is modified, default false
+
+node.buffer.wipe({node}, {opts})            *nvim-tree-api.node.buffer.wipe()*
+    Wipes node's related buffer, if one exists.
+    Executes |:bwipe| or |:bwipe|!
+
+    Parameters: ~
+      • {node} (Node|nil) file or folder
+      • {opts} (table) optional parameters
+
+    Options: ~
+      • {force} (boolean) wipe even if buffer is modified, default false
+
 ==============================================================================
  6.4 API GIT                                               *nvim-tree-api.git*
 
@@ -3178,6 +3200,8 @@ highlight group is not, hard linking as follows: >
 |nvim-tree-api.marks.navigate.prev()|
 |nvim-tree-api.marks.navigate.select()|
 |nvim-tree-api.marks.toggle()|
+|nvim-tree-api.node.buffer.delete()|
+|nvim-tree-api.node.buffer.wipe()|
 |nvim-tree-api.node.navigate.diagnostics.next()|
 |nvim-tree-api.node.navigate.diagnostics.next_recursive()|
 |nvim-tree-api.node.navigate.diagnostics.prev()|

lua/nvim-tree/actions/node/buffer.lua

@@ -0,0 +1,58 @@
+-- Copyright 2019 Yazdani Kiyan under MIT License
+local notify = require("nvim-tree.notify")
+
+local M = {}
+
+---@param node Node
+---@param opts ApiNodeDeleteWipeBufferOpts|nil
+---@return nil
+function M.delete(node, opts)
+  M.delete_buffer("delete", node.absolute_path, opts)
+end
+
+---@param node Node
+---@param opts ApiNodeDeleteWipeBufferOpts|nil
+---@return nil
+function M.wipe(node, opts)
+  M.delete_buffer("wipe", node.absolute_path, opts)
+end
+
+---@alias ApiNodeDeleteWipeBufferMode '"delete"'|'"wipe"'
+
+---@param mode ApiNodeDeleteWipeBufferMode
+---@param filename string
+---@param opts ApiNodeDeleteWipeBufferOpts|nil
+---@return nil
+function M.delete_buffer(mode, filename, opts)
+  if type(mode) ~= "string" then
+    mode = "delete"
+  end
+
+  local buf_fn = vim.cmd.bdelete
+  if mode == "wipe" then
+    buf_fn = vim.cmd.bwipe
+  end
+
+  opts = opts or { force = false }
+
+  local notify_node = notify.render_path(filename)
+
+  -- check if buffer for file at cursor exists and if it is loaded
+  local bufnr_at_filename = vim.fn.bufnr(filename)
+  if bufnr_at_filename == -1 or vim.fn.getbufinfo(bufnr_at_filename)[1].loaded == 0 then
+    notify.info("No loaded buffer coincides with " .. notify_node)
+    return
+  end
+
+  local force = opts.force
+  -- check if buffer is modified
+  local buf_modified = vim.fn.getbufinfo(bufnr_at_filename)[1].changed
+  if not force and buf_modified == 1 then
+    notify.error("Buffer for file " .. notify_node .. " is modified")
+    return
+  end
+
+  buf_fn({ filename, bang = force })
+end
+
+return M

lua/nvim-tree/actions/node/file-popup.lua

@@ -50,6 +50,7 @@ local function setup_window(node)
     file_path = node.absolute_path,
   }
   local bufnr = vim.api.nvim_create_buf(false, true)
+  vim.bo[bufnr].bufhidden = "wipe"
   vim.api.nvim_buf_set_lines(bufnr, 0, -1, false, lines)
   vim.api.nvim_win_set_buf(winnr, bufnr)
 end

lua/nvim-tree/actions/node/init.lua

@@ -4,6 +4,7 @@ M.file_popup = require("nvim-tree.actions.node.file-popup")
 M.open_file = require("nvim-tree.actions.node.open-file")
 M.run_command = require("nvim-tree.actions.node.run-command")
 M.system_open = require("nvim-tree.actions.node.system-open")
+M.buffer = require("nvim-tree.actions.node.buffer")
 
 function M.setup(opts)
   require("nvim-tree.actions.node.system-open").setup(opts)

lua/nvim-tree/api.lua

@@ -24,6 +24,7 @@ local Api = {
     },
     run = {},
     open = {},
+    buffer = {},
   },
   events = {},
   marks = {
@@ -286,6 +287,16 @@ Api.node.navigate.diagnostics.prev_recursive = wrap_node(actions.moves.item.fn({
 Api.node.navigate.opened.next = wrap_node(actions.moves.item.fn({ where = "next", what = "opened" }))
 Api.node.navigate.opened.prev = wrap_node(actions.moves.item.fn({ where = "prev", what = "opened" }))
 
+---@class ApiNodeDeleteWipeBufferOpts
+---@field force boolean|nil default false
+
+Api.node.buffer.delete = wrap_node(function(node, opts)
+  actions.node.buffer.delete(node, opts)
+end)
+Api.node.buffer.wipe = wrap_node(function(node, opts)
+  actions.node.buffer.wipe(node, opts)
+end)
+
 Api.git.reload = wrap_explorer("reload_git")
 
 Api.events.subscribe = events.subscribe

lua/nvim-tree/appearance/hi-test.lua

@@ -5,6 +5,8 @@ local Class = require("nvim-tree.classic")
 -- others with name and links less than this arbitrary value are short
 local SHORT_LEN = 50
 
+local namespace_hi_test_id = vim.api.nvim_create_namespace("NvimTreeHiTest")
+
 ---@class (exact) HighlightDisplay: Class for :NvimTreeHiTest
 ---@field group string nvim-tree highlight group name
 ---@field links string link chain to a concretely defined group
@@ -52,7 +54,12 @@ function HighlightDisplay:render(bufnr, fmt, l)
   local text = string.format(fmt, self.group, self.links, self.def)
 
   vim.api.nvim_buf_set_lines(bufnr, l, -1, true, { text })
-  vim.api.nvim_buf_add_highlight(bufnr, -1, self.group, l, 0, #self.group)
+
+  if vim.fn.has("nvim-0.11") == 1 then
+    vim.hl.range(bufnr, namespace_hi_test_id, self.group, { l, 0 }, { l, #self.group, }, {})
+  else
+    vim.api.nvim_buf_add_highlight(bufnr, -1, self.group, l, 0, #self.group) ---@diagnostic disable-line: deprecated
+  end
 
   return l + 1
 end

lua/nvim-tree/help.lua

@@ -11,6 +11,8 @@ local WIN_HL = table.concat({
   "CursorLine:NvimTreeCursorLine",
 }, ",")
 
+local namespace_help_id = vim.api.nvim_create_namespace("NvimTreeHelp")
+
 local M = {
   config = {},
 
@@ -82,8 +84,8 @@ end
 
 --- Compute all lines for the buffer
 ---@param map table keymap.get_keymap
----@return table strings of text
+---@return string[] lines of text
----@return table arrays of arguments 3-6 for nvim_buf_add_highlight()
+---@return HighlightRangeArgs[] hl_range_args for lines
 ---@return number maximum length of text
 local function compute(map)
   local head_lhs = "nvim-tree mappings"
@@ -130,10 +132,10 @@ local function compute(map)
   local width = #lines[1]
 
   -- header highlight, assume one character keys
-  local hl = {
+  local hl_range_args = {
-    { "NvimTreeFolderName", 0, 0,         #head_lhs },
+    { higroup = "NvimTreeFolderName", start = { 0, 0, },         finish = { 0, #head_lhs, }, },
-    { "NvimTreeFolderName", 0, width - 1, width },
+    { higroup = "NvimTreeFolderName", start = { 0, width - 1, }, finish = { 0, width, }, },
-    { "NvimTreeFolderName", 1, width - 1, width },
+    { higroup = "NvimTreeFolderName", start = { 1, width - 1, }, finish = { 1, width, }, },
   }
 
   -- mappings, left padded 1
@@ -145,10 +147,10 @@ local function compute(map)
     width = math.max(#line, width)
 
     -- highlight lhs
-    table.insert(hl, { "NvimTreeFolderName", i + 1, 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
@@ -172,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)
@@ -187,8 +189,12 @@ local function open()
   end
 
   -- highlight it
-  for _, h in ipairs(hl) do
+  for _, args in ipairs(hl_range_args) do
-    vim.api.nvim_buf_add_highlight(M.bufnr, -1, h[1], h[2], h[3], h[4])
+    if vim.fn.has("nvim-0.11") == 1 then
+      vim.hl.range(M.bufnr, namespace_help_id, args.higroup, args.start, args.finish, {})
+    else
+      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
 
   -- open a very restricted window

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/components/full-name.lua

@@ -79,9 +79,15 @@ local function show()
       ---@type vim.api.keyset.extmark_details
       local details = extmark[4]
 
-      vim.api.nvim_buf_add_highlight(0, ns_id, details.hl_group, 0, col, details.end_col)
+      if type(details) == "table" then
+        if vim.fn.has("nvim-0.12") == 1 then
+          vim.hl.range(0, ns_id, details.hl_group, { 0, col }, { 0, details.end_col, }, {})
+        else
+          vim.api.nvim_buf_add_highlight(0, ns_id, details.hl_group, 0, col, details.end_col) ---@diagnostic disable-line: deprecated
+        end
+      end
     end
-    vim.cmd([[ setlocal nowrap cursorline noswapfile nobuflisted buftype=nofile bufhidden=hide ]])
+    vim.cmd([[ setlocal nowrap cursorline noswapfile nobuflisted buftype=nofile bufhidden=wipe ]])
   end)
 end
 

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,11 +32,11 @@ 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
@@ -42,7 +44,7 @@ function Renderer:_draw(bufnr, lines, hl_args, signs, extmarks, virtual_lines)
   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
+  for _, args in ipairs(hl_range_args) do
-    if type(data[1]) == "table" then
+    if vim.fn.has("nvim-0.11") == 1 then
-      for _, group in ipairs(data[1]) do
+      vim.hl.range(bufnr, namespace_highlights_id, args.higroup, args.start, args.finish, {})
-        vim.api.nvim_buf_add_highlight(bufnr, namespace_highlights_id, group, data[2], data[3], data[4])
+    else
-      end
+      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)

lua/nvim-tree/utils.lua

@@ -11,6 +11,10 @@ M.is_wsl = vim.fn.has("wsl") == 1
 -- false for WSL
 M.is_windows = vim.fn.has("win32") == 1 or vim.fn.has("win32unix") == 1
 
+function M._is_windows()
+  return vim.fn.has("win32") == 1 or vim.fn.has("win32unix") == 1
+end
+
 ---@param haystack string
 ---@param needle string
 ---@return boolean
@@ -299,7 +303,7 @@ end
 ---@param path string
 ---@return string
 function M.canonical_path(path)
-  if M.is_windows and path:match("^%a:") then
+  if M._is_windows() and path:match("^%a:") then
     return path:sub(1, 1):upper() .. path:sub(2)
   end
   return path

scripts/test.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+
+set -e
+
+DIR_REPO="$(git rev-parse --show-toplevel)"
+export DIR_REPO
+
+DIR_PLENARY="${DIR_REPO}/plenary.nvim"
+export DIR_PLENARY
+
+if [ "${#}" -eq 1 ]; then
+	TEST_NAME="${1}"
+elif [ -z "${TEST_NAME}" ]; then
+	TEST_NAME="tests"
+fi
+export TEST_NAME
+
+echo "testing: ${TEST_NAME}"
+
+nvim --headless \
+	--clean \
+	-u "${DIR_REPO}/tests/minimal_init.lua" \
+	-l "${DIR_REPO}/tests/test_init.lua" \
+	-c "qa!"
+

tests/minimal_init.lua

@@ -0,0 +1,8 @@
+-- Prepend these as plenary appends a "." and plenary directory
+-- The spawned processes don't specify --clean so contain the full ~/.local runtime path
+vim.o.runtimepath = string.format(
+  "%s,%s,%s",
+  vim.env.DIR_REPO,
+  vim.env.DIR_PLENARY,
+  vim.o.runtimepath
+)

tests/test_init.lua

@@ -0,0 +1,9 @@
+local test_harness = require("plenary.test_harness")
+
+test_harness.test_directory(
+  vim.env.TEST_NAME,
+  {
+    minimal_init = vim.env.DIR_REPO .. "/tests/minimal_init.lua",
+    sequential = true,
+  }
+)

tests/unit/utils_spec.lua

@@ -0,0 +1,30 @@
+---@type Luassert
+local assert = require("luassert")
+local stub = require("luassert.stub")
+
+local utils = require("nvim-tree.utils")
+
+describe("utils.path_add_trailing", function()
+  it("trailing added", function()
+    assert.equals("foo/", utils.path_add_trailing("foo"))
+  end)
+
+  it("trailing already present", function()
+    assert.equals("foo/", utils.path_add_trailing("foo/"))
+  end)
+end)
+
+describe("utils.canonical_path", function()
+  before_each(function()
+    stub(vim.fn, "has")
+  end)
+
+  it("is windows", function()
+    vim.fn.has.on_call_with("win32unix").returns(1)
+    assert.equals("C:\\foo\\bar", utils.canonical_path("c:\\foo\\bar"), "should be uppercase drive")
+  end)
+
+  it("not windows", function()
+    assert.equals("c:\\foo\\bar", utils.canonical_path("c:\\foo\\bar"))
+  end)
+end)