mirror of
https://github.com/preservim/nerdtree.git
synced 2025-11-08 11:23:48 -05:00
Compare commits
72 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3cb3227d56 | ||
|
|
f183d60b13 | ||
|
|
8c8cd29142 | ||
|
|
83e8c144ed | ||
|
|
06c7c53127 | ||
|
|
ec682b1f9b | ||
|
|
7a15d9879f | ||
|
|
dea37444bc | ||
|
|
f5a20e5379 | ||
|
|
a0573c51b1 | ||
|
|
d0cb14c7ce | ||
|
|
f2b2327c24 | ||
|
|
9d5a940be3 | ||
|
|
38d91b66b0 | ||
|
|
65ebd30334 | ||
|
|
1998cef2b4 | ||
|
|
030cff2eda | ||
|
|
02facac20a | ||
|
|
7789ccb90a | ||
|
|
d497c9ae9c | ||
|
|
cdf1e8d6e9 | ||
|
|
5f4a002787 | ||
|
|
c34968d282 | ||
|
|
f76f983182 | ||
|
|
312ce93bb4 | ||
|
|
06776557cf | ||
|
|
d831cbf17b | ||
|
|
aad2259522 | ||
|
|
e1bd98fc7c | ||
|
|
7ca9b07b68 | ||
|
|
1532bf1922 | ||
|
|
ac544460e4 | ||
|
|
d2989eb3e0 | ||
|
|
73be034d5e | ||
|
|
b5d6736f76 | ||
|
|
1c38ffd30b | ||
|
|
8e4b3565f8 | ||
|
|
31445645f7 | ||
|
|
fc053917d8 | ||
|
|
201df0a782 | ||
|
|
b59a7cd979 | ||
|
|
8f7aed712b | ||
|
|
3e946b1b4f | ||
|
|
2a16431b2d | ||
|
|
6815622d2c | ||
|
|
5c32c2a226 | ||
|
|
b363396a93 | ||
|
|
87382097df | ||
|
|
e6d2f12bf6 | ||
|
|
43ee096cee | ||
|
|
2b1eecebb2 | ||
|
|
c0d83f95a8 | ||
|
|
01ded5d150 | ||
|
|
5884cf3774 | ||
|
|
d15818bafa | ||
|
|
f74ec0661d | ||
|
|
d68dcd252e | ||
|
|
30bfb6e6b7 | ||
|
|
bfa5de8c55 | ||
|
|
6a665a588f | ||
|
|
55ff76171a | ||
|
|
a701bb71c4 | ||
|
|
6343639193 | ||
|
|
5ce5c62611 | ||
|
|
3ebff6ae54 | ||
|
|
d9a03f4600 | ||
|
|
59b132f0f7 | ||
|
|
d56bf992d2 | ||
|
|
efa7941c54 | ||
|
|
808850a464 | ||
|
|
24ad44b46f | ||
|
|
737ad58740 |
@@ -22,7 +22,9 @@ CONTENTS *NERDTree-contents*
|
||||
1.Intro...................................|NERDTree|
|
||||
2.Functionality provided..................|NERDTreeFunctionality|
|
||||
2.1 Global commands...................|NERDTreeGlobalCommands|
|
||||
2.2 Bookmark commands.................|NERDTreeBookmarkCommands|
|
||||
2.2 Bookmarks.........................|NERDTreeBookmarks|
|
||||
2.2.1 The bookmark table..........|NERDTreeBookmarkTable|
|
||||
2.2.2 Bookmark commands...........|NERDTreeBookmarkCommands|
|
||||
2.3 NERD tree mappings................|NERDTreeMappings|
|
||||
2.4 The filesystem menu...............|NERDTreeFilesysMenu|
|
||||
3.Options.................................|NERDTreeOptions|
|
||||
@@ -43,7 +45,7 @@ What is this "NERD tree"??
|
||||
The NERD tree 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
|
||||
manipulate with the keyboard and/or mouse. It also allows you to perform
|
||||
simple filesystem operations so you can alter the tree dynamically.
|
||||
simple filesystem operations.
|
||||
|
||||
The following features and functionality are provided by the NERD tree:
|
||||
* Files and directories are displayed in a hierarchical tree structure
|
||||
@@ -53,6 +55,7 @@ The following features and functionality are provided by the NERD tree:
|
||||
* sym-links
|
||||
* windows .lnk files
|
||||
* read-only files
|
||||
* executable files
|
||||
* Many (customisable) mappings are provided to manipulate the tree:
|
||||
* Mappings to open/close/explore directory nodes
|
||||
* Mappings to open files in new/existing windows/tabs
|
||||
@@ -66,7 +69,7 @@ The following features and functionality are provided by the NERD tree:
|
||||
* optional displaying of hidden files (. files)
|
||||
* files can be "turned off" so that only directories are displayed
|
||||
* A textual filesystem menu is provided which allows you to
|
||||
create/delete/rename file and directory nodes as well as copy (for
|
||||
create/delete/move file and directory nodes as well as copy (for
|
||||
supported OSs)
|
||||
* The position and size of the NERD tree window can be customised
|
||||
* The order in which the nodes in the tree are listed can be customised.
|
||||
@@ -109,18 +112,27 @@ The following features and functionality are provided by the NERD tree:
|
||||
Close the NERD tree in this tab.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
2.2. Bookmark Commands *NERDTreeBookmarkCommands*
|
||||
2.2. Bookmarks *NERDTreeBookmarks*
|
||||
|
||||
Bookmarks in the NERD tree are a way to tag files or directories of interest.
|
||||
For example, you could use bookmarks to tag all of your project directories.
|
||||
See also |:NERDTree| and |:NERDTreeFromBookmark|.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
2.2.1. The Bookmark Table *NERDTreeBookmarkTable*
|
||||
|
||||
If the bookmark table is active (see |NERDTree-B| and
|
||||
|NERDTreeShowBookmarks|), it will be rendered above the tree. You can double
|
||||
click bookmarks or use the |NERDTree-o| mapping to activate them. See also,
|
||||
|NERDTree-t| and |NERDTree-T|
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
2.2.2. Bookmark commands *NERDTreeBookmarkCommands*
|
||||
|
||||
Note that the following commands are only available in the NERD tree buffer.
|
||||
|
||||
:Bookmark <name>
|
||||
Bookmark the current node as <name>. If there is already a <name>
|
||||
bookmark, it is overwritten. <name> must consist of alphanumeric
|
||||
characters and underscores.
|
||||
bookmark, it is overwritten. <name> must not contain spaces.
|
||||
|
||||
:BookmarkToRoot <bookmark>
|
||||
Make the directory corresponding to <bookmark> the new root. If a treenode
|
||||
@@ -146,15 +158,17 @@ Note that the following commands are only available in the NERD tree buffer.
|
||||
:ClearAllBookmarks
|
||||
Remove all bookmarks.
|
||||
|
||||
See also |:NERDTree| and |:NERDTreeFromBookmark|.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
2.3. NERD tree Mappings *NERDTreeMappings*
|
||||
|
||||
Default Description~ help-tag~
|
||||
Key~
|
||||
|
||||
o.......Open selected file, or expand selected dir...............|NERDTree-o|
|
||||
o.......Open files, directories and bookmarks....................|NERDTree-o|
|
||||
go......Open selected file, but leave cursor in the NERDTree.....|NERDTree-go|
|
||||
t.......Open selected node in a new tab..........................|NERDTree-t|
|
||||
t.......Open selected node/bookmark in a new tab.................|NERDTree-t|
|
||||
T.......Same as 't' but keep the focus on the current tab........|NERDTree-T|
|
||||
<tab>...Open selected file in a split window.....................|NERDTree-tab|
|
||||
g<tab>..Same as <tab>, but leave the cursor on the NERDTree......|NERDTree-gtab|
|
||||
@@ -186,6 +200,7 @@ cd......Change the CWD to the dir of the selected node...........|NERDTree-cd|
|
||||
H.......Toggle whether hidden files displayed....................|NERDTree-H|
|
||||
f.......Toggle whether the file filters are used.................|NERDTree-f|
|
||||
F.......Toggle whether files are displayed.......................|NERDTree-F|
|
||||
B.......Toggle whether the bookmark table is displayed...........|NERDTree-B|
|
||||
|
||||
q.......Close the NERDTree window................................|NERDTree-q|
|
||||
?.......Toggle the display of the quick help.....................|NERDTree-?|
|
||||
@@ -196,8 +211,16 @@ Default key: o
|
||||
Map option: NERDTreeMapActivateNode
|
||||
Applies to: files and directories.
|
||||
|
||||
If a file node is selected, it is opened in the previous window. If a
|
||||
directory is selected it is opened or closed depending on its current state.
|
||||
If a file node is selected, it is opened in the previous window.
|
||||
|
||||
If a directory is selected it is opened or closed depending on its current
|
||||
state.
|
||||
|
||||
If a bookmark that links to a directory is selected then that directory
|
||||
becomes the new root.
|
||||
|
||||
If a bookmark that links to a file is selected then that file is opened in the
|
||||
previous window.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTree-go*
|
||||
@@ -220,6 +243,10 @@ Applies to: files and directories.
|
||||
Opens the selected file in a new tab. If a directory is selected, a netrw is
|
||||
opened in a new tab.
|
||||
|
||||
If a bookmark which points to a directory is selected, open a NERD tree for
|
||||
that directory in a new tab. If the bookmark points to a file, open that file
|
||||
in a new tab.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTree-T*
|
||||
Default key: T
|
||||
@@ -266,9 +293,8 @@ Recursively opens the selelected directory.
|
||||
|
||||
All files and directories are cached, but if a directory would not be
|
||||
displayed due to file filters (see |NERDTreeIgnore| |NERDTree-f|) or the
|
||||
hidden file filter (see |NERDTreeShowHidden|) then it is not opened. This is
|
||||
handy, especially if you have .svn directories.
|
||||
|
||||
hidden file filter (see |NERDTreeShowHidden|) then its contents are not
|
||||
cached. This is handy, especially if you have .svn directories.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTree-x*
|
||||
@@ -344,8 +370,7 @@ Default key: <C-j>
|
||||
Map option: NERDTreeMapJumpNextSibling
|
||||
Applies to: files and directories.
|
||||
|
||||
If a dir node is selected, jump to the next sibling of that node.
|
||||
If a file node is selected, jump to the next sibling of that nodes parent.
|
||||
Jump to the next sibling of the selected node.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTree-c-k*
|
||||
@@ -353,8 +378,7 @@ Default key: <C-k>
|
||||
Map option: NERDTreeMapJumpPrevSibling
|
||||
Applies to: files and directories.
|
||||
|
||||
If a dir node is selected, jump to the previous sibling of that node.
|
||||
If a file node is selected, jump to the previous sibling of that nodes parent.
|
||||
Jump to the previous sibling of the selected node.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTree-C*
|
||||
@@ -433,6 +457,14 @@ Applies to: no restrictions.
|
||||
|
||||
Toggles whether file nodes are displayed.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTree-B*
|
||||
Default key: B
|
||||
Map option: NERDTreeMapToggleBookmarks
|
||||
Applies to: no restrictions.
|
||||
|
||||
Toggles whether the bookmarks table is displayed.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTree-q*
|
||||
Default key: q
|
||||
@@ -525,6 +557,11 @@ NERD tree. These options should be set in your vimrc.
|
||||
|NERDTreeMouseMode| Tells the NERD tree how to handle mouse
|
||||
clicks.
|
||||
|
||||
|NERDTreeQuitOnOpen| Closes the tree window after opening a file.
|
||||
|
||||
|NERDTreeShowBookmarks| Tells the NERD tree whether to display the
|
||||
bookmarks table on startup.
|
||||
|
||||
|NERDTreeShowFiles| Tells the NERD tree whether to display files
|
||||
in the tree on startup.
|
||||
|
||||
@@ -537,14 +574,9 @@ NERD tree. These options should be set in your vimrc.
|
||||
|NERDTreeSortOrder| Tell the NERD tree how to sort the nodes in
|
||||
the tree.
|
||||
|
||||
|NERDTreeSplitVertical| Tells the script whether the NERD tree should
|
||||
be created by splitting the window vertically
|
||||
or horizontally.
|
||||
|
||||
|NERDTreeWinPos| Tells the script where to put the NERD tree
|
||||
window.
|
||||
|
||||
|
||||
|NERDTreeWinSize| Sets the window size when the NERD tree is
|
||||
opened.
|
||||
|
||||
@@ -695,6 +727,24 @@ itself. For example, if you have the following node: >
|
||||
then (to single click activate it) you must click somewhere in
|
||||
'application.rb'.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTreeQuitOnOpen*
|
||||
|
||||
Values: 0 or 1.
|
||||
Default: 0
|
||||
|
||||
If set to 1, the NERD tree window will close after opening a file with the
|
||||
|NERDTree-o| or |NERDTree-tab| mappings.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTreeShowBookmarks*
|
||||
Values: 0 or 1.
|
||||
Default: 0.
|
||||
|
||||
If this option is set to 1 then the bookmarks table will be displayed.
|
||||
|
||||
This option can be toggled dynamically, per tree, with the |NERDTree-B| mapping.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTreeShowFiles*
|
||||
Values: 0 or 1.
|
||||
@@ -703,9 +753,9 @@ Default: 1.
|
||||
If this option is set to 1 then files are displayed in the NERD tree. If it is
|
||||
set to 0 then only directories are displayed.
|
||||
|
||||
This option can be toggled dynamically with the |NERDTree-F| mapping and is
|
||||
useful for drastically shrinking the tree when you are navigating to a
|
||||
different part of the tree.
|
||||
This option can be toggled dynamically, per tree, with the |NERDTree-F|
|
||||
mapping and is useful for drastically shrinking the tree when you are
|
||||
navigating to a different part of the tree.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTreeShowHidden*
|
||||
@@ -713,8 +763,8 @@ Values: 0 or 1.
|
||||
Default: 0.
|
||||
|
||||
This option tells vim whether to display hidden files by default. This option
|
||||
can be dynamically toggled with the |NERDTree-H| mapping.
|
||||
Use one of the follow lines to set this option: >
|
||||
can be dynamically toggled, per tree, with the |NERDTree-H| mapping. Use one
|
||||
of the follow lines to set this option: >
|
||||
let NERDTreeShowHidden=0
|
||||
let NERDTreeShowHidden=1
|
||||
<
|
||||
@@ -763,30 +813,16 @@ Other examples: >
|
||||
3. Dirs will appear first, then ruby and php. Swap files, bak files and vim
|
||||
backup files will appear last with everything else preceding them.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTreeSplitVertical*
|
||||
Values: 0 or 1.
|
||||
Default: 1.
|
||||
|
||||
This option, along with |NERDTreeWinPos|, is used to determine where the NERD
|
||||
tree window appears.
|
||||
|
||||
If it is set to 1 then the NERD tree window will appear on either the left or
|
||||
right side of the screen (depending on the |NERDTreeWinPos| option).
|
||||
|
||||
If it set to 0 then the NERD tree window will appear at the top of the screen.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
*NERDTreeWinPos*
|
||||
Values: 0 or 1.
|
||||
Default: 1.
|
||||
Values: "left", "right", "top" or "bottom"
|
||||
Default: "left".
|
||||
|
||||
This option works in conjunction with the |NERDTreeSplitVertical| option to
|
||||
determine where NERD tree window is placed on the screen.
|
||||
This option is used to determine where NERD tree window is placed on the
|
||||
screen.
|
||||
|
||||
If the option is set to 1 then the NERD tree will appear on the left or top of
|
||||
the screen (depending on the value of |NERDTreeSplitVertical|). If set to 0,
|
||||
the window will appear on the right or bottom of the screen.
|
||||
"top" or "bottom", will cause a horizontal split to be created for the tree,
|
||||
while "left" and "right" will cause a vertical split.
|
||||
|
||||
This option is makes it possible to use two different explorer type
|
||||
plugins simultaneously. For example, you could have the taglist plugin on the
|
||||
@@ -828,10 +864,7 @@ Window manager integration?
|
||||
6. The Author *NERDTreeAuthor*
|
||||
|
||||
The author of the NERD tree is a terrible terrible monster called Martyzilla
|
||||
who gobbles up small children with milk and sugar for breakfast. He has an odd
|
||||
love/hate relationship with computers (but monsters hate everything by nature
|
||||
you know...) which can be awkward for him since he is a pro computer nerd for
|
||||
a living.
|
||||
who gobbles up small children with milk and sugar for breakfast.
|
||||
|
||||
He can be reached at martin_grenfell at msn.com. He would love to hear from
|
||||
you, so feel free to send him suggestions and/or comments about this plugin.
|
||||
@@ -841,6 +874,42 @@ fridge for later ;)
|
||||
==============================================================================
|
||||
7. Changelog *NERDTreeChangelog*
|
||||
|
||||
2.12.0
|
||||
- added a UI for bookmarks. See :help NERDTreeBookmarkTable for details.
|
||||
Thanks to Zhang Shuhan for testing and bug reports.
|
||||
- relaxed the restrictions on bookmark names, now the only restriction is
|
||||
that they cant contain spaces. This allows for e.g. Chinese bookmark
|
||||
names. Thanks to Zhang Shuhan for the suggestion.
|
||||
- combined the NERDTreeWinPos and NERDTreeSplitVertical options. See :help
|
||||
NERDTreeWinPos.
|
||||
- applied a patch from Matan Nassau to add the NERDTreeQuitOnOpen option
|
||||
which closes the tree window after opening a file. See :help
|
||||
NERDTreeQuitOnOpen.
|
||||
- optimised the nerd tree rendering. Now it takes just over 1/3 of the time
|
||||
it previously took to render.
|
||||
- now the tree filter mappings toggle the filters "per tree" rather than
|
||||
globally. The global filter variables are used to set the initial filter
|
||||
settings for each new NERD tree.
|
||||
- fix to window resizing when opening a file when NERD tree is the only
|
||||
window open
|
||||
- other fixes
|
||||
|
||||
2.11.0
|
||||
- changes to the 'o' mapping when opening files:
|
||||
- dont clobber "special" windows (eg taglist/quickfix/etc). This should
|
||||
make the NERD tree play nicer with other explorer plugins. Thanks to
|
||||
Yuan Jiang for the suggestion.
|
||||
- if the file is already open in the current tab, just move the cursor
|
||||
to that window
|
||||
- highlight executable files, made some slight changes to other
|
||||
highlighting
|
||||
- if the user resizes the tree window, keep that new size. Dont reset to
|
||||
the default during the <tab> mapping, or :NERDTreeToggle command. Only
|
||||
reset the size if a fresh tree is started with :NERDTree.
|
||||
- remove the "magic" functionality from the <c-j>/<c-k> mappings (it was
|
||||
more confusing than helpful)
|
||||
- other minor fixes
|
||||
|
||||
2.10.0
|
||||
- added bookmarks, see :help NERDTreeBookmarkCommands for details. Thanks
|
||||
to Piotr Czachur for all his testing and suggestions.
|
||||
@@ -1078,7 +1147,8 @@ Thanks to Olivier Yiptong for prompting me to make line numbers in the
|
||||
NERD tree window optional.
|
||||
|
||||
Thanks to Zhang Shuhan for all of his emails and testing to help improve the
|
||||
NERD tree path handling.
|
||||
NERD tree path handling. Thanks also for suggesting the bookmarks gui, and for
|
||||
testing and making suggestions and bugreports.
|
||||
|
||||
Thanks to Cory Echols for sending a patch to add the :NERDTreeClose command and
|
||||
set the NERD tree buffers filetype to 'nerdtree'
|
||||
@@ -1086,6 +1156,10 @@ set the NERD tree buffers filetype to 'nerdtree'
|
||||
Thanks to Piotr Czachur for all his suggestions and testing for the bookmarks
|
||||
feature.
|
||||
|
||||
Thanks to Yuan Jiang for suggesting the "o" mapping shouldnt clobber "special"
|
||||
windows, like taglist.
|
||||
|
||||
Thanks to Matan Nassau for the patch to add the NERDTreeQuitOnOpen option.
|
||||
==============================================================================
|
||||
9. License *NERDTreeLicense*
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user