@@ -55,7 +55,7 @@ vim.cmd([[ let g:neo_tree_remove_legacy_commands = 1 ]])
55
55
use {
56
56
" nvim-neo-tree/neo-tree.nvim" ,
57
57
branch = " v2.x" ,
58
- requires = {
58
+ requires = {
59
59
" nvim-lua/plenary.nvim" ,
60
60
" nvim-tree/nvim-web-devicons" , -- not strictly required, but recommended
61
61
" MunifTanjim/nui.nvim" ,
@@ -74,12 +74,12 @@ Press `?` in the Neo-tree window to view the list of mappings.
74
74
## Quickstart
75
75
76
76
#### Longer Example for Packer:
77
-
77
+
78
78
``` lua
79
79
use {
80
80
" nvim-neo-tree/neo-tree.nvim" ,
81
81
branch = " v2.x" ,
82
- requires = {
82
+ requires = {
83
83
" nvim-lua/plenary.nvim" ,
84
84
" nvim-tree/nvim-web-devicons" , -- not strictly required, but recommended
85
85
" MunifTanjim/nui.nvim" ,
@@ -118,7 +118,7 @@ use {
118
118
vim .fn .sign_define (" DiagnosticSignInfo" ,
119
119
{text = " " , texthl = " DiagnosticSignInfo" })
120
120
vim .fn .sign_define (" DiagnosticSignHint" ,
121
- {text = " " , texthl = " DiagnosticSignHint" })
121
+ {text = " " , texthl = " DiagnosticSignHint" })
122
122
-- NOTE: this is changed from v1.x, which used the old style of highlight groups
123
123
-- in the form "LspDiagnosticsSignWarning"
124
124
@@ -129,7 +129,7 @@ use {
129
129
enable_diagnostics = true ,
130
130
open_files_do_not_replace_types = { " terminal" , " trouble" , " qf" }, -- when opening files, do not use windows containing these filetypes or buftypes
131
131
sort_case_insensitive = false , -- used when sorting files and directories in the tree
132
- sort_function = nil , -- use a custom function for sorting files and directories in the tree
132
+ sort_function = nil , -- use a custom function for sorting files and directories in the tree
133
133
-- sort_function = function (a,b)
134
134
-- if a.type == b.type then
135
135
-- return a.path > b.path
@@ -158,7 +158,7 @@ use {
158
158
icon = {
159
159
folder_closed = " " ,
160
160
folder_open = " " ,
161
- folder_empty = " ﰊ " ,
161
+ folder_empty = " " ,
162
162
-- The next two settings are only a fallback, if you use nvim-web-devicons and configure default icons there
163
163
-- then these will never be used.
164
164
default = " *" ,
@@ -179,11 +179,11 @@ use {
179
179
added = " " , -- or "✚", but this is redundant info if you use git_status_colors on the name
180
180
modified = " " , -- or "", but this is redundant info if you use git_status_colors on the name
181
181
deleted = " ✖" ,-- this can only be used in the git_status source
182
- renamed = " " ,-- this can only be used in the git_status source
182
+ renamed = " " ,-- this can only be used in the git_status source
183
183
-- Status type
184
184
untracked = " " ,
185
185
ignored = " " ,
186
- unstaged = " " ,
186
+ unstaged = " " ,
187
187
staged = " " ,
188
188
conflict = " " ,
189
189
}
@@ -201,9 +201,9 @@ use {
201
201
nowait = true ,
202
202
},
203
203
mappings = {
204
- [" <space>" ] = {
205
- " toggle_node" ,
206
- nowait = false , -- disable `nowait` if you have existing combos starting with this char that you want to use
204
+ [" <space>" ] = {
205
+ " toggle_node" ,
206
+ nowait = false , -- disable `nowait` if you have existing combos starting with this char that you want to use
207
207
},
208
208
[" <2-LeftMouse>" ] = " open" ,
209
209
[" <cr>" ] = " open" ,
@@ -223,7 +223,7 @@ use {
223
223
-- ['C'] = 'close_all_subnodes',
224
224
[" z" ] = " close_all_nodes" ,
225
225
-- ["Z"] = "expand_all_nodes",
226
- [" a" ] = {
226
+ [" a" ] = {
227
227
" add" ,
228
228
-- this command supports BASH style brace expansion ("x{a,b,c}" -> xa,xb,xc). see `:h neo-tree-file-actions` for details
229
229
-- some commands may take optional config options, see `:h neo-tree-mappings` for details
@@ -355,7 +355,7 @@ See `:h neo-tree` for full documentation. You can also preview that online at
355
355
356
356
To see all of the default config options with commentary, you can view it online
357
357
at [ lua/neo-tree/defaults.lua] ( lua/neo-tree/defaults.lua ) . You can also paste it
358
- into a buffer after installing Neo-tree by running:
358
+ into a buffer after installing Neo-tree by running:
359
359
360
360
```
361
361
:lua require("neo-tree").paste_default_config()
@@ -413,7 +413,7 @@ require("neo-tree").setup({
413
413
## The ` :Neotree ` Command
414
414
415
415
The single ` :Neotree ` command accepts a range of arguments that give you full
416
- control over the details of what and where it will show. For example, the following
416
+ control over the details of what and where it will show. For example, the following
417
417
command will open a file browser on the right hand side, "revealing" the currently
418
418
active file:
419
419
@@ -436,7 +436,7 @@ without any arguments, it will use default values for everything. For example:
436
436
:Neotree
437
437
```
438
438
439
- will open the filesystem source on the left hand side and focus it, if you are using
439
+ will open the filesystem source on the left hand side and focus it, if you are using
440
440
the default config.
441
441
442
442
### Tab Completion
@@ -502,7 +502,7 @@ current file. For example:
502
502
The base that is used to calculate the git status for each dir/file.
503
503
By default it uses ` HEAD ` , so it shows all changes that are not yet committed.
504
504
You can for example work on a feature branch, and set it to ` main ` . It will
505
- show all changes that happened on the feature branch and main since you
505
+ show all changes that happened on the feature branch and main since you
506
506
branched off.
507
507
508
508
Any git ref, commit, tag, or sha will work.
@@ -515,7 +515,7 @@ Any git ref, commit, tag, or sha will work.
515
515
```
516
516
517
517
#### ` reveal `
518
- This is a boolean flag. Adding this will make Neotree automatically find and
518
+ This is a boolean flag. Adding this will make Neotree automatically find and
519
519
focus the current file when it opens.
520
520
521
521
#### ` reveal_file `
@@ -596,7 +596,7 @@ the same list you would see from `:ls`. To show with the `buffers` list, use:
596
596
This view take the results of the ` git status ` command and display them in a
597
597
tree. It includes commands for adding, unstaging, reverting, and committing.
598
598
599
- The screenshot below shows the result of ` :Neotree float git_status ` while the
599
+ The screenshot below shows the result of ` :Neotree float git_status ` while the
600
600
filesystem is open in a sidebar:
601
601
602
602
![ Neo-tree git_status] ( https://github.com/nvim-neo-tree/resources/raw/main/images/Neo-tree-git_status.png )
@@ -625,15 +625,15 @@ following features:
625
625
- [x] Rename symbols (`rename`)
626
626
- [x] Preview symbol (`preview` and friends)
627
627
- [ ] Hover docs
628
- - [ ] Call hierarchy
628
+ - [ ] Call hierarchy
629
629
- [x] LSP
630
630
- [x] LSP Support
631
631
- [x] LSP server selection (ignore, allow_only, use first, use all, etc.)
632
632
- [ ] CoC Support
633
633
634
634
See #879 for the tracking issue of these features.
635
635
636
- This source is currently experimental, so in order to use it, you need to first
636
+ This source is currently experimental, so in order to use it, you need to first
637
637
add ` "document_symbols" ` to ` config.sources ` and open it with the command
638
638
```
639
639
:Neotree document_symbols
@@ -656,19 +656,19 @@ To do so, set one of these options to `true`:
656
656
})
657
657
```
658
658
659
- There are many configuration options to change the style of these tabs.
659
+ There are many configuration options to change the style of these tabs.
660
660
See [ lua/neo-tree/defaults.lua] ( lua/neo-tree/defaults.lua ) for details.
661
661
662
662
663
663
## Configuration and Customization
664
664
665
665
This is designed to be flexible. The way that is achieved is by making
666
666
everything a function, or a string that identifies a built-in function. All of the
667
- built-in functions can be replaced with your own implementation, or you can
667
+ built-in functions can be replaced with your own implementation, or you can
668
668
add new ones.
669
669
670
670
Each node in the tree is created from the renderer specified for the given node
671
- type, and each renderer is a list of component configs to be rendered in order.
671
+ type, and each renderer is a list of component configs to be rendered in order.
672
672
Each component is a function, either built-in or specified in your config. Those
673
673
functions simply return the text and highlight group for the component.
674
674
0 commit comments