vim/nerdtree
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Smarter delimiter default (#963)

Browse Source 
* Better default node delimiter, based on presence of +conceal feature.

* Update documentation for node delimiter.

* Fix IF logic, and remove debug statements.

* Rewrite the NERDTreeNodeDelimiter help text to reflect new behavior.

* Change "NERD tree" to "NERDTree" and fix spacing in doc file.
This commit is contained in:
Phil Runninger 2019-03-07 08:24:17 -05:00 committed by GitHub
parent e1916d6fe7
commit 288669db1f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 134 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

240
doc/NERDTree.txt
View File

@ -26,12 +26,12 @@ CONTENTS *NERDTree-contents*
2.2.1.The bookmark table..........|NERDTreeBookmarkTable| 2.2.1.The bookmark table..........|NERDTreeBookmarkTable|
2.2.2.Bookmark commands...........|NERDTreeBookmarkCommands| 2.2.2.Bookmark commands...........|NERDTreeBookmarkCommands|
2.2.3.Invalid bookmarks...........|NERDTreeInvalidBookmarks| 2.2.3.Invalid bookmarks...........|NERDTreeInvalidBookmarks|
2.3.NERD tree mappings................|NERDTreeMappings| 2.3.NERDTree mappings.................|NERDTreeMappings|
2.4.The NERD tree menu................|NERDTreeMenu| 2.4.The NERDTree menu.................|NERDTreeMenu|
3.Settings................................|NERDTreeSettings| 3.Settings................................|NERDTreeSettings|
3.1.Settings summary..................|NERDTreeSettingsSummary| 3.1.Settings summary..................|NERDTreeSettingsSummary|
3.2.Settings details..................|NERDTreeSettingsDetails| 3.2.Settings details..................|NERDTreeSettingsDetails|
4.The NERD tree API.......................|NERDTreeAPI| 4.The NERDTree API........................|NERDTreeAPI|
4.1.Key map API.......................|NERDTreeKeymapAPI| 4.1.Key map API.......................|NERDTreeKeymapAPI|
4.2.Menu API..........................|NERDTreeMenuAPI| 4.2.Menu API..........................|NERDTreeMenuAPI|
4.3.Menu API..........................|NERDTreeAddPathFilter()| 4.3.Menu API..........................|NERDTreeAddPathFilter()|
@ -42,14 +42,14 @@ CONTENTS *NERDTree-contents*
============================================================================== ==============================================================================
1. Intro *NERDTree* 1. Intro *NERDTree*
What is this "NERD tree"?? What is this "NERDTree"??
The NERD tree allows you to explore your filesystem and to open files and The NERDTree allows you to explore your filesystem and to open files and
directories. It presents the filesystem to you in the form of a tree which you directories. It presents the filesystem to you in the form of a tree which you
manipulate with the keyboard and/or mouse. It also allows you to perform manipulate with the keyboard and/or mouse. It also allows you to perform
simple filesystem operations. simple filesystem operations.
The following features and functionality are provided by the NERD tree: The following features and functionality are provided by the NERDTree:
* Files and directories are displayed in a hierarchical tree structure * Files and directories are displayed in a hierarchical tree structure
* Different highlighting is provided for the following types of nodes: * Different highlighting is provided for the following types of nodes:
* files * files
@ -65,12 +65,12 @@ The following features and functionality are provided by the NERD tree:
* Mappings to navigate around the tree * Mappings to navigate around the tree
* ... * ...
* Directories and files can be bookmarked. * Directories and files can be bookmarked.
* Most NERD tree navigation can also be done with the mouse * Most NERDTree navigation can also be done with the mouse
* Filtering of tree content (can be toggled at runtime) * Filtering of tree content (can be toggled at runtime)
* custom file filters to prevent e.g. vim backup files being displayed * custom file filters to prevent e.g. vim backup files being displayed
* optional displaying of hidden files (. files) * optional displaying of hidden files (. files)
* files can be "turned off" so that only directories are displayed * files can be "turned off" so that only directories are displayed
* The position and size of the NERD tree window can be customised * The position and size of the NERDTree window can be customised
* The order in which the nodes in the tree are listed can be customised. * The order in which the nodes in the tree are listed can be customised.
* A model of your filesystem is created/maintained as you explore it. This * A model of your filesystem is created/maintained as you explore it. This
has several advantages: has several advantages:
@ -79,12 +79,12 @@ The following features and functionality are provided by the NERD tree:
session, the directory nodes will be opened/closed as you left them session, the directory nodes will be opened/closed as you left them
* The script remembers the cursor position and window position in the NERD * The script remembers the cursor position and window position in the NERD
tree so you can toggle it off (or just close the tree window) and then tree so you can toggle it off (or just close the tree window) and then
reopen it (with NERDTreeToggle) the NERD tree window will appear exactly reopen it (with NERDTreeToggle) the NERDTree window will appear exactly
as you left it as you left it
* You can have a separate NERD tree for each tab, share trees across tabs, * You can have a separate NERDTree for each tab, share trees across tabs,
or a mix of both. or a mix of both.
* By default the script overrides the default file browser (netrw), so if * By default the script overrides the default file browser (netrw), so if
you :edit a directory a (slightly modified) NERD tree will appear in the you :edit a directory a (slightly modified) NERDTree will appear in the
current window current window
* A programmable menu system is provided (simulates right clicking on a * A programmable menu system is provided (simulates right clicking on a
node) node)
@ -100,7 +100,7 @@ The following features and functionality are provided by the NERD tree:
2.1. Global Commands *NERDTreeGlobalCommands* 2.1. Global Commands *NERDTreeGlobalCommands*
:NERDTree [<start-directory> | <bookmark>] *:NERDTree* :NERDTree [<start-directory> | <bookmark>] *:NERDTree*
Opens a fresh NERD tree. The root of the tree depends on the argument Opens a fresh NERDTree. The root of the tree depends on the argument
given. There are 3 cases: If no argument is given, the current directory given. There are 3 cases: If no argument is given, the current directory
will be used. If a directory is given, that will be used. If a bookmark will be used. If a directory is given, that will be used. If a bookmark
name is given, the corresponding directory will be used. For example: > name is given, the corresponding directory will be used. For example: >
@ -109,36 +109,36 @@ The following features and functionality are provided by the NERD tree:
< <
:NERDTreeVCS [<start-directory> | <bookmark>] *:NERDTreeVCS* :NERDTreeVCS [<start-directory> | <bookmark>] *:NERDTreeVCS*
Like |:NERDTree|, but searches up the directory tree to find the top of Like |:NERDTree|, but searches up the directory tree to find the top of
the version control system repository, and roots the NERD tree there. It the version control system repository, and roots the NERDTree there. It
works with Git, Subversion, Mercurial, Bazaar, and Darcs repositories. A works with Git, Subversion, Mercurial, Bazaar, and Darcs repositories. A
couple of examples: > couple of examples: >
:NERDTreeVCS /home/marty/nerdtree/doc (opens /home/marty/nerdtree) :NERDTreeVCS /home/marty/nerdtree/doc (opens /home/marty/nerdtree)
:NERDTreeVCS (opens root of repository containing CWD) :NERDTreeVCS (opens root of repository containing CWD)
< <
:NERDTreeFromBookmark <bookmark> *:NERDTreeFromBookmark* :NERDTreeFromBookmark <bookmark> *:NERDTreeFromBookmark*
Opens a fresh NERD tree with the root initialized to the dir for Opens a fresh NERDTree with the root initialized to the dir for
<bookmark>. The only reason to use this command over :NERDTree is for <bookmark>. The only reason to use this command over :NERDTree is for
the completion (which is for bookmarks rather than directories). the completion (which is for bookmarks rather than directories).
:NERDTreeToggle [<start-directory> | <bookmark>] *:NERDTreeToggle* :NERDTreeToggle [<start-directory> | <bookmark>] *:NERDTreeToggle*
If a NERD tree already exists for this tab, it is reopened and rendered If a NERDTree already exists for this tab, it is reopened and rendered
again. If no NERD tree exists for this tab then this command acts the again. If no NERDTree exists for this tab then this command acts the
same as the |:NERDTree| command. same as the |:NERDTree| command.
:NERDTreeFocus *:NERDTreeFocus* :NERDTreeFocus *:NERDTreeFocus*
Opens (or reopens) the NERD Tree if it is not currently visible; Opens (or reopens) the NERDTree if it is not currently visible;
otherwise, the cursor is moved to the already-open NERD Tree. otherwise, the cursor is moved to the already-open NERDTree.
:NERDTreeMirror *:NERDTreeMirror* :NERDTreeMirror *:NERDTreeMirror*
Shares an existing NERD tree, from another tab, in the current tab. Shares an existing NERDTree, from another tab, in the current tab.
Changes made to one tree are reflected in both as they are actually the Changes made to one tree are reflected in both as they are actually the
same buffer. same buffer.
If only one other NERD tree exists, that tree is automatically mirrored. If only one other NERDTree exists, that tree is automatically mirrored.
If more than one exists, the script will ask which tree to mirror. If more than one exists, the script will ask which tree to mirror.
:NERDTreeClose *:NERDTreeClose* :NERDTreeClose *:NERDTreeClose*
Close the NERD tree in this tab. Close the NERDTree in this tab.
:NERDTreeFind [<path>] *:NERDTreeFind* :NERDTreeFind [<path>] *:NERDTreeFind*
Without the optional argument, find and reveal the file for the active Without the optional argument, find and reveal the file for the active
@ -154,12 +154,12 @@ The following features and functionality are provided by the NERD tree:
NERDTree exists for this tab, a new one is opened. NERDTree exists for this tab, a new one is opened.
:NERDTreeRefreshRoot *:NERDTreeRefreshRoot* :NERDTreeRefreshRoot *:NERDTreeRefreshRoot*
Refreshes the NERD tree root node. Refreshes the NERDTree root node.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
2.2. Bookmarks *NERDTreeBookmarks* 2.2. Bookmarks *NERDTreeBookmarks*
Bookmarks in the NERD tree are a way to tag files or directories of interest. Bookmarks in the NERDTree are a way to tag files or directories of interest.
For example, you could use bookmarks to tag all of your project directories. For example, you could use bookmarks to tag all of your project directories.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
@ -230,10 +230,10 @@ Each line in the bookmarks file represents one bookmark. The proper format is:
You can use the :EditBookmarks command to open the bookmarks file for editing. You can use the :EditBookmarks command to open the bookmarks file for editing.
After you have corrected any invalid bookmarks, either restart vim, or run After you have corrected any invalid bookmarks, either restart vim, or run
:ReadBookmarks from the NERD tree window. :ReadBookmarks from the NERDTree window.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
2.3. NERD tree Mappings *NERDTreeMappings* 2.3. NERDTree Mappings *NERDTreeMappings*
Default~ Default~
Key Description help-tag~ Key Description help-tag~
@ -270,7 +270,7 @@ u........Move the tree root up one directory........................|NERDTree-u|
U........Same as 'u' except the old root node is left open..........|NERDTree-U| U........Same as 'u' except the old root node is left open..........|NERDTree-U|
r........Recursively refresh the current directory..................|NERDTree-r| r........Recursively refresh the current directory..................|NERDTree-r|
R........Recursively refresh the current root.......................|NERDTree-R| R........Recursively refresh the current root.......................|NERDTree-R|
m........Display the NERD tree menu.................................|NERDTree-m| m........Display the NERDTree menu..................................|NERDTree-m|
cd.......Change the CWD to the dir of the selected node............|NERDTree-cd| cd.......Change the CWD to the dir of the selected node............|NERDTree-cd|
CD.......Change tree root to the CWD...............................|NERDTree-CD| CD.......Change tree root to the CWD...............................|NERDTree-CD|
@ -323,9 +323,9 @@ Map setting: NERDTreeMapOpenInTab
Applies to: files and directories. Applies to: files and directories.
Opens the selected file in a new tab. If a directory is selected, a fresh Opens the selected file in a new tab. If a directory is selected, a fresh
NERD Tree for that directory is opened in a new tab. NERDTree for that directory is opened in a new tab.
If a bookmark which points to a directory is selected, open a NERD tree for If a bookmark which points to a directory is selected, open a NERDTree for
that directory in a new tab. If the bookmark points to a file, open that file that directory in a new tab. If the bookmark points to a file, open that file
in a new tab. in a new tab.
@ -415,7 +415,7 @@ Map setting: NERDTreeMapOpenExpl
Applies to: files and directories. Applies to: files and directories.
|:edit|s the selected directory, or the selected file's directory. This could |:edit|s the selected directory, or the selected file's directory. This could
result in a NERD tree or a netrw being opened, depending on result in a NERDTree or a netrw being opened, depending on
|NERDTreeHijackNetrw|. |NERDTreeHijackNetrw|.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
@ -534,7 +534,7 @@ Default key: m
Map setting: NERDTreeMapMenu Map setting: NERDTreeMapMenu
Applies to: files and directories. Applies to: files and directories.
Display the NERD tree menu. See |NERDTreeMenu| for details. Display the NERDTree menu. See |NERDTreeMenu| for details.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTree-cd* *NERDTree-cd*
@ -609,9 +609,9 @@ Applies to: no restrictions.
Toggles whether the quickhelp is displayed. Toggles whether the quickhelp is displayed.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
2.3. The NERD tree menu *NERDTreeMenu* 2.3. The NERDTree menu *NERDTreeMenu*
The NERD tree has a menu that can be programmed via the an API (see The NERDTree has a menu that can be programmed via the an API (see
|NERDTreeMenuAPI|). The idea is to simulate the "right click" menus that most |NERDTreeMenuAPI|). The idea is to simulate the "right click" menus that most
file explorers have. file explorers have.
@ -623,18 +623,18 @@ menu item to execute executable files.
Related tags: |NERDTree-m| |NERDTreeApi| Related tags: |NERDTree-m| |NERDTreeApi|
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeMenu-j* *NERDTreeMenu-j*
Default key: j Default key: j
Map option: NERDTreeMenuDown Map option: NERDTreeMenuDown
Applies to: The NERD tree menu. Applies to: The NERDTree menu.
Moves the cursor down. Moves the cursor down.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeMenu-k* *NERDTreeMenu-k*
Default key: k Default key: k
Map option: NERDTreeMenuUp Map option: NERDTreeMenuUp
Applies to: The NERD tree menu. Applies to: The NERDTree menu.
Moves the cursor up. Moves the cursor up.
@ -646,38 +646,38 @@ Moves the cursor up.
3.1. Customisation summary *NERDTreeSettingsSummary* 3.1. Customisation summary *NERDTreeSettingsSummary*
The plugin provides the following settings that can customise the behaviour The plugin provides the following settings that can customise the behaviour
the NERD tree. These settings should be set in your vimrc, using `:let`. the NERDTree. These settings should be set in your vimrc, using `:let`.
|loaded_nerd_tree| Turns off the script. |loaded_nerd_tree| Turns off the script.
|NERDTreeAutoCenter| Controls whether the NERD tree window centers |NERDTreeAutoCenter| Controls whether the NERDTree window centers
when the cursor moves within a specified when the cursor moves within a specified
distance to the top/bottom of the window. distance to the top/bottom of the window.
|NERDTreeAutoCenterThreshold| Controls the sensitivity of autocentering. |NERDTreeAutoCenterThreshold| Controls the sensitivity of autocentering.
|NERDTreeCaseSensitiveSort| Tells the NERD tree whether to be case |NERDTreeCaseSensitiveSort| Tells the NERDTree whether to be case
sensitive or not when sorting nodes. sensitive or not when sorting nodes.
|NERDTreeNaturalSort| Tells the NERD tree whether to use natural sort |NERDTreeNaturalSort| Tells the NERDTree whether to use natural sort
order or not when sorting nodes. order or not when sorting nodes.
|NERDTreeSortHiddenFirst| Tells the NERD tree whether to take the dot at |NERDTreeSortHiddenFirst| Tells the NERDTree whether to take the dot at
the beginning of the hidden file names into the beginning of the hidden file names into
account when sorting nodes. account when sorting nodes.
|NERDTreeChDirMode| Tells the NERD tree if/when it should change |NERDTreeChDirMode| Tells the NERDTree if/when it should change
vim's current working directory. vim's current working directory.
|NERDTreeHighlightCursorline| Tell the NERD tree whether to highlight the |NERDTreeHighlightCursorline| Tell the NERDTree whether to highlight the
current cursor line. current cursor line.
|NERDTreeHijackNetrw| Tell the NERD tree whether to replace the netrw |NERDTreeHijackNetrw| Tell the NERDTree whether to replace the netrw
autocommands for exploring local directories. autocommands for exploring local directories.
|NERDTreeIgnore| Tells the NERD tree which files to ignore. |NERDTreeIgnore| Tells the NERDTree which files to ignore.
|NERDTreeRespectWildIgnore| Tells the NERD tree to respect `'wildignore'`. |NERDTreeRespectWildIgnore| Tells the NERDTree to respect `'wildignore'`.
|NERDTreeBookmarksFile| Where the bookmarks are stored. |NERDTreeBookmarksFile| Where the bookmarks are stored.
@ -690,30 +690,30 @@ the NERD tree. These settings should be set in your vimrc, using `:let`.
|NERDTreeQuitOnOpen| Closes the tree window or bookmark table after |NERDTreeQuitOnOpen| Closes the tree window or bookmark table after
opening a file. opening a file.
|NERDTreeShowBookmarks| Tells the NERD tree whether to display the |NERDTreeShowBookmarks| Tells the NERDTree whether to display the
bookmarks table on startup. bookmarks table on startup.
|NERDTreeShowFiles| Tells the NERD tree whether to display files in |NERDTreeShowFiles| Tells the NERDTree whether to display files in
the tree on startup. the tree on startup.
|NERDTreeShowHidden| Tells the NERD tree whether to display hidden |NERDTreeShowHidden| Tells the NERDTree whether to display hidden
files on startup. files on startup.
|NERDTreeShowLineNumbers| Tells the NERD tree whether to display line |NERDTreeShowLineNumbers| Tells the NERDTree whether to display line
numbers in the tree window. numbers in the tree window.
|NERDTreeSortOrder| Tell the NERD tree how to sort the nodes in the |NERDTreeSortOrder| Tell the NERDTree how to sort the nodes in the
tree. tree.
|NERDTreeStatusline| Set a statusline for NERD tree windows. |NERDTreeStatusline| Set a statusline for NERDTree windows.
|NERDTreeWinPos| Tells the script where to put the NERD tree |NERDTreeWinPos| Tells the script where to put the NERDTree
window. window.
|NERDTreeWinSize| Sets the window size when the NERD tree is |NERDTreeWinSize| Sets the window size when the NERDTree is
opened. opened.
|NERDTreeWinSizeMax| Sets the maximum window size when the NERD tree |NERDTreeWinSizeMax| Sets the maximum window size when the NERDTree
is zoomed. is zoomed.
|NERDTreeMinimalUI| Disables display of the 'Bookmarks' label and |NERDTreeMinimalUI| Disables display of the 'Bookmarks' label and
@ -730,7 +730,7 @@ the NERD tree. These settings should be set in your vimrc, using `:let`.
Cascade open while selected directory has only Cascade open while selected directory has only
one child that also is a directory. one child that also is a directory.
|NERDTreeAutoDeleteBuffer| Tells the NERD tree to automatically remove a |NERDTreeAutoDeleteBuffer| Tells the NERDTree to automatically remove a
buffer when a file is being deleted or renamed buffer when a file is being deleted or renamed
via a context menu command. via a context menu command.
@ -747,6 +747,9 @@ the NERD tree. These settings should be set in your vimrc, using `:let`.
include one space character at the end of the include one space character at the end of the
command and it applies only to directories. command and it applies only to directories.
|NERDTreeDirArrowCollapsible| These characters indicate when a directory is
|NERDTreeDirArrowExpandable| either collapsible or expandable.
|NERDTreeNodeDelimiter| A single character that is used to separate the |NERDTreeNodeDelimiter| A single character that is used to separate the
file or directory name from the rest of the file or directory name from the rest of the
characters on the line of text. characters on the line of text.
@ -763,13 +766,12 @@ If this plugin is making you feel homicidal, it may be a good idea to turn it
off with this line in your vimrc: > off with this line in your vimrc: >
let loaded_nerd_tree=1 let loaded_nerd_tree=1
< <
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeAutoCenter* *NERDTreeAutoCenter*
Values: 0 or 1. Values: 0 or 1.
Default: 1 Default: 1
If set to 1, the NERD tree window will center around the cursor if it moves to If set to 1, the NERDTree window will center around the cursor if it moves to
within |NERDTreeAutoCenterThreshold| lines of the top/bottom of the window. within |NERDTreeAutoCenterThreshold| lines of the top/bottom of the window.
This is ONLY done in response to tree navigation mappings, This is ONLY done in response to tree navigation mappings,
@ -783,7 +785,7 @@ The centering is done with a |zz| operation.
Values: Any natural number. Values: Any natural number.
Default: 3 Default: 3
This setting controls the "sensitivity" of the NERD tree auto centering. See This setting controls the "sensitivity" of the NERDTree auto centering. See
|NERDTreeAutoCenter| for details. |NERDTreeAutoCenter| for details.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
@ -791,7 +793,7 @@ This setting controls the "sensitivity" of the NERD tree auto centering. See
Values: 0 or 1. Values: 0 or 1.
Default: 0. Default: 0.
By default the NERD tree does not sort nodes case sensitively, i.e. nodes By default the NERDTree does not sort nodes case sensitively, i.e. nodes
could appear like this: > could appear like this: >
bar.c bar.c
Baz.c Baz.c
@ -812,7 +814,7 @@ into account. The above nodes would then be sorted like this: >
Values: 0 or 1. Values: 0 or 1.
Default: 0. Default: 0.
By default the NERD tree does not sort nodes in natural sort order, i.e. nodes By default the NERDTree does not sort nodes in natural sort order, i.e. nodes
could appear like this: > could appear like this: >
z1.txt z1.txt
z10.txt z10.txt
@ -843,14 +845,14 @@ Default: 0.
Use this setting to tell the script when (if at all) to change the current Use this setting to tell the script when (if at all) to change the current
working directory (CWD) for vim. working directory (CWD) for vim.
If it is set to 0 then the CWD is never changed by the NERD tree. If it is set to 0 then the CWD is never changed by the NERDTree.
If set to 1 then the CWD is changed when the NERD tree is first loaded to the If set to 1 then the CWD is changed when the NERDTree is first loaded to the
directory it is initialized in. For example, if you start the NERD tree with > directory it is initialized in. For example, if you start the NERDTree with >
:NERDTree /home/marty/foobar :NERDTree /home/marty/foobar
< <
then the CWD will be changed to /home/marty/foobar and will not be changed then the CWD will be changed to /home/marty/foobar and will not be changed
again unless you init another NERD tree with a similar command. again unless you init another NERDTree with a similar command.
If the setting is set to 2 then it behaves the same as if set to 1 except that If the setting is set to 2 then it behaves the same as if set to 1 except that
the CWD is changed whenever the tree root is changed. For example, if the CWD the CWD is changed whenever the tree root is changed. For example, if the CWD
@ -862,7 +864,7 @@ root then the CWD will become /home/marty/foobar/baz.
Values: 0 or 1. Values: 0 or 1.
Default: 1. Default: 1.
If set to 1, the current cursor line in the NERD tree buffer will be If set to 1, the current cursor line in the NERDTree buffer will be
highlighted. This is done using the `'cursorline'` Vim option. highlighted. This is done using the `'cursorline'` Vim option.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
@ -873,7 +875,7 @@ Default: 1.
If set to 1, doing a > If set to 1, doing a >
:edit <some directory> :edit <some directory>
< <
will open up a window level NERD tree instead of a netrw in the target window. will open up a window level NERDTree instead of a netrw in the target window.
Window level trees behaves slightly different from a regular trees in the Window level trees behaves slightly different from a regular trees in the
following respects: following respects:
@ -886,8 +888,8 @@ following respects:
Values: a list of regular expressions. Values: a list of regular expressions.
Default: ['\~$']. Default: ['\~$'].
This setting is used to specify which files the NERD tree should ignore. It This setting is used to specify which files the NERDTree should ignore. It
must be a list of regular expressions. When the NERD tree is rendered, any must be a list of regular expressions. When the NERDTree is rendered, any
files/dirs that match any of the regex's in NERDTreeIgnore won't be files/dirs that match any of the regex's in NERDTreeIgnore won't be
displayed. displayed.
@ -904,11 +906,10 @@ These flags are "[[dir]]" and "[[file]]". Example: >
This will cause all dirs ending in ".d" to be ignored and all files ending in This will cause all dirs ending in ".d" to be ignored and all files ending in
".o" to be ignored. ".o" to be ignored.
Note: to tell the NERD tree not to ignore any files you must use the following Note: to tell the NERDTree not to ignore any files you must use the following
line: > line: >
let NERDTreeIgnore=[] let NERDTreeIgnore=[]
< <
The file filters can be turned on and off dynamically with the |NERDTree-f| The file filters can be turned on and off dynamically with the |NERDTree-f|
mapping. mapping.
@ -997,7 +998,7 @@ mapping.
Values: 0 or 1. Values: 0 or 1.
Default: 1. Default: 1.
If this setting is set to 1 then files are displayed in the NERD tree. If it If this setting is set to 1 then files are displayed in the NERDTree. If it
is set to 0 then only directories are displayed. is set to 0 then only directories are displayed.
This setting can be toggled dynamically, per tree, with the |NERDTree-F| This setting can be toggled dynamically, per tree, with the |NERDTree-F|
@ -1015,18 +1016,16 @@ Use one of the follow lines for this setting: >
let NERDTreeShowHidden=0 let NERDTreeShowHidden=0
let NERDTreeShowHidden=1 let NERDTreeShowHidden=1
< <
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeShowLineNumbers* *NERDTreeShowLineNumbers*
Values: 0 or 1. Values: 0 or 1.
Default: 0. Default: 0.
This setting tells vim whether to display line numbers for the NERD tree This setting tells vim whether to display line numbers for the NERDTree
window. Use one of the follow lines for this setting: > window. Use one of the follow lines for this setting: >
let NERDTreeShowLineNumbers=0 let NERDTreeShowLineNumbers=0
let NERDTreeShowLineNumbers=1 let NERDTreeShowLineNumbers=1
< <
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeSortOrder* *NERDTreeSortOrder*
Values: a list of regular expressions. Values: a list of regular expressions.
@ -1094,19 +1093,19 @@ setting is used.
Values: "left" or "right" Values: "left" or "right"
Default: "left". Default: "left".
This setting is used to determine where NERD tree window is placed on the This setting is used to determine where NERDTree window is placed on the
screen. screen.
This setting makes it possible to use two different explorer plugins This setting makes it possible to use two different explorer plugins
simultaneously. For example, you could have the taglist plugin on the left of simultaneously. For example, you could have the taglist plugin on the left of
the window and the NERD tree on the right. the window and the NERDTree on the right.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeWinSize* *NERDTreeWinSize*
Values: a positive integer. Values: a positive integer.
Default: 31. Default: 31.
This setting is used to change the size of the NERD tree when it is loaded. This setting is used to change the size of the NERDTree when it is loaded.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeMinimalUI* *NERDTreeMinimalUI*
@ -1118,13 +1117,12 @@ of the following lines for this setting: >
let NERDTreeMinimalUI=0 let NERDTreeMinimalUI=0
let NERDTreeMinimalUI=1 let NERDTreeMinimalUI=1
< <
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeMinimalMenu* *NERDTreeMinimalMenu*
Values: 0 or 1 Values: 0 or 1
Default: 0 Default: 0
This setting makes NERD tree use a smaller, more compact menu for adding, This setting makes NERDTree use a smaller, more compact menu for adding,
copying, deleting nodes. This menu fits on a single line so Vim doesn't need to copying, deleting nodes. This menu fits on a single line so Vim doesn't need to
scroll down to present it. This setting is recommended for users already scroll down to present it. This setting is recommended for users already
familiar with the menu items. It will look similar to this: familiar with the menu items. It will look similar to this:
@ -1137,8 +1135,7 @@ NERDTreeMenuDown keys, then pressing enter.
Use one of the following lines for this setting: > Use one of the following lines for this setting: >
let NERDTreeMinimalMenu=0 let NERDTreeMinimalMenu=0
let NERDTreeMinimalMenu=1 let NERDTreeMinimalMenu=1
<
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeCascadeSingleChildDir* *NERDTreeCascadeSingleChildDir*
Values: 0 or 1 Values: 0 or 1
@ -1149,7 +1146,6 @@ have only one child. Use one of the following lines for this setting: >
let NERDTreeCascadeSingleChildDir=0 let NERDTreeCascadeSingleChildDir=0
let NERDTreeCascadeSingleChildDir=1 let NERDTreeCascadeSingleChildDir=1
< <
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeCascadeOpenSingleChildDir* *NERDTreeCascadeOpenSingleChildDir*
Values: 0 or 1 Values: 0 or 1
@ -1163,7 +1159,6 @@ useful for Java projects. Use one of the following lines for this setting: >
let NERDTreeCascadeOpenSingleChildDir=0 let NERDTreeCascadeOpenSingleChildDir=0
let NERDTreeCascadeOpenSingleChildDir=1 let NERDTreeCascadeOpenSingleChildDir=1
< <
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeAutoDeleteBuffer* *NERDTreeAutoDeleteBuffer*
Values: 0 or 1 Values: 0 or 1
@ -1188,41 +1183,60 @@ string such as "keepalt" or similar. For example, to have NERDTree create its
tree window using `silent keepalt keepjumps edit`: > tree window using `silent keepalt keepjumps edit`: >
let NERDTreeCreatePrefix='silent keepalt keepjumps' let NERDTreeCreatePrefix='silent keepalt keepjumps'
< <
------------------------------------------------------------------------------
*NERDTreeDirArrowCollapsible* *NERDTreeDirArrowExpandable*
Values: Any single character.
Defaults: Windows: ~ and + Others: ▾ and ▸
These characters indicate whether a directory is collapsible or expandable.
They can be set to "\u00a0" to hide the arrows, but if you do this you may
need to change the node delimiter. See |NERDTreeNodeDelimiter|. You cannot use
the same character for both the arrows and the delimiter. Example: >
let NERDTreeDirArrowExpandable=">"
let NERDTreeDirArrowCollapsible="v"
<
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*NERDTreeNodeDelimiter* *NERDTreeNodeDelimiter*
Values: Any single character. Values: Any single character.
Default: "\x07" - the non-printable character BELL. Default: varies (see below)
This character is used to separate the file or directory name from the rest of This character is used to separate the file or directory name from the rest of
the characters in the line of text. It allows filenames to contain special the characters in the line of text. It allows filenames to contain special
characters that are otherwise used in the NERDTree, such as square brackets, characters that are otherwise used in the NERDTree, such as square brackets,
braces, trailing asterisk, and leading space. For more details, see the braces, trailing asterisk, and leading space. For more details, see the
resoponsible pull request: https://github.com/scrooloose/nerdtree/pull/868. responsible pull request: https://github.com/scrooloose/nerdtree/pull/868.
The default should work in nearly every situation, but this setting exists for The default value of this variable depends on the features compiled into your
those very rare cases where it doesn't. "\x07" was chosen because it's vim and the values of |NERDTreeDirArrowCollapsible| and
non-printable, and very unlikely to be used purposefully in a filename or as a |NERDTreeDirArrowExpandable|.
flag by other NERDTree plugins. If you need to change the delimiter, be sure * If your vim is compiled with the +conceal feature, it is the "\x07" (BELL)
to choose a character that won't appear in your filenames or any of the flags character, and it is hidden by setting 'conceallevel' to 3. If you use
set by your installed NERDTree plugins. The suggestions below are but a few of autocommands, make sure none of them change that setting in the NERDTree_*
the many possibilities. Remember to use double quotes when specifying by hex buffers.
or Unicode. > * If your vim does NOT have the +conceal feature and you're using "\u00a0"
let NERDTreeNodeDelimiter="\u00a0" "non-breaking space (non-breaking space) to hide the directory arrows, "\u00b7" (middle dot)
is used as the default delimiter.
* If neither condition above applies, NERDTree uses "\u00a0" (non-breaking
space) as the default delimiter.
In the 2nd and 3rd cases, NERDTree will use the Ignore highlight group to
"hide" the delimiter. It should appear as an empty space.
Other plugins can interfere with these defaults, so if you need to change the
delimiter, be sure to choose a character that won't appear in your filenames
or any of the flags set by your installed NERDTree plugins. The suggestions
below are but a few of the many possibilities. Remember to use double quotes
when specifying by hex or Unicode. >
let NERDTreeNodeDelimiter="\x07" "bell
let NERDTreeNodeDelimiter="\u00b7" "middle dot let NERDTreeNodeDelimiter="\u00b7" "middle dot
let NERDTreeNodeDelimiter="\u00a0" "non-breaking space
let NERDTreeNodeDelimiter="😀" "smiley face
< <
The delimiter character is hidden by setting 'conceallevel' to 3. If you use
autocommands, make sure none of them change that setting in the NERDTree_*
windows.
If your vim was not compiled with the +conceal feature, NERDTree will use the
Ignore highlight group, which doesn't hide the BELL character. In this
situation, you will need to override the delimiter character as described
above.
============================================================================== ==============================================================================
4. The NERD tree API *NERDTreeAPI* 4. The NERDTree API *NERDTreeAPI*
The NERD tree script allows you to add custom key mappings and menu items via The NERDTree script allows you to add custom key mappings and menu items via
a set of API calls. Any scripts that use this API should be placed in a set of API calls. Any scripts that use this API should be placed in
~/.vim/nerdtree_plugin/ (*nix) or ~/vimfiles/nerdtree_plugin (windows). ~/.vim/nerdtree_plugin/ (*nix) or ~/vimfiles/nerdtree_plugin (windows).
@ -1246,7 +1260,7 @@ See this blog post for more details:
4.1. Key map API *NERDTreeKeymapAPI* 4.1. Key map API *NERDTreeKeymapAPI*
NERDTreeAddKeyMap({options}) *NERDTreeAddKeyMap()* NERDTreeAddKeyMap({options}) *NERDTreeAddKeyMap()*
Adds a new keymapping for all NERD tree buffers. Adds a new keymapping for all NERDTree buffers.
{options} must be a dictionary, and must contain the following keys: {options} must be a dictionary, and must contain the following keys:
"key" - the trigger key for the new mapping "key" - the trigger key for the new mapping
"callback" - the function the new mapping will be bound to "callback" - the function the new mapping will be bound to
@ -1283,7 +1297,7 @@ NERDTreeAddKeyMap({options}) *NERDTreeAddKeyMap()*
on a directory node. on a directory node.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
4.2. Menu API *NERDTreeMenuAPI* 4.2. Menu API *NERDTreeMenuAPI*
NERDTreeAddSubmenu({options}) *NERDTreeAddSubmenu()* NERDTreeAddSubmenu({options}) *NERDTreeAddSubmenu()*
Creates and returns a new submenu. Creates and returns a new submenu.
@ -1303,7 +1317,7 @@ NERDTreeAddSubmenu({options}) *NERDTreeAddSubmenu()*
See below for an example. See below for an example.
NERDTreeAddMenuItem({options}) *NERDTreeAddMenuItem()* NERDTreeAddMenuItem({options}) *NERDTreeAddMenuItem()*
Adds a new menu item to the NERD tree menu (see |NERDTreeMenu|). Adds a new menu item to the NERDTree menu (see |NERDTreeMenu|).
{options} must be a dictionary and must contain the {options} must be a dictionary and must contain the
following keys: following keys:
@ -1404,13 +1418,13 @@ Current events supported:
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
NERDTreeRender() *NERDTreeRender()* NERDTreeRender() *NERDTreeRender()*
Re-renders the NERD tree buffer. Useful if you change the state of the Re-renders the NERDTree buffer. Useful if you change the state of the
tree and you want to it to be reflected in the UI. tree and you want to it to be reflected in the UI.
============================================================================== ==============================================================================
5. About *NERDTreeAbout* 5. About *NERDTreeAbout*
The author of the NERD tree is a terrible terrible monster called Martyzilla The author of the NERDTree is a terrible terrible monster called Martyzilla
who gobbles up small children with milk and sugar for breakfast. who gobbles up small children with milk and sugar for breakfast.
He can be reached at martin.grenfell at gmail dot com. He would love to hear He can be reached at martin.grenfell at gmail dot com. He would love to hear
@ -1437,7 +1451,7 @@ Title Credit:
============================================================================== ==============================================================================
6. License *NERDTreeLicense* 6. License *NERDTreeLicense*
The NERD tree is released under the wtfpl. The NERDTree is released under the wtfpl.
See http://sam.zoy.org/wtfpl/COPYING. See http://sam.zoy.org/wtfpl/COPYING.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------

9
plugin/NERD_tree.vim
View File

@ -87,8 +87,13 @@ let g:NERDTreeOldSortOrder = []
call s:initVariable("g:NERDTreeGlyphReadOnly", "RO") call s:initVariable("g:NERDTreeGlyphReadOnly", "RO")
" ASCII 7: bell non-printing character used to delimit items in the tree's nodes. if has("conceal")
call s:initVariable("g:NERDTreeNodeDelimiter", "\x07") call s:initVariable("g:NERDTreeNodeDelimiter", "\x07")
elseif (g:NERDTreeDirArrowExpandable == "\u00a0" || g:NERDTreeDirArrowCollapsible == "\u00a0")
call s:initVariable("g:NERDTreeNodeDelimiter", "\u00b7")
else
call s:initVariable("g:NERDTreeNodeDelimiter", "\u00a0")
endif
if !exists('g:NERDTreeStatusline') if !exists('g:NERDTreeStatusline')