Merge branch '2415-highlight-overhaul' into 2415-highlight-open-modified-additive

Author: alex-courtis

.github/ISSUE_TEMPLATE/nvt-min.lua

@@ -35,3 +35,13 @@ _G.setup = function()
   require("nvim-tree").setup {}
 end
 
+-- UNCOMMENT this block for diagnostics issues, substituting pattern and cmd as appropriate.
+-- Requires diagnostics.enable = true in setup.
+--[[
+vim.api.nvim_create_autocmd("FileType", {
+  pattern = "lua",
+  callback = function()
+    vim.lsp.start { cmd = { "lua-language-server" } }
+  end,
+})
+]]

doc/nvim-tree-lua.txt

@@ -29,9 +29,10 @@ CONTENTS                                                           *nvim-tree*
   5.14 Opts: Trash                              |nvim-tree-opts-trash|
   5.15 Opts: Tab                                |nvim-tree-opts-tab|
   5.16 Opts: Notify                             |nvim-tree-opts-notify|
-  5.17 Opts: UI                                 |nvim-tree-opts-ui|
-  5.18 Opts: Experimental                       |nvim-tree-opts-experimental|
-  5.19 Opts: Log                                |nvim-tree-opts-log|
+  5.17 Opts: Help                               |nvim-tree-opts-help|
+  5.18 Opts: UI                                 |nvim-tree-opts-ui|
+  5.19 Opts: Experimental                       |nvim-tree-opts-experimental|
+  5.20 Opts: Log                                |nvim-tree-opts-log|
   6. API                                      |nvim-tree-api|
   6.1  API Tree                                 |nvim-tree-api.tree|
   6.2  API File System                          |nvim-tree-api.fs|
@@ -566,10 +567,14 @@ Following is the default configuration. See |nvim-tree-opts| for details.
         threshold = vim.log.levels.INFO,
         absolute_path = true,
       },
+      help = {
+        sort_by = "key",
+      },
       ui = {
         confirm = {
           remove = true,
           trash = true,
+          default_yes = false,
         },
       },
       experimental = {},
@@ -1436,7 +1441,16 @@ Whether to use absolute paths or item names in fs action notifications.
   Type: `boolean`, Default: `true`
 
 ==============================================================================
- 5.17 OPTS: UI                                             *nvim-tree-opts-ui*
+ 5.17 OPTS: HELP                                        *nvim-tree-opts-help*
+
+*nvim-tree.help.sort_by*
+Defines how mappings are sorted in the help window.
+Can be `"key"` (sort alphabetically by keymap)
+or `"desc"` (sort alphabetically by description).
+  Type: `string`, Default: `"key"`
+
+==============================================================================
+ 5.18 OPTS: UI                                             *nvim-tree-opts-ui*
 
 *nvim-tree.ui.confirm*
 Confirmation prompts.
@@ -1449,15 +1463,19 @@ Confirmation prompts.
     Prompt before trashing.
       Type: `boolean`, Default: `true`
 
+    *nvim-tree.ui.confirm.default_yes*
+    If `true` the prompt will be `"Y/n"`, otherwise `"y/N"`.
+      Type: `boolean`, Default: `false`
+
 ==============================================================================
- 5.18 OPTS: EXPERIMENTAL                         *nvim-tree-opts-experimental*
+ 5.19 OPTS: EXPERIMENTAL                         *nvim-tree-opts-experimental*
 
 *nvim-tree.experimental*
 Experimental features that may become default or optional functionality.
 In the event of a problem please disable the experiment and raise an issue.
 
 ==============================================================================
- 5.19 OPTS: LOG                                           *nvim-tree-opts-log*
+ 5.20 OPTS: LOG                                           *nvim-tree-opts-log*
 
 Configuration for diagnostic logging.
 

lua/nvim-tree.lua

@@ -588,10 +588,14 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     threshold = vim.log.levels.INFO,
     absolute_path = true,
   },
+  help = {
+    sort_by = "key",
+  },
   ui = {
     confirm = {
       remove = true,
       trash = true,
+      default_yes = false,
     },
   },
   experimental = {},
