Merge branch 'master' into 2415-highlight-overhaul

Author: alex-courtis

.github/workflows/ci.yml

@@ -8,28 +8,35 @@ on:
     branches:
       - master
 
+permissions:
+  contents: read
+
 jobs:
-  luacheck:
-    name: luacheck
+  lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
-      - name: Prepare
+      - uses: leafo/gh-actions-lua@v10
+        with:
+          luaVersion: "5.1"
+
+      - uses: leafo/gh-actions-luarocks@v4
+
+      - name: luacheck
         run: |
-          sudo apt-get update
-          sudo add-apt-repository universe
-          sudo apt install luarocks -y
-          sudo luarocks install luacheck
-      - name: Run luacheck
-        run: luacheck .
-  stylua:
-    name: stylua
+          luarocks install luacheck 1.1.1
+          luacheck lua
+
+  style:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: JohnnyMorganz/stylua-action@v3
+
+      - name: stylua
+        uses: JohnnyMorganz/stylua-action@v3
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          version: latest
-          args: --color always --check lua/
+          version: "0.19"
+          args: --check lua
+

README.md

@@ -61,7 +61,9 @@ require("nvim-tree").setup()
 
 -- OR setup with some options
 require("nvim-tree").setup({
-  sort_by = "case_sensitive",
+  sort = {
+    sorter = "case_sensitive",
+  },
   view = {
     width = 30,
   },

doc/nvim-tree-lua.txt

@@ -233,7 +233,7 @@ via |nvim-tree.on_attach| e.g. >
 
     Opens the tree. See |nvim-tree-api.tree.open()|
 
-    Calls: `api.tree.open({ path = "<arg>" })`
+    Calls: `api.tree.open({ path = "<args>" })`
 
 *:NvimTreeClose*
 
@@ -245,13 +245,13 @@ via |nvim-tree.on_attach| e.g. >
 
     Open or close the tree. See |nvim-tree-api.tree.toggle()|
 
-    Calls: `api.tree.toggle({ path = "<arg>" })`
+    Calls: `api.tree.toggle({ path = "<args>", find_file = false, update_root = false, focus = true, })`
 
 *:NvimTreeFocus*
 
     Open the tree if it is closed, and then focus on the tree.
 
-    See |nvim-tree-api.tree.toggle()|
+    See |nvim-tree-api.tree.focus()|
 
     Calls: `api.tree.focus()`
 
@@ -273,7 +273,7 @@ via |nvim-tree.on_attach| e.g. >
 
     See |nvim-tree-api.tree.find_file()|
 
-    Calls: `api.tree.find_file { open = true, update_root = <bang> }`
+    Calls: `api.tree.find_file({ update_root = <bang>, open = true, focus = true, })`
 
 *:NvimTreeFindFileToggle*
 
@@ -285,7 +285,7 @@ via |nvim-tree.on_attach| e.g. >
 
     See |nvim-tree-api.tree.toggle()|
 
-    Calls: `api.tree.toggle { find_file = true, focus = true, path = "<arg>", update_root = <bang> }`
+    Calls: `api.tree.toggle({ path = "<args>", update_root = <bang>, find_file = true, focus = true, })`
 
 *:NvimTreeClipboard*
 
@@ -1701,6 +1701,18 @@ tree.is_visible({opts})                      *nvim-tree-api.tree.is_visible()*
     Return: ~
       (boolean) nvim-tree is visible
 
+tree.winid({opts})                              *nvim-tree-api.tree.winid()*
+    Retrieve the winid of the open tree.
+
+    Parameters: ~
+      • {opts} (table) optional parameters
+
+    Options: ~
+      • {tabpage}        (number|nil)  tabpage, 0 or nil for current, default nil
+
+    Return: ~
+      (number) winid or nil if tree is not visible
+
 ==============================================================================
  6.2 API FILE SYSTEM                                        *nvim-tree-api.fs*
 

lua/nvim-tree/actions/reloaders/reloaders.lua

@@ -11,7 +11,7 @@ local M = {}
 local function refresh_nodes(node, projects)
   Iterator.builder({ node })
     :applier(function(n)
-      if n.open and n.nodes then
+      if n.nodes then
         local toplevel = git.get_toplevel(n.cwd or n.link_to or n.absolute_path)
         explorer_module.reload(n, projects[toplevel] or {})
       end

lua/nvim-tree/api.lua

@@ -145,6 +145,11 @@ Api.tree.is_tree_buf = wrap(require("nvim-tree.utils").is_nvim_tree_buf)
 
 Api.tree.is_visible = wrap(require("nvim-tree.view").is_visible)
 
+---@class ApiTreeWinIdOpts
+---@field tabpage number|nil default nil
+
+Api.tree.winid = wrap(require("nvim-tree.view").winid)
+
 Api.fs.create = wrap_node_or_nil(require("nvim-tree.actions.fs.create-file").fn)
 Api.fs.remove = wrap_node(require("nvim-tree.actions.fs.remove-file").fn)
 Api.fs.trash = wrap_node(require("nvim-tree.actions.fs.trash").fn)

lua/nvim-tree/core.lua

@@ -28,7 +28,7 @@ function M.get_explorer()
 end
 
 function M.get_cwd()
-  return TreeExplorer.absolute_path
+  return TreeExplorer and TreeExplorer.absolute_path
 end
 
 function M.get_nodes_starting_line()

lua/nvim-tree/log.lua

@@ -61,6 +61,26 @@ function M.line(typ, fmt, ...)
   end
 end
 
+local inspect_opts = {}
+
+--- @param opts table
+function M.set_inspect_opts(opts)
+  inspect_opts = opts
+end
+
+--- Write to log file the inspection of a node
+--- defaults to the node under cursor if none is provided
+--- @param typ string as per log.types config
+--- @param node table|nil node to be inspected
+--- @param fmt string for string.format
+--- @vararg any arguments for string.format
+function M.node(typ, node, fmt, ...)
+  if M.enabled(typ) then
+    node = node or require("nvim-tree.lib").get_node_at_cursor()
+    M.raw(typ, string.format("[%s] [%s] %s\n%s\n", os.date "%Y-%m-%d %H:%M:%S", typ, (fmt or "???"), vim.inspect(node, inspect_opts)), ...)
+  end
+end
+
 --- Logging is enabled for typ or all
 --- @param typ string as per log.types config
 --- @return boolean

lua/nvim-tree/view.lua

@@ -427,6 +427,21 @@ function M.focus(winnr, open_if_closed)
   vim.api.nvim_set_current_win(wnr)
 end
 
+--- Retrieve the winid of the open tree.
+--- @param opts ApiTreeWinIdOpts|nil
+--- @return number|nil winid unlike get_winnr(), this returns nil if the nvim-tree window is not visible
+function M.winid(opts)
+  local tabpage = opts and opts.tabpage
+  if tabpage == 0 then
+    tabpage = vim.api.nvim_get_current_tabpage()
+  end
+  if M.is_visible { tabpage = tabpage } then
+    return M.get_winnr(tabpage)
+  else
+    return nil
+  end
+end
+
 --- Restores the state of a NvimTree window if it was initialized before.
 function M.restore_tab_state()
   local tabpage = vim.api.nvim_get_current_tabpage()