feat: add neo_tree_buffer_enter/leave events, closes #155, #165, #211

Author: cseickel

doc/neo-tree.txt

@@ -717,29 +717,29 @@ of objects in the form:
 
 The following events are available:
 
-"before_render"
+"before_render"~
 Fired after items have been collected from the source but before drawing the
 nodes of the tree. This is the best place to gather additional data to be used
 by components. The argument passed is the state of the source, which is also
 passed to components and commands down the line.
 
-"after_render"
+"after_render"~
 Fired after the tree has been rendered. The argument passed is the state of the
 source, which is also passed to components and commands down the line.
 
-"file_added"
+"file_added"~
 Fired after a file (or folder) has been created, either by using the "add"
 command or by copy and paste. The arg is the full path to the new file.
 
-"file_deleted"
+"file_deleted"~
 Fired after a file (or folder) has been deleted. The arg is the full path to the
 deleted file.
 
-"file_moved"
+"file_moved"~
 Fired after a file (or folder) has been moved. The arg is a table containing
 `source` and `destination` properties.
 
-"file_open_requested"
+"file_open_requested"~
 Fired just before a file is opened. The arg is a table containing the `state`
 of the source being used, the `path` of the file to be opened, and `open_cmd`,
 which is the open command that was requested. `open_cmd` will be either |edit|,
@@ -748,38 +748,57 @@ which is the open command that was requested. `open_cmd` will be either |edit|,
 was not. If `{ handled = true }` is not returned, the file will be opened using
 the built-in logic.
 
-"file_opened"
+"file_opened"~
 Fired after a file has been opened. You might use this to auto-close the window
 or clear the filter. The arg is the path of the file opened.
 
-"file_renamed"
+"file_renamed"~
 Fired after a file (or folder) has been renamed. The arg is an table containing
 `source` and `destination` properties.
 
+"neo_tree_buffer_enter"~
+Fired after entering a neo-tree buffer. It is also right after neo-tree applies
+it's own settings, so it's the ideal place to apply any local settings you would
+like to have.
+
+"neo_tree_buffer_leave"~
+Fired after a neo-tree buffer was exited. Technically it fires when entering a
+buffer that is not neo-tree, when the last buffer enter event was neo-tree.
+
+"neo_tree_popup_buffer_enter"~
+Fired after entering a neo-tree popup buffer. This includes things such as file
+rename prompts and filter inputs. It runs right after neo-tree applies it's own
+settings, so it's the ideal place to apply any local settings you would like to
+have.
+
+"neo_tree_popup_buffer_leave"~
+Fired after leaving a neo-tree popup buffer.
+
+
 NOTE: The following events are used internally and not intended for end user
 usage. You can use them if you want, but beware that they may be debounced, and
 the details of how frequently they are fired and what events are dropped will be
 changed without warning.
 
-"vim_diagnostic_changed"
+"vim_diagnostic_changed"~
 Fired on the |DiagnosticChanged| autocmd event. The arg is a table with one
 property: `diagnostics_lookup`, which is a table where the keys are file names
 and the values are tables with diagnostic counts by severity level.
 
-"vim_buffer_changed"
+"vim_buffer_changed"~
 Fired on the following autocmd events: |BufDelete|, |BufWritePost|,
 |BufFilePost|, |BufNew|
 
-"vim_buffer_enter"
+"vim_buffer_enter"~
 Fired on the following autocmd events: |BufEnter|, |BufWinEnter|
 
-"vim_dir_changed"
+"vim_dir_changed"~
 Fired on the |DirChanged| autocmd event
 
-"vim_win_enter"
+"vim_win_enter"~
 Fired on the |WinEnter| autocmd event
 
-"vim_colorscheme"
+"vim_colorscheme"~
 Fired on the |ColorScheme| autocmd event
 
 

lua/neo-tree/defaults.lua

@@ -50,6 +50,18 @@ local config = {
   --      print(args.source, " moved to ", args.destination)
   --    end
   --  },
+  --  {
+  --    event = "neo_tree_buffer_enter",
+  --    handler = function()
+  --      vim.cmd 'highlight! Cursor blend=100'
+  --    end
+  --  },
+  --  {
+  --    event = "neo_tree_buffer_leave",
+  --    handler = function()
+  --      vim.cmd 'highlight! Cursor guibg=#5f87af blend=0'
+  --    end
+  --  }
   --},
   default_component_configs = {
     indent = {

lua/neo-tree/events/init.lua

@@ -16,6 +16,10 @@ local M = {
   FS_EVENT = "fs_event",
   GIT_EVENT = "git_event",
   GIT_STATUS_CHANGED = "git_status_changed",
+  NEO_TREE_BUFFER_ENTER = "neo_tree_buffer_enter",
+  NEO_TREE_BUFFER_LEAVE = "neo_tree_buffer_leave",
+  NEO_TREE_POPUP_BUFFER_ENTER = "neo_tree_popup_buffer_enter",
+  NEO_TREE_POPUP_BUFFER_LEAVE = "neo_tree_popup_buffer_leave",
   VIM_BUFFER_ADDED = "vim_buffer_added",
   VIM_BUFFER_CHANGED = "vim_buffer_changed",
   VIM_BUFFER_DELETED = "vim_buffer_deleted",

lua/neo-tree/setup/init.lua

@@ -61,6 +61,7 @@ local define_events = function()
   events_setup = true
 end
 
+local last_buffer_enter_filetype = nil
 M.buffer_enter_event = function()
   -- if it is a neo-tree window, just set local options
   if vim.bo.filetype == "neo-tree" then
@@ -70,16 +71,29 @@ M.buffer_enter_event = function()
     setlocal winhighlight=Normal:NeoTreeNormal,NormalNC:NeoTreeNormalNC,CursorLine:NeoTreeCursorLine,FloatBorder:NeoTreeFloatBorder
     setlocal nolist nospell nonumber norelativenumber
     ]])
+    events.fire_event(events.NEO_TREE_BUFFER_ENTER)
+    last_buffer_enter_filetype = vim.bo.filetype
     return
   end
   if vim.bo.filetype == "neo-tree-popup" then
     vim.cmd([[
     setlocal winhighlight=Normal:NeoTreeNormal,FloatBorder:NeoTreeFloatBorder
     setlocal nolist nospell nonumber norelativenumber
     ]])
+    events.fire_event(events.NEO_TREE_POPUP_BUFFER_ENTER)
+    last_buffer_enter_filetype = vim.bo.filetype
     return
   end
 
+  if last_buffer_enter_filetype == "neo-tree" then
+    events.fire_event(events.NEO_TREE_BUFFER_LEAVE)
+  end
+  if last_buffer_enter_filetype == "neo-tree-popup" then
+    events.fire_event(events.NEO_TREE_POPUP_BUFFER_LEAVE)
+  end
+  last_buffer_enter_filetype = vim.bo.filetype
+
+
   -- there is nothing more we want to do with floating windows
   if utils.is_floating() then
     return