Skip to content

Commit 3ba383d

Browse files
authored
chore/remove globals (#1279)
* remove renderer globals: nvim_tree_add_trailing nvim_tree_highlight_opened_files nvim_tree_root_folder_modifier nvim_tree_special_files * remove renderer globals: nvim_tree_icon_padding * remove renderer globals: nvim_tree_symlink_arrow * remove renderer globals: nvim_tree_show_icons, nvim_tree_show_icons * remove renderer globals: nvim_tree_git_hl * remove renderer globals: nvim_tree_group_empty * remove renderer globals: respect_buf_cwd * remove renderer globals: nvim_tree_create_in_closed_folder * remove globals: consistency in legacy checks * remove renderer globals: nvim_tree_special_files * renderer.icons.symbols -> glyphs
1 parent 6abc87b commit 3ba383d

File tree

17 files changed

+404
-344
lines changed

17 files changed

+404
-344
lines changed

README.md

Lines changed: 41 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -32,60 +32,11 @@ use {
3232

3333
## Setup
3434

35-
Options are currently being migrated into the setup function, you need to run `require'nvim-tree'.setup()` in your personal configurations.
3635
Setup should be run in a lua file or in a lua heredoc (`:help lua-heredoc`) if using in a vim file.
37-
Note that options under the `g:` command should be set **BEFORE** running the setup function.
38-
These are being migrated to the setup function incrementally, check [this issue](https://github.com/kyazdani42/nvim-tree.lua/issues/674) if you encounter any problems related to configs not working after update.
36+
Legacy `g:` options have been migrated to the setup function. See [this issue](https://github.com/kyazdani42/nvim-tree.lua/issues/674) for information on migrating your configuration.
37+
3938
```vim
4039
" vimrc
41-
let g:nvim_tree_git_hl = 1 "0 by default, will enable file highlight for git attributes (can be used without the icons).
42-
let g:nvim_tree_highlight_opened_files = 1 "0 by default, will enable folder and file icon highlight for opened files/directories.
43-
let g:nvim_tree_root_folder_modifier = ':~' "This is the default. See :help filename-modifiers for more options
44-
let g:nvim_tree_add_trailing = 1 "0 by default, append a trailing slash to folder names
45-
let g:nvim_tree_group_empty = 1 " 0 by default, compact folders that only contain a single folder into one node in the file tree
46-
let g:nvim_tree_icon_padding = ' ' "one space by default, used for rendering the space between the icon and the filename. Use with caution, it could break rendering if you set an empty string depending on your font.
47-
let g:nvim_tree_symlink_arrow = ' >> ' " defaults to ' ➛ '. used as a separator between symlinks' source and target.
48-
let g:nvim_tree_respect_buf_cwd = 1 "0 by default, will change cwd of nvim-tree to that of new buffer's when opening nvim-tree.
49-
let g:nvim_tree_create_in_closed_folder = 1 "0 by default, When creating files, sets the path of a file when cursor is on a closed folder to the parent folder when 0, and inside the folder when 1.
50-
let g:nvim_tree_special_files = { 'README.md': 1, 'Makefile': 1, 'MAKEFILE': 1 } " List of filenames that gets highlighted with NvimTreeSpecialFile
51-
let g:nvim_tree_show_icons = {
52-
\ 'git': 1,
53-
\ 'folders': 0,
54-
\ 'files': 0,
55-
\ 'folder_arrows': 0,
56-
\ }
57-
"If 0, do not show the icons for one of 'git' 'folder' and 'files'
58-
"1 by default, notice that if 'files' is 1, it will only display
59-
"if nvim-web-devicons is installed and on your runtimepath.
60-
"if folder is 1, you can also tell folder_arrows 1 to show small arrows next to the folder icons.
61-
"but this will not work when you set renderer.indent_markers.enable (because of UI conflict)
62-
63-
" default will show icon by default if no icon is provided
64-
" default shows no icon by default
65-
let g:nvim_tree_icons = {
66-
\ 'default': "",
67-
\ 'symlink': "",
68-
\ 'git': {
69-
\ 'unstaged': "✗",
70-
\ 'staged': "✓",
71-
\ 'unmerged': "",
72-
\ 'renamed': "➜",
73-
\ 'untracked': "★",
74-
\ 'deleted': "",
75-
\ 'ignored': "◌"
76-
\ },
77-
\ 'folder': {
78-
\ 'arrow_open': "",
79-
\ 'arrow_closed': "",
80-
\ 'default': "",
81-
\ 'open': "",
82-
\ 'empty': "",
83-
\ 'empty_open': "",
84-
\ 'symlink': "",
85-
\ 'symlink_open': "",
86-
\ }
87-
\ }
88-
8940
nnoremap <C-n> :NvimTreeToggle<CR>
9041
nnoremap <leader>r :NvimTreeRefresh<CR>
9142
nnoremap <leader>n :NvimTreeFindFile<CR>
@@ -118,6 +69,7 @@ require'nvim-tree'.setup {
11869
-- nested options are documented by accessing them with `.` (eg: `:help nvim-tree.view.mappings.list`).
11970
require'nvim-tree'.setup { -- BEGIN_DEFAULT_OPTS
12071
auto_reload_on_write = true,
72+
create_in_closed_folder = false,
12173
disable_netrw = false,
12274
hijack_cursor = false,
12375
hijack_netrw = true,
@@ -129,6 +81,7 @@ require'nvim-tree'.setup { -- BEGIN_DEFAULT_OPTS
12981
sort_by = "name",
13082
update_cwd = false,
13183
reload_on_bufenter = false,
84+
respect_buf_cwd = false,
13285
view = {
13386
width = 30,
13487
height = 30,
@@ -146,6 +99,11 @@ require'nvim-tree'.setup { -- BEGIN_DEFAULT_OPTS
14699
},
147100
},
148101
renderer = {
102+
add_trailing = false,
103+
group_empty = false,
104+
highlight_git = false,
105+
highlight_opened_files = "none",
106+
root_folder_modifier = ":~",
149107
indent_markers = {
150108
enable = false,
151109
icons = {
@@ -157,7 +115,39 @@ require'nvim-tree'.setup { -- BEGIN_DEFAULT_OPTS
157115
icons = {
158116
webdev_colors = true,
159117
git_placement = "before",
118+
padding = " ",
119+
symlink_arrow = "",
120+
show = {
121+
file = true,
122+
folder = true,
123+
folder_arrow = true,
124+
git = true,
125+
},
126+
glyphs = {
127+
default = "",
128+
symlink = "",
129+
folder = {
130+
arrow_closed = "",
131+
arrow_open = "",
132+
default = "",
133+
open = "",
134+
empty = "",
135+
empty_open = "",
136+
symlink = "",
137+
symlink_open = "",
138+
},
139+
git = {
140+
unstaged = "",
141+
staged = "",
142+
unmerged = "",
143+
renamed = "",
144+
untracked = "",
145+
deleted = "",
146+
ignored = "",
147+
},
148+
},
160149
},
150+
special_files = { "Cargo.toml", "Makefile", "README.md", "readme.md" },
161151
},
162152
hijack_directories = {
163153
enable = true,

0 commit comments

Comments
 (0)