tomas.mirchev/nvim-tree.lua
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(view): deprecate open_on_setup.* in favour of https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup (#1951)

Browse Source
This commit is contained in:
Alexander Courtis
2023-01-30 10:10:41 +11:00
committed by GitHub
parent e14989c0ea
commit fb775b3353
2 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/nvim-tree-lua.txt
View File

@@ -427,21 +427,25 @@ Hijack netrw windows (overridden if |disable_netrw| is `true`)
Type: `boolean`, Default: `true` Type: `boolean`, Default: `true`
*nvim-tree.open_on_setup* *nvim-tree.open_on_setup*
Deprecated: please see https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup
Will automatically open the tree when running setup if startup buffer is Will automatically open the tree when running setup if startup buffer is
a directory, is empty or is unnamed. nvim-tree window will be focused. a directory, is empty or is unnamed. nvim-tree window will be focused.
Type: `boolean`, Default: `false` Type: `boolean`, Default: `false`
*nvim-tree.open_on_setup_file* *nvim-tree.open_on_setup_file*
Deprecated: please see https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup
Will automatically open the tree when running setup if startup buffer is a file. Will automatically open the tree when running setup if startup buffer is a file.
File window will be focused. File window will be focused.
File will be found if update_focused_file is enabled. File will be found if update_focused_file is enabled.
Type: `boolean`, Default: `false` Type: `boolean`, Default: `false`
*nvim-tree.ignore_buffer_on_setup* *nvim-tree.ignore_buffer_on_setup*
Deprecated: please see https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup
Will ignore the buffer, when deciding to open the tree on setup. Will ignore the buffer, when deciding to open the tree on setup.
Type: `boolean`, Default: `false` Type: `boolean`, Default: `false`
*nvim-tree.ignore_ft_on_setup* *nvim-tree.ignore_ft_on_setup*
Deprecated: please see https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup
List of filetypes that will prevent `open_on_setup` to open. List of filetypes that will prevent `open_on_setup` to open.
You can use this option if you don't want the tree to open You can use this option if you don't want the tree to open
in some scenarios (eg using vim startify). in some scenarios (eg using vim startify).

11
lua/nvim-tree.lua
View File

@@ -13,6 +13,7 @@ local collapse_all = require "nvim-tree.actions.tree-modifiers.collapse-all"
local git = require "nvim-tree.git" local git = require "nvim-tree.git"
local filters = require "nvim-tree.explorer.filters" local filters = require "nvim-tree.explorer.filters"
local modified = require "nvim-tree.modified" local modified = require "nvim-tree.modified"
local notify = require "nvim-tree.notify"
local _config = {} local _config = {}
@@ -900,7 +901,17 @@ function M.setup(conf)
M.setup_called = true M.setup_called = true
vim.schedule(function() vim.schedule(function()
if
#opts.ignore_ft_on_setup > 0
or opts.open_on_setup == true
or opts.open_on_setup_file
or opts.ignore_buffer_on_setup
then
notify.info "open_on_setup behaviour has been deprecated, please see https://github.com/nvim-tree/nvim-tree.lua/wiki/Open-At-Startup"
M.on_enter(netrw_disabled) M.on_enter(netrw_disabled)
else
M.initialized = true
end
vim.g.NvimTreeSetup = 1 vim.g.NvimTreeSetup = 1
vim.api.nvim_exec_autocmds("User", { pattern = "NvimTreeSetup" }) vim.api.nvim_exec_autocmds("User", { pattern = "NvimTreeSetup" })
end) end)