feat(command): state config overrides via command.execute() (#1926)

Author: pynappo

lua/neo-tree/command/init.lua

@@ -17,33 +17,28 @@ M._last = {
   position = nil,
 }
 
----Executes a Neo-tree action from outside of a Neo-tree window,
----such as show, hide, navigate, etc.
----@param args table The action to execute. The table can have the following keys:
----  action = string   The action to execute, can be one of:
----                    "close",
----                    "focus", <-- default value
----                    "show",
----  source = string   The source to use for this action. This will default
----                    to the default_source specified in the user's config.
----                    Can be one of:
----                    "filesystem",
----                    "buffers",
----                    "git_status",
---                     "migrations"
----  position = string The position this action will affect. This will default
----                    to the the last used position or the position specified
----                    in the user's config for the given source. Can be one of:
----                    "left",
----                    "right",
----                    "float",
----                    "current"
----  toggle = boolean  Whether to toggle the visibility of the Neo-tree window.
----  reveal = boolean  Whether to reveal the current file in the Neo-tree window.
----  reveal_file = string The specific file to reveal.
----  dir = string      The root directory to set.
----  git_base = string The git base used for diff
-M.execute = function(args)
+---@class neotree.command.execute.Args
+---The action to execute
+---@field action string|"focus"|"show"|"close"?
+---The source to use for this action. This will default to the default_source specified in the user's config.
+---@field source string|"filesystem"|"buffers"|"git_status"|"migrations"|"last"?
+---The position this action will affect. This will default to the the last used position or the position specified in
+---the user's config for the given source.
+---@field position string|"left"|"right"|"float"|"current"?
+---@field toggle boolean? Whether to toggle the visibility of the Neo-tree window.
+---@field selector boolean? Whether to toggle the visibility of the Neo-tree window.
+---@field reveal boolean? Whether to reveal the current file in the Neo-tree window.
+---@field reveal_file string? The specific file to reveal.
+---@field reveal_force_cwd boolean? Whether to always change directories when a reveal file is outside the cwd.
+---@field dir string? The root directory to set.
+---@field git_base string? The git base used for diff
+
+---@class (partial) neotree.command.execute.StateConfigOverride : neotree.Config.Filesystem, neotree.Config.Buffers, neotree.Config.GitStatus, neotree.Config.DocumentSymbols
+
+---Executes a Neo-tree command, like focus/show/close.
+---@param args neotree.command.execute.Args
+---@param state_config_override neotree.command.execute.StateConfigOverride?
+M.execute = function(args, state_config_override)
   local nt = require("neo-tree")
   nt.ensure_config()
 
@@ -100,8 +95,14 @@ M.execute = function(args)
   if requested_position == "current" then
     local winid = vim.api.nvim_get_current_win()
     state = manager.get_state(args.source, nil, winid)
+    if state_config_override then
+      state = manager._change_state(args.source, nil, winid, state_config_override)
+    end
   else
     state = manager.get_state(args.source, nil, nil)
+    if state_config_override then
+      state = manager._change_state(args.source, nil, nil, state_config_override)
+    end
   end
 
   -- Next handle toggle, the rest is irrelevant if there is a window to toggle
@@ -113,12 +114,8 @@ M.execute = function(args)
   end
 
   -- Handle position override
-  local default_position = nt.config[args.source].window.position
-  local current_position = state.current_position or default_position
-  local position_changed = false
   if args.position then
     state.current_position = args.position
-    position_changed = args.position ~= current_position
   end
 
   -- Handle setting directory if requested

lua/neo-tree/command/parser.lua

@@ -184,7 +184,7 @@ end
 
 ---@param args string|string[]
 ---@param strict_checking boolean
----@return neotree.command.Parser.Parsed parsed_args
+---@return neotree.command.execute.Args parsed_args
 M.parse = function(args, strict_checking)
   require("neo-tree").ensure_config()
   local result = {}

lua/neo-tree/sources/manager.lua

@@ -214,6 +214,29 @@ M.get_state = function(source_name, tabid, winid)
   return tab_state
 end
 
+---Modifies an existing state. Does not currently create a new one if one does not exist.
+---@param source_name string
+---@param tabid integer?
+---@param winid integer?
+---@param override table
+---@return neotree.State new_state
+M._change_state = function(source_name, tabid, winid, override)
+  assert(source_name, "get_state: source_name cannot be nil")
+  tabid = tabid or vim.api.nvim_get_current_tabpage()
+  local sd = get_source_data(source_name)
+  if type(winid) == "number" then
+    local cur_state = assert(sd.state_by_win[winid], "no state for winid " .. winid)
+    local new_state = vim.tbl_deep_extend("force", cur_state, override)
+    sd.state_by_win[winid] = new_state
+    return new_state
+  end
+
+  local cur_state = assert(sd.state_by_tab[tabid], "no state for tabid " .. tabid)
+  local new_state = vim.tbl_deep_extend("force", cur_state, override)
+  sd.state_by_tab[tabid] = new_state
+  return new_state
+end
+
 ---Returns the state for the current buffer, assuming it is a neo-tree buffer.
 ---@param winid number? The window id to use, if nil, the current window is used.
 ---@return neotree.State? state The state for the current buffer, if it's a neo-tree buffer.

tests/neo-tree/manager/state_spec.lua

@@ -91,6 +91,24 @@ describe("Manager", function()
     }
   end
 
+  it("can retrieve/create states at startup", function()
+    local fs_state = manager.get_state("filesystem")
+    local buffers_state = manager.get_state("buffers")
+    assert.are_equal(type(fs_state), "table")
+    assert.are_equal(type(buffers_state), "table")
+  end)
+  it("can change states", function()
+    local old_state = manager.get_state("filesystem")
+    local new_bind_to_cwd = old_state.bind_to_cwd
+
+    local overridden_state = manager._change_state("filesystem", nil, nil, {
+      bind_to_cwd = new_bind_to_cwd,
+    })
+    local new_stored_state = manager.get_state("filesystem")
+    assert.are_equal(overridden_state, new_stored_state)
+    assert(new_stored_state.bind_to_cwd == new_bind_to_cwd)
+  end)
+
   it("should respect changed tab cwd", function()
     local ctx = setup_2_tabs()