@@ -668,6 +672,9 @@ local ACCEPTED_STRINGS = {
       bookmarks_placement = { "before", "after", "signcolumn" },
     },
   },
+  help = {
+    sort_by = { "key", "desc" },
+  },
 }
 
 local function validate_options(conf)

lua/nvim-tree/actions/fs/copy-paste.lua

@@ -252,15 +252,19 @@ function M.print_clipboard()
 end
 
 local function copy_to_clipboard(content)
+  local clipboard_name
   if M.config.actions.use_system_clipboard == true then
     vim.fn.setreg("+", content)
     vim.fn.setreg('"', content)
-    return notify.info(string.format("Copied %s to system clipboard!", content))
+    clipboard_name = "system"
   else
     vim.fn.setreg('"', content)
     vim.fn.setreg("1", content)
-    return notify.info(string.format("Copied %s to neovim clipboard!", content))
+    clipboard_name = "neovim"
   end
+
+  vim.api.nvim_exec_autocmds("TextYankPost", {})
+  return notify.info(string.format("Copied %s to %s clipboard!", content, clipboard_name))
 end
 
 function M.copy_filename(node)

lua/nvim-tree/actions/fs/remove-file.lua

@@ -106,11 +106,22 @@ function M.fn(node)
   end
 
   if M.config.ui.confirm.remove then
