Auto Session Nvim Tree

https://github.com/zwhitchcox/auto-session-nvim-tree
Admin
A Neovim plugin that synchronizes auto-session and nvim-tree to prevent conflicts and enable...
Tokens:2,149
Snippets:18
Trust Score:7.7
License:MIT
Update:8 months ago
Show doc for...
Tokens:
Raw
### Setup Auto Session Nvim Tree Plugin

Source: https://github.com/zwhitchcox/auto-session-nvim-tree/blob/master/README.md

This Lua code demonstrates the installation and setup of the auto-session-nvim-tree plugin. It requires both the 'auto-session' and 'auto-session-nvim-tree' plugins and configures them by calling their respective setup functions. It emphasizes the importance of `restore_upcoming_session` for proper functionality.

```lua
local auto_session = require("auto-session")
local auto_session_nvim_tree = require("auto-session-nvim-tree")

auto_session.setup {
  log_level = "error",
  cwd_change_handling = {
    restore_upcoming_session = true, -- This is necessary!!
  },
}

auto_session_nvim_tree.setup(auto_session)
```

--------------------------------

### Setup Auto Session Nvim Tree Plugin

Source: https://context7.com/zwhitchcox/auto-session-nvim-tree/llms.txt

Initializes the Auto Session Nvim Tree plugin and integrates it with an existing auto-session instance. This setup configures essential options for session restoration and enables the plugin's core functionality.

```lua
local auto_session = require("auto-session")
local auto_session_nvim_tree = require("auto-session-nvim-tree")

auto_session.setup {
  log_level = "error",
  cwd_change_handling = {
    restore_upcoming_session = true, -- Required for directory change session restoration
  },
}

auto_session_nvim_tree.setup(auto_session)
```

--------------------------------

### Configure Directory Change Handling with Hooks

Source: https://context7.com/zwhitchcox/auto-session-nvim-tree/llms.txt

Sets up auto-session with custom hooks for directory changes, enabling detailed logging and custom actions before and after session restoration. This configuration is crucial for advanced session management workflows.

```lua
local auto_session = require("auto-session")
local auto_session_nvim_tree = require("auto-session-nvim-tree")

auto_session.setup {
  log_level = "debug", -- Enable debug logging
  cwd_change_handling = {
    restore_upcoming_session = true,
    pre_cwd_changed_hook = function()
      -- Custom code to run before directory change
      print("About to change directory...")
    end,
    post_cwd_changed_hook = function()
      -- Custom code to run after session restoration
      print("Directory changed and session restored!")
    end,
  },
}

auto_session_nvim_tree.setup(auto_session)
```

--------------------------------

### Manual Nvim Tree and Auto Session Configuration (Lua)

Source: https://context7.com/zwhitchcox/auto-session-nvim-tree/llms.txt

This Lua code snippet demonstrates manual configuration for nvim-tree and auto-session. It sets up nvim-tree to synchronize with global directory changes and configures auto-session hooks to open and close nvim-tree before and after session saving/restoring. This approach ensures nvim-tree is always managed according to the defined hooks.

```lua
local function close_nvim_tree()
  require('nvim-tree.view').close()
end

local function open_nvim_tree()
  require('nvim-tree').open()
end

-- Configure nvim-tree to use global directory changes
require('nvim-tree').setup {
  sync_root_with_cwd = true,
  actions = {
    change_dir = {
      global = true, -- Use cd instead of lcd
    },
  },
}

-- Configure auto-session with manual hooks
require("auto-session").setup {
  log_level = "error",
  pre_save_cmds = { close_nvim_tree },
  post_save_cmds = { open_nvim_tree },
  post_open_cmds = { open_nvim_tree },
  post_restore_cmds = { open_nvim_tree },
  cwd_change_handling = {
    restore_upcoming_session = true,
  },
}
```

--------------------------------

### Manually Implement Post-Restore Tree Refresh Hook

Source: https://context7.com/zwhitchcox/auto-session-nvim-tree/llms.txt

Provides a manual implementation of the hook that refreshes the file tree after a session is restored. This ensures that the file explorer accurately reflects the state of the restored session by closing stale buffers and reopening them.

```lua
-- The hook is automatically added during setup
-- Manual equivalent for custom implementations:
local function refresh_tree()
  for _, bufnr in ipairs(vim.api.nvim_list_bufs()) do
    if vim.api.nvim_buf_is_loaded(bufnr) then
      local bufname = vim.api.nvim_buf_get_name(bufnr)
      local filename = vim.fn.fnamemodify(bufname, ":t")

      -- Check for nvim-tree buffer
      if filename:match("^NvimTree_[0-9]+$") then
        pcall(vim.api.nvim_buf_delete, bufnr, { force = true })
        require('nvim-tree.api').tree.toggle(false, true)
      -- Check for NERDTree buffer
      elseif filename:match("^NERD_tree_[0-9]+$") then
        pcall(vim.api.nvim_buf_delete, bufnr, { force = true })
        vim.cmd('NERDTreeOpen')
      end
    end
  end
end

-- Add to auto-session config manually
auto_session.setup {
  post_restore_cmds = { refresh_tree },
}
```

--------------------------------

### Configure Nvim Tree to Sync Root with CWD

Source: https://github.com/zwhitchcox/auto-session-nvim-tree/blob/master/README.md

This configuration snippet for nvim-tree synchronizes the plugin's root directory with the current working directory. It also enables the 'change_dir' action globally, allowing directory changes within nvim-tree to affect the global cwd.

```lua
sync_root_with_cwd = true,
actions = {
  change_dir = {
    global = true
  }
}
```

--------------------------------

### Configure Auto Session with Nvim Tree Hooks

Source: https://github.com/zwhitchcox/auto-session-nvim-tree/blob/master/README.md

This Lua configuration sets up the auto-session plugin with hooks to manage nvim-tree. It defines functions to close and open nvim-tree, and then configures auto-session to execute these functions before saving, after saving, after opening, and after restoring sessions. It also highlights the necessity of `restore_upcoming_session`.

```lua
local function close_nvim_tree()
  require('nvim-tree.view').close()
end

local function open_nvim_tree()
  require('nvim-tree').open()
end
require("auto-session").setup {
  log_level = "error",
  pre_save_cmds = {close_nvim_tree},
  post_save_cmds = {open_nvim_tree},
  post_open_cmds = {open_nvim_tree},
  post_restore_cmds = {open_nvim_tree},
  cwd_change_handling = {
    restore_upcoming_session = true, -- <-- THE DOCS LIE!! This is necessary!!
  },
}
```

--------------------------------

### Detect File Tree Buffer Type

Source: https://context7.com/zwhitchcox/auto-session-nvim-tree/llms.txt

Identifies if a given buffer belongs to a file tree explorer like nvim-tree or NERDTree. This utility function is typically used internally by the plugin to manage session events correctly.

```lua
-- Internal usage example (typically called internally by the plugin)
local Lib = require("auto-session-nvim-tree-library")

-- Check if current buffer is a file tree
local bufnr = vim.api.nvim_get_current_buf()
local tree_type = Lib.tree_buf_type(bufnr)

if tree_type == "nvimtree" then
  print("Current buffer is nvim-tree")
elseif tree_type == "nerdtree" then
  print("Current buffer is NERDTree")
else
  print("Current buffer is not a file tree explorer")
end
```
Tokens:
Raw