-    local prompt_select = "Remove " .. node.name .. " ?"
-    local prompt_input = prompt_select .. " y/N: "
-    lib.prompt(prompt_input, prompt_select, { "", "y" }, { "No", "Yes" }, function(item_short)
+    local prompt_select = "Remove " .. node.name .. "?"
+    local prompt_input, items_short, items_long
+
+    if M.config.ui.confirm.default_yes then
+      prompt_input = prompt_select .. " Y/n: "
+      items_short = { "", "n" }
+      items_long = { "Yes", "No" }
+    else
+      prompt_input = prompt_select .. " y/N: "
+      items_short = { "", "y" }
+      items_long = { "No", "Yes" }
+    end
+
+    lib.prompt(prompt_input, prompt_select, items_short, items_long, function(item_short)
       utils.clear_prompt()
-      if item_short == "y" then
+      if item_short == "y" or item_short == (M.config.ui.confirm.default_yes and "") then
         do_remove()
       end
     end)

lua/nvim-tree/actions/fs/trash.lua

@@ -86,11 +86,22 @@ function M.fn(node)
   end
 
   if M.config.ui.confirm.trash then
-    local prompt_select = "Trash " .. node.name .. " ?"
-    local prompt_input = prompt_select .. " y/N: "
-    lib.prompt(prompt_input, prompt_select, { "", "y" }, { "No", "Yes" }, function(item_short)
+    local prompt_select = "Trash " .. node.name .. "?"
+    local prompt_input, items_short, items_long
+
+    if M.config.ui.confirm.default_yes then
+      prompt_input = prompt_select .. " Y/n: "
+      items_short = { "", "n" }
+      items_long = { "Yes", "No" }
+    else
+      prompt_input = prompt_select .. " y/N: "
+      items_short = { "", "y" }
+      items_long = { "No", "Yes" }
+    end
+
+    lib.prompt(prompt_input, prompt_select, items_short, items_long, function(item_short)
       utils.clear_prompt()
-      if item_short == "y" then
+      if item_short == "y" or item_short == (M.config.ui.confirm.default_yes and "") then
         do_trash()
       end
     end)

lua/nvim-tree/api.lua

@@ -45,7 +45,9 @@ end
 local function wrap_node(f)
   return function(node, ...)
     node = node or require("nvim-tree.lib").get_node_at_cursor()
-    f(node, ...)
+    if node then
+      f(node, ...)
+    end
   end
 end
 

lua/nvim-tree/git/utils.lua

@@ -36,15 +36,20 @@ function M.get_toplevel(cwd)
   -- git always returns path with forward slashes
   if vim.fn.has "win32" == 1 then
     -- msys2 git support
+    -- cygpath calls must in array format to avoid shell compatibility issues
     if M.use_cygpath then
-      toplevel = vim.fn.system("cygpath -w " .. vim.fn.shellescape(toplevel))
+      toplevel = vim.fn.system { "cygpath", "-w", toplevel }
       if vim.v.shell_error ~= 0 then
         return nil, nil
       end
-      git_dir = vim.fn.system("cygpath -w " .. vim.fn.shellescape(git_dir))
+      -- remove trailing newline(\n) character added by vim.fn.system
+      toplevel = toplevel:gsub("\n", "")
+      git_dir = vim.fn.system { "cygpath", "-w", git_dir }
       if vim.v.shell_error ~= 0 then
         return nil, nil
       end
+      -- remove trailing newline(\n) character added by vim.fn.system
+      git_dir = git_dir:gsub("\n", "")
     end
     toplevel = toplevel:gsub("/", "\\")
     git_dir = git_dir:gsub("/", "\\")

lua/nvim-tree/help.lua

@@ -84,17 +84,29 @@ end
 --- @return number maximum length of text
 local function compute()
   local head_lhs = "nvim-tree mappings"
-  local head_rhs = "exit: q"
+  local head_rhs1 = "exit: q"
+  local head_rhs2 = string.format("sort by %s: s", M.config.sort_by == "key" and "description" or "keymap")
 
   -- formatted lhs and desc from active keymap
   local mappings = vim.tbl_map(function(map)
     return { lhs = tidy_lhs(map.lhs), desc = tidy_desc(map.desc) }
   end, keymap.get_keymap())
 
-  -- sort roughly by lhs
-  table.sort(mappings, function(a, b)
-    return sort_lhs(a.lhs, b.lhs)
-  end)
+  -- sorter function for mappings
+  local sort_fn
+
+  if M.config.sort_by == "desc" then
+    sort_fn = function(a, b)
+      return a.desc:lower() < b.desc:lower()
+    end
+  else
+    -- by default sort roughly by lhs
+    sort_fn = function(a, b)
+      return sort_lhs(a.lhs, b.lhs)
+    end
+  end
+
+  table.sort(mappings, sort_fn)
 
   -- longest lhs and description
   local max_lhs = 0
@@ -105,11 +117,14 @@ local function compute()
   end
 
   -- increase desc if lines are shorter than the header
-  max_desc = math.max(max_desc, #head_lhs + #head_rhs - max_lhs)
+  max_desc = math.max(max_desc, #head_lhs + #head_rhs1 - max_lhs)
 
   -- header, not padded
   local hl = { { "NvimTreeRootFolder", 0, 0, #head_lhs } }
-  local lines = { ("%s%s%s"):format(head_lhs, string.rep(" ", max_desc + max_lhs - #head_lhs - #head_rhs + 2), head_rhs) }
+  local lines = {
+    head_lhs .. string.rep(" ", max_desc + max_lhs - #head_lhs - #head_rhs1 + 2) .. head_rhs1,
+    string.rep(" ", max_desc + max_lhs - #head_rhs2 + 2) .. head_rhs2,
+  }
   local width = #lines[1]
 
   -- mappings, left padded 1
@@ -121,7 +136,7 @@ local function compute()
     width = math.max(#line, width)
 
     -- highlight lhs
-    table.insert(hl, { "NvimTreeFolderName", i, 1, #l.lhs + 1 })
+    table.insert(hl, { "NvimTreeFolderName", i + 1, 1, #l.lhs + 1 })
   end
 
   return lines, hl, width
@@ -175,14 +190,25 @@ local function open()
   vim.wo[M.winnr].winhl = WIN_HL
   vim.wo[M.winnr].cursorline = M.config.cursorline
 
-  -- quit binding
-  vim.keymap.set("n", "q", close, {
-    desc = "nvim-tree: exit help",
-    buffer = M.bufnr,
-    noremap = true,
-    silent = true,
-    nowait = true,
-  })
+  local function toggle_sort()
+    M.config.sort_by = (M.config.sort_by == "desc") and "key" or "desc"
+    open()
+  end
+
+  local keymaps = {
+    q = { fn = close, desc = "nvim-tree: exit help" },
+    s = { fn = toggle_sort, desc = "nvim-tree: toggle sorting method" },
+  }
+
+  for k, v in pairs(keymaps) do
+    vim.keymap.set("n", k, v.fn, {
+      desc = v.desc,
+      buffer = M.bufnr,
+      noremap = true,
+      silent = true,
+      nowait = true,
+    })
+  end
 
   -- close window and delete buffer on leave
   vim.api.nvim_create_autocmd({ "BufLeave", "WinLeave" }, {
@@ -202,6 +228,7 @@ end
 
 function M.setup(opts)
   M.config.cursorline = opts.view.cursorline
+  M.config.sort_by = opts.help.sort_by
 end
 
 return M

lua/nvim-tree/renderer/components/full-name.lua

@@ -34,9 +34,6 @@ end
 
 local function show()
   local line_nr = vim.api.nvim_win_get_cursor(0)[1]
-  if line_nr == 1 and require("nvim-tree.view").is_root_folder_visible() then
-    return
-  end
   if vim.wo.wrap then
     return
   end
@@ -60,8 +57,9 @@ local function show()
   end
 
   M.popup_win = vim.api.nvim_open_win(vim.api.nvim_create_buf(false, false), false, {
-    relative = "win",
-    bufpos = { vim.fn.line "." - 2, 0 },
+    relative = "cursor",
+    row = 0,
+    col = 1 - vim.fn.getcursorcharpos()[3],
     width = math.min(text_width, vim.o.columns - 2),
     height = 1,
     noautocmd = true,
@@ -71,7 +69,7 @@ local function show()
   local ns_id = vim.api.nvim_get_namespaces()["NvimTreeHighlights"]
   local extmarks = vim.api.nvim_buf_get_extmarks(0, ns_id, { line_nr - 1, 0 }, { line_nr - 1, -1 }, { details = 1 })
   vim.api.nvim_win_call(M.popup_win, function()
-    vim.fn.setbufline("%", 1, line)
+    vim.api.nvim_buf_set_lines(0, 0, -1, true, { line })
     for _, extmark in ipairs(extmarks) do
       local hl = extmark[4]
       vim.api.nvim_buf_add_highlight(0, ns_id, hl.hl_group, 0, extmark[3], hl.end_col)

lua/nvim-tree/utils.lua

@@ -280,19 +280,38 @@ function M.move_missing_val(src, src_path, src_pos, dst, dst_path, dst_pos, remo
   end
 end
 
+local function round(value)
+  -- Amount of digits to round to after floating point.
+  local digits = 2
+  local round_number = 10 ^ digits
+  return math.floor((value * round_number) + 0.5) / round_number
+end
+
 function M.format_bytes(bytes)
-  local units = { "B", "K", "M", "G", "T" }
+  local units = { "B", "K", "M", "G", "T", "P", "E", "Z", "Y" }
+  local i = "i" -- bInary
 
   bytes = math.max(bytes, 0)
   local pow = math.floor((bytes and math.log(bytes) or 0) / math.log(1024))
   pow = math.min(pow, #units)
 
-  local value = bytes / (1024 ^ pow)
-  value = math.floor((value * 10) + 0.5) / 10
+  local value = round(bytes / (1024 ^ pow))
 
   pow = pow + 1
 
-  return (units[pow] == nil) and (bytes .. "B") or (value .. units[pow])
+  -- units[pow] == nil when size == 0 B or size >= 1024 YiB
+  if units[pow] == nil or pow == 1 then
+    if bytes < 1024 then
+      return bytes .. " " .. units[1]
+    else
+      -- Use the biggest adopted multiple of 2 instead of bytes.
+      value = round(bytes / (1024 ^ (#units - 1)))
+      -- For big numbers decimal part is not useful.
+      return string.format("%.0f %s%s%s", value, units[#units], i, units[1])
+    end
+  else
+    return value .. " " .. units[pow] .. i .. units[1]
+  end
 end
 
 function M.key_by(tbl, key)