Fix missing key case, add BC type checking (#1206)

* Fix missing key case, add BC type checking

Resolves #1205

* Assign g:NERDTreeCustomOpenArgs also before quick return

* Fix syntax to be compatibile with Vim 7.3

CHANGELOG.md

@@ -5,6 +5,14 @@
         - **.PATCH**: Pull Request Title (PR Author) [PR Number](Link to PR)
 -->
 #### 6.9
+- **.12**: Respect NERDTreeCustomOpenArgs when opening bookmark (przepompownia) [#1200](https://github.com/preservim/nerdtree/pull/1200)
+- **.11**: Revamp the README. (buncis, PhilRunninger) [#1192](https://github.com/preservim/nerdtree/pull/1192), [#1193](https://github.com/preservim/nerdtree/pull/1193)
+- **.10**: Open a mirrored NERDTree with correct width (PhilRunninger) [#1177](https://github.com/preservim/nerdtree/pull/1177)
+- **.9**: Updated Readme, removed typo (H3RSKO) [#1167](https://github.com/preservim/nerdtree/pull/1167)
+- **.8**: Refactor sort comparison functions, removing redundancy (PhilRunninger) [#1166](https://github.com/preservim/nerdtree/pull/1166)
+- **.7**: Fix argument of `exists()` function calls checking for autocommands. (PhilRunninger) [#1165](https://github.com/preservim/nerdtree/pull/1165)
+- **.6**: Don't use silent when raising User events (PhilRunninger) [#1164](https://github.com/preservim/nerdtree/pull/1164)
+- **.5**: Fix highlight for file node.  (pirey) [#1157](https://github.com/preservim/nerdtree/pull/1157)
 - **.4**: Make sure symbolic links' flags are highlighted correctly.  (PhilRunninger) [#1156](https://github.com/preservim/nerdtree/pull/1156)
 - **.3**: Fix new NERDTrees' width when previous one was in the only window. (PhilRunninger) [#1153](https://github.com/preservim/nerdtree/pull/1153)
 - **.2**: Fix the scope of several key mappings (lifecrisis, PhilRunninger) [#1151](https://github.com/preservim/nerdtree/pull/1151)

README.markdown

@@ -1,157 +1,178 @@
-The NERDTree [![Vint](https://github.com/preservim/nerdtree/workflows/Vint/badge.svg)](https://github.com/preservim/nerdtree/actions?workflow=Vint)
-=============
+# The NERDTree [![Vint](https://github.com/preservim/nerdtree/workflows/Vint/badge.svg)](https://github.com/preservim/nerdtree/actions?workflow=Vint)
 
-Introduction
-------------
+## Introduction
 
-The NERDTree is a file system explorer for the Vim editor. Using this plugin,
-users can visually browse complex directory hierarchies, quickly open files for
-reading or editing, and perform basic file system operations.
-
-This plugin can also be extended with custom mappings using a special API. The
-details of this API and of other NERDTree features are described in the
-included documentation.
+The NERDTree is a file system explorer for the Vim editor. Using this plugin, users can visually browse complex directory hierarchies, quickly open files for reading or editing, and perform basic file system operations.
 
 ![NERDTree Screenshot](https://github.com/preservim/nerdtree/raw/master/screenshot.png)
 
-Installation
-------------
+## Installation
 
-Below are just some of the methods for installing NERDTree. Do not follow all of these instructions; just pick your favorite one. Other plugin managers exist, and NERDTree should install just fine with any of them.
+Use your favorite plugin manager to install this plugin. [tpope/vim-pathogen](https://github.com/tpope/vim-pathogen), [VundleVimVundle.vim](https://github.com/VundleVim/Vundle.vim), [junegunnvim-plug](https://github.com/junegunn/vim-plug), and [Shougo/dein.vim](https://github.com/Shougo/dein.vim) are some of the more popular ones. A lengthy discussion of these and other managers can be found on [vi.stackexchange.com](https://vi.stackexchange.com/questions/388/what-is-the-difference-between-the-vim-plugin-managers). Basic instructions are provided below, but please **be sure to read, understand, and follow all the safety rules that come with your ~~power tools~~ plugin manager.**
 
-#### Vim 8+ packages
+If you have no favorite, or want to manage your plugins without 3rd-party dependencies, consider using Vim 8+ packages, as described in Greg Hurrell's excellent Youtube video: [Vim screencast #75: Plugin managers](https://www.youtube.com/watch?v=X2_R3uxDN6g).
 
-If you are using VIM version 8 or higher you can use its built-in package management; see `:help packages` for more information. Just run these commands in your terminal:
+<details>
+<summary>Pathogen</summary>
+Pathogen is more of a runtime path manager than a plugin manager. You must clone the plugins' repositories yourself to a specific location, and Pathogen makes sure they are available in Vim.
+
+
+1. In the terminal,
+    ```bash
+    git clone https://github.com/preservim/nerdtree.git ~/.vim/bundle/nerdtree
+    ```
+1. In your `vimrc`,
+    ```vim
+    call pathogen#infect()
+    syntax on
+    filetype plugin indent on
+    ```
+1. Restart Vim, and run `:helptags ~/.vim/bundle/nerdtree/doc/` or `:Helptags`.
+</details>
+
+<details>
+  <summary>Vundle</summary>
+
+1. Install Vundle, according to its instructions.
+1. Add the following text to your `vimrc`.
+    ```vim
+    call vundle#begin()
+      Plugin 'preservim/nerdtree'
+    call vundle#end()
+    ```
+1. Restart Vim, and run the `:PluginInstall` statement to install your plugins.
+</details>
+
+<details>
+  <summary>Vim-Plug</summary>
+
+1. Install Vim-Plug, according to its instructions.
+1. Add the following text to your `vimrc`.
+```vim
+call plug#begin()
+  Plug 'preservim/nerdtree'
+call plug#end()
+```
+1. Restart Vim, and run the `:PlugInstall` statement to install your plugins.
+</details>
+
+<details>
+  <summary>Dein</summary>
+
+1. Install Dein, according to its instructions.
+1. Add the following text to your `vimrc`.
+    ```vim
+    call dein#begin()
+      call dein#add('preservim/nerdtree')
+    call dein#end()
+    ```
+1. Restart Vim, and run the `:call dein#install()` statement to install your plugins.
+</details>
+
+<details>
+<summary>Vim 8+ packages</summary>
+
+If you are using Vim version 8 or higher you can use its built-in package management; see `:help packages` for more information. Just run these commands in your terminal:
 
 ```bash
 git clone https://github.com/preservim/nerdtree.git ~/.vim/pack/vendor/start/nerdtree
 vim -u NONE -c "helptags ~/.vim/pack/vendor/start/nerdtree/doc" -c q
 ```
+</details>
 
-Otherwise, these are some of the several 3rd-party plugin managers you can choose from. Be sure you read the instructions for your chosen plugin, as there typically are additional steps you nee d to take.
+## Getting Started
+After installing NERDTree, the best way to learn it is to turn on the Quick Help. Open NERDTree with the `:NERDTree` command, and press `?` to turn on the Quick Help, which will show you all the mappings and commands available in the NERDTree. Of course, your most complete source of information is the documentation: `:help NERDTree`.
 
-#### [pathogen.vim](https://github.com/tpope/vim-pathogen)
+## NERDTree Plugins
+NERDTree can be extended with custom mappings and functions using its built-in API. The details of this API and are described in the included documentation. Several plugins have been written, and are available on Github for installation like any other plugin. The plugins in this list are maintained (or not) by their respective owners, and certain combinations may be incompatible.
 
-In the terminal,
-```bash
-git clone https://github.com/preservim/nerdtree.git ~/.vim/bundle/nerdtree
-```
-In your vimrc,
+* [Xuyuanp/nerdtree-git-plugin](https://github.com/Xuyuanp/nerdtree-git-plugin): Shows Git status flags for files and folders in NERDTree.
+* [ryanoasis/vim-devicons](https://github.com/ryanoasis/vim-devicons): Adds filetype-specific icons to NERDTree files and folders,
+* [tiagofumo/vim-nerdtree-syntax-highlight](https://github.com/tiagofumo/vim-nerdtree-syntax-highlight): Adds syntax highlighting to NERDTree based on filetype.
+* [scrooloose/nerdtree-project-plugin](https://github.com/scrooloose/nerdtree-project-plugin): Saves and restores the state of the NERDTree between sessions.
+* [PhilRunninger/nerdtree-buffer-ops](https://github.com/PhilRunninger/nerdtree-buffer-ops): 1) Highlights open files in a different color. 2) Closes a buffer directly from NERDTree.
+* [PhilRunninger/nerdtree-visual-selection](https://github.com/PhilRunninger/nerdtree-visual-selection): Enables NERDTree to open, delete, move, or copy multiple Visually-selected files at once.
+
+If any others should be listed, mention them in an issue or pull request.
+
+
+## Frequently Asked Questions
+
+In the answers to these questions, you will see code blocks that you can put in your `vimrc` file.
+
+### How can I map a specific key or shortcut to open NERDTree?
+
+NERDTree doesn't create any shortcuts outside of the NERDTree window, so as not to overwrite any of your other shortcuts. Use the `nnoremap` command in your `vimrc`. You, of course, have many keys and NERDTree commands to choose from. Here are but a few examples.
 ```vim
-call pathogen#infect()
-syntax on
-filetype plugin indent on
+nnoremap <leader>n :NERDTreeFocus<CR>
+nnoremap <C-n> :NERDTree<CR>
+nnoremap <C-t> :NERDTreeToggle<CR>
+nnoremap <C-f> :NERDTreeFind<CR>
 ```
 
-Then reload vim, run `:helptags ~/.vim/bundle/nerdtree/doc/` or `:Helptags`.
+### How do I open NERDTree automatically when Vim starts?
+Each code block below is slightly different, as described in the `" Comment lines`.
 
-#### [Vundle.vim](https://github.com/VundleVim/Vundle.vim)
 ```vim
-call vundle#begin()
-Plugin 'preservim/nerdtree'
-call vundle#end()
+" Start NERDTree and leave the cursor in it.
+autocmd VimEnter * NERDTree
 ```
-
-#### [vim-plug](https://github.com/junegunn/vim-plug)
-```vim
-call plug#begin()
-Plug 'preservim/nerdtree'
-call plug#end()
-```
-
-#### [dein.vim](https://github.com/Shougo/dein.vim)
-```vim
-call dein#begin()
-call dein#add('preservim/nerdtree')
-call dein#end()
-```
-
-#### [apt-vim](https://github.com/egalpin/apt-vim)
-```bash
-apt-vim install -y https://github.com/preservim/nerdtree.git
-```
-
-F.A.Q. (here, and in the [Wiki](https://github.com/preservim/nerdtree/wiki))
-------
-
-#### Is there any support for `git` flags?
-
-Yes, install [nerdtree-git-plugin](https://github.com/Xuyuanp/nerdtree-git-plugin).
-
 ---
-#### Can I have the nerdtree on every tab automatically?
-
-Nope. If this is something you want then chances are you aren't using tabs and
-buffers as they were intended to be used. Read this
-http://stackoverflow.com/questions/102384/using-vims-tabs-like-buffers
-
-If you are interested in this behaviour then consider [vim-nerdtree-tabs](https://github.com/jistr/vim-nerdtree-tabs)
-
----
-#### How can I open a NERDTree automatically when vim starts up?
-
-Stick this in your vimrc: `autocmd vimenter * NERDTree`
-
----
-#### How can I open a NERDTree automatically when vim starts up if no files were specified?
-
-Stick this in your vimrc:
 ```vim
+" Start NERDTree and put the cursor back in the other window.
+autocmd VimEnter * NERDTree | wincmd p
+```
+---
+```vim
+" Start NERDTree when Vim is started without file arguments.
 autocmd StdinReadPre * let s:std_in=1
-autocmd VimEnter * if argc() == 0 && !exists("s:std_in") | NERDTree | endif
+autocmd VimEnter * if argc() == 0 && !exists('s:std_in') | NERDTree | endif
 ```
-
-Note: Now start vim with plain `vim`, not `vim .`
-
 ---
-#### What if I'm also opening a saved session, for example `vim -S session_file.vim`? I don't want NERDTree to open in that scenario.
 ```vim
+" Start NERDTree. If a file is specified, move the cursor to its window.
 autocmd StdinReadPre * let s:std_in=1
-autocmd VimEnter * if argc() == 0 && !exists("s:std_in") && v:this_session == "" | NERDTree | endif
+autocmd VimEnter * NERDTree | if argc() > 0 || exists("s:std_in") | wincmd p | endif
 ```
-
 ---
-#### How can I open NERDTree automatically when vim starts up on opening a directory?
 ```vim
+" Start NERDTree, unless a file or session is specified, eg. vim -S session_file.vim.
 autocmd StdinReadPre * let s:std_in=1
-autocmd VimEnter * if argc() == 1 && isdirectory(argv()[0]) && !exists("s:std_in") | exe 'NERDTree' argv()[0] | wincmd p | ene | exe 'cd '.argv()[0] | endif
+autocmd VimEnter * if argc() == 0 && !exists('s:std_in') && v:this_session == '' | NERDTree | endif
 ```
-
-This window is tab-specific, meaning it's used by all windows in the tab. This trick also prevents NERDTree from hiding when first selecting a file.
-
-Note: Executing `vim ~/some-directory` will open NERDTree and a new edit window. `exe 'cd '.argv()[0]` sets the `pwd` of the new edit window to `~/some-directory`
-
 ---
-#### How can I map a specific key or shortcut to open NERDTree?
-
-Stick this in your vimrc to open NERDTree with `Ctrl+n` (you can set whatever key you want):
 ```vim
-map <C-n> :NERDTreeToggle<CR>
+" Start NERDTree when Vim starts with a directory argument.
+autocmd StdinReadPre * let s:std_in=1
+autocmd VimEnter * if argc() == 1 && isdirectory(argv()[0]) && !exists('s:std_in') |
+    \ execute 'NERDTree' argv()[0] | wincmd p | enew | execute 'cd '.argv()[0] | endif
 ```
 
----
-#### How can I close vim if the only window left open is a NERDTree?
+### How can I close Vim automatically when NERDTree is the last window?
 
-Stick this in your vimrc:
 ```vim
-autocmd bufenter * if (winnr("$") == 1 && exists("b:NERDTree") && b:NERDTree.isTabTree()) | q | endif
+" Exit Vim if NERDTree is the only window left.
+autocmd BufEnter * if tabpagenr('$') == 1 && winnr('$') == 1 && exists('b:NERDTree') && b:NERDTree.isTabTree() |
+    \ quit | endif
 ```
 
----
-#### Can I have different highlighting for different file extensions?
+### Can I have the same NERDTree on every tab automatically?
 
-See here: https://github.com/preservim/nerdtree/issues/433#issuecomment-92590696
+```vim
+" Open the existing NERDTree on each new tab.
+autocmd BufWinEnter * silent NERDTreeMirror
+```
+or change your NERDTree-launching shortcut key like so:
+```vim
+" Mirror the NERDTree before showing it. This makes it the same on all tabs.
+nnoremap <C-n> :NERDTreeMirror<CR>:NERDTreeFocus<CR>
+```
 
----
-#### How can I change default arrows?
+### How can I change the default arrows?
 
-Use these variables in your vimrc. Note that below are default arrow symbols
 ```vim
 let g:NERDTreeDirArrowExpandable = '▸'
 let g:NERDTreeDirArrowCollapsible = '▾'
 ```
-You can remove the arrows altogether by setting these variables to empty strings, as shown below. This will remove not only the arrows, but a single space following them, shifting the whole tree two character positions to the left.
-```vim
-let g:NERDTreeDirArrowExpandable = ''
-let g:NERDTreeDirArrowCollapsible = ''
-```
+The preceding values are the non-Windows default arrow symbols. Setting these variables to empty strings will remove the arrows completely and shift the entire tree two character positions to the left. See `:h NERDTreeDirArrowExpandable` for more details.
+

autoload/nerdtree.vim

@@ -110,15 +110,15 @@ function! nerdtree#completeBookmarks(A,L,P) abort
     return filter(g:NERDTreeBookmark.BookmarkNames(), 'v:val =~# "^' . a:A . '"')
 endfunction
 
-"FUNCTION: nerdtree#compareNodes(dir) {{{2
+"FUNCTION: nerdtree#compareNodes(n1, n2) {{{2
 function! nerdtree#compareNodes(n1, n2) abort
-    return a:n1.path.compareTo(a:n2.path)
+    return nerdtree#compareNodePaths(a:n1.path, a:n2.path)
 endfunction
 
-"FUNCTION: nerdtree#compareNodesBySortKey(n1, n2) {{{2
-function! nerdtree#compareNodesBySortKey(n1, n2) abort
-    let sortKey1 = a:n1.path.getSortKey()
-    let sortKey2 = a:n2.path.getSortKey()
+"FUNCTION: nerdtree#compareNodePaths(p1, p2) {{{2
+function! nerdtree#compareNodePaths(p1, p2) abort
+    let sortKey1 = a:p1.getSortKey()
+    let sortKey2 = a:p2.getSortKey()
     let i = 0
     while i < min([len(sortKey1), len(sortKey2)])
         " Compare chunks upto common length.

autoload/nerdtree/ui_glue.vim

@@ -108,10 +108,41 @@ function! s:customOpenBookmark(node) abort
 endfunction
 
 "FUNCTION: s:initCustomOpenArgs() {{{1
-" Make sure NERDTreeCustomOpenArgs has needed keys
 function! s:initCustomOpenArgs() abort
-    let g:NERDTreeCustomOpenArgs = get(g:, 'NERDTreeCustomOpenArgs', {})
-    return extend(g:NERDTreeCustomOpenArgs, {'file':{'reuse': 'all', 'where': 'p'}, 'dir':{}}, 'keep')
+    let l:defaultOpenArgs = {'file': {'reuse': 'all', 'where': 'p'}, 'dir': {}}
+    let l:customOpenArgs = get(g:, 'NERDTreeCustomOpenArgs', {})
+
+    if !s:validateType(l:customOpenArgs, type({})) || empty(l:customOpenArgs)
+        let g:NERDTreeCustomOpenArgs = l:customOpenArgs
+        return l:defaultOpenArgs
+    endif
+
+    for l:typeKey in keys(l:defaultOpenArgs)
+        if !s:validateType(get(l:customOpenArgs, l:typeKey, {}), type({}))
+              \ || !has_key(l:customOpenArgs, l:typeKey)
+            let l:customOpenArgs[l:typeKey] = l:defaultOpenArgs[l:typeKey]
+            continue
+        endif
+
+        for l:optionName in keys(l:defaultOpenArgs[l:typeKey])
+            if s:validateType(get(l:customOpenArgs[l:typeKey], l:optionName, v:null), type(''))
+                continue
+            endif
+            let l:customOpenArgs[l:typeKey][l:optionName] = l:defaultOpenArgs[l:typeKey][l:optionName]
+        endfor
+    endfor
+
+    let g:NERDTreeCustomOpenArgs = l:customOpenArgs
+
+    return extend(l:customOpenArgs, l:defaultOpenArgs, 'keep')
+endfunction
+
+function! s:validateType(variable, type) abort
+    if type(a:variable) == a:type
+        return v:true
+    endif
+
+    return v:false
 endfunction
 
 "FUNCTION: s:activateAll() {{{1
@@ -500,9 +531,10 @@ function! nerdtree#ui_glue#openBookmark(name) abort
     endtry
     if l:bookmark.path.isDirectory
         call l:bookmark.open(b:NERDTree)
-    else
-        call l:bookmark.open(b:NERDTree, {'where': 'p'})
+        return
     endif
+
+    call l:bookmark.open(b:NERDTree, s:initCustomOpenArgs().file)
 endfunction
 
 " FUNCTION: s:openHSplit(target) {{{1

lib/nerdtree/creator.vim

@@ -28,7 +28,9 @@ endfunction
 
 " FUNCTION: s:Creator._broadcastInitEvent() {{{1
 function! s:Creator._broadcastInitEvent()
-    silent doautocmd User NERDTreeInit
+    if exists('#User#NERDTreeInit')
+        doautocmd User NERDTreeInit
+    endif
 endfunction
 
 " FUNCTION: s:Creator.BufNamePrefix() {{{1
@@ -170,6 +172,7 @@ function! s:Creator.createMirror()
     let t:NERDTreeBufName = bufferName
     call self._createTreeWin()
     exec 'buffer ' .  bufferName
+    call b:NERDTree.ui.restoreScreenState()
     if !&hidden
         call b:NERDTree.render()
     endif

lib/nerdtree/nerdtree.vim

@@ -27,7 +27,9 @@ function! s:NERDTree.changeRoot(node)
     call self.render()
     call self.root.putCursorHere(0, 0)
 
-    silent doautocmd User NERDTreeNewRoot
+    if exists('#User#NERDTreeNewRoot')
+        doautocmd User NERDTreeNewRoot
+    endif
 endfunction
 
 "FUNCTION: s:NERDTree.Close() {{{1

lib/nerdtree/opener.vim

@@ -174,9 +174,8 @@ function! s:Opener._newSplit()
 
     "resize the tree window if no other window was open before
     if onlyOneWin
-        let size = exists('b:NERDTreeOldWindowSize') ? b:NERDTreeOldWindowSize : g:NERDTreeWinSize
         call nerdtree#exec('wincmd p', 1)
-        call nerdtree#exec('silent '. splitMode .' resize '. size, 1)
+        call nerdtree#exec('silent '. splitMode .' resize '. g:NERDTreeWinSize, 1)
         call nerdtree#exec('wincmd p', 0)
     endif
 

lib/nerdtree/path.vim

@@ -99,50 +99,6 @@ function! s:Path.changeToDir()
     endtry
 endfunction
 
-" FUNCTION: Path.compareTo() {{{1
-"
-" Compares this Path to the given path and returns 0 if they are equal, -1 if
-" this Path is 'less than' the given path, or 1 if it is 'greater'.
-"
-" Args:
-" path: the path object to compare this to
-"
-" Return:
-" 1, -1 or 0
-function! s:Path.compareTo(path)
-    let thisPath = self.getLastPathComponent(1)
-    let thatPath = a:path.getLastPathComponent(1)
-
-    "if the paths are the same then clearly we return 0
-    if thisPath ==# thatPath
-        return 0
-    endif
-
-    let thisSS = self.getSortOrderIndex()
-    let thatSS = a:path.getSortOrderIndex()
-
-    "compare the sort sequences, if they are different then the return
-    "value is easy
-    if thisSS < thatSS
-        return -1
-    elseif thisSS > thatSS
-        return 1
-    else
-        if !g:NERDTreeSortHiddenFirst
-            let thisPath = substitute(thisPath, '^[._]', '', '')
-            let thatPath = substitute(thatPath, '^[._]', '', '')
-        endif
-        "if the sort sequences are the same then compare the paths
-        "alphabetically
-        let pathCompare = g:NERDTreeCaseSensitiveSort ? thisPath <# thatPath : thisPath <? thatPath
-        if pathCompare
-            return -1
-        else
-            return 1
-        endif
-    endif
-endfunction
-
 " FUNCTION: Path.Create(fullpath) {{{1
 "
 " Factory method.

lib/nerdtree/tree_dir_node.vim

@@ -236,7 +236,7 @@ function! s:TreeDirNode.getChildIndex(path)
     let z = self.getChildCount()
     while a < z
         let mid = (a+z)/2
-        let diff = a:path.compareTo(self.children[mid].path)
+        let diff = nerdtree#compareNodePaths(a:path, self.children[mid].path)
 
         if diff ==# -1
             let z = mid
@@ -666,7 +666,7 @@ function! s:TreeDirNode.sortChildren()
     if count(g:NERDTreeSortOrder, '*') < 1
         call add(g:NERDTreeSortOrder, '*')
     endif
-    let CompareFunc = function('nerdtree#compareNodesBySortKey')
+    let CompareFunc = function('nerdtree#compareNodes')
     call sort(self.children, CompareFunc)
     let g:NERDTreeOldSortOrder = g:NERDTreeSortOrder
 endfunction

lib/nerdtree/ui.vim

@@ -516,8 +516,7 @@ endfunction
 " zoom (maximize/minimize) the NERDTree window
 function! s:UI.toggleZoom()
     if exists('b:NERDTreeZoomed') && b:NERDTreeZoomed
-        let size = exists('b:NERDTreeOldWindowSize') ? b:NERDTreeOldWindowSize : g:NERDTreeWinSize
-        call nerdtree#exec('silent vertical resize '. size, 1)
+        call nerdtree#exec('silent vertical resize '. g:NERDTreeWinSize, 1)
         let b:NERDTreeZoomed = 0
     else
         call nerdtree#exec('vertical resize '. get(g:, 'NERDTreeWinSizeMax', ''), 1)

plugin/NERD_tree.vim

@@ -26,141 +26,114 @@ let loaded_nerd_tree = 1
 let s:old_cpo = &cpoptions
 set cpoptions&vim
 
-"Function: s:initVariable() function {{{2
-"This function is used to initialise a given variable to a given value. The
-"variable is only initialised if it does not exist prior
-"
-"Args:
-"var: the name of the var to be initialised
-"value: the value to initialise var to
-"
-"Returns:
-"1 if the var is set, 0 otherwise
-function! s:initVariable(var, value)
-    if !exists(a:var)
-        exec 'let ' . a:var . ' = ' . "'" . substitute(a:value, "'", "''", 'g') . "'"
-        return 1
-    endif
-    return 0
-endfunction
-
-"SECTION: Init variable calls and other random constants {{{2
-call s:initVariable('g:NERDTreeAutoCenter', 1)
-call s:initVariable('g:NERDTreeAutoCenterThreshold', 3)
-call s:initVariable('g:NERDTreeCaseSensitiveSort', 0)
-call s:initVariable('g:NERDTreeNaturalSort', 0)
-call s:initVariable('g:NERDTreeSortHiddenFirst', 1)
-call s:initVariable('g:NERDTreeUseTCD', 0)
-call s:initVariable('g:NERDTreeChDirMode', 0)
-call s:initVariable('g:NERDTreeCreatePrefix', 'silent')
-call s:initVariable('g:NERDTreeMinimalUI', 0)
-call s:initVariable('g:NERDTreeMinimalMenu', 0)
-if !exists('g:NERDTreeIgnore')
-    let g:NERDTreeIgnore = ['\~$']
-endif
-call s:initVariable('g:NERDTreeBookmarksFile', expand('$HOME') . '/.NERDTreeBookmarks')
-call s:initVariable('g:NERDTreeBookmarksSort', 1)
-call s:initVariable('g:NERDTreeHighlightCursorline', 1)
-call s:initVariable('g:NERDTreeHijackNetrw', 1)
-call s:initVariable('g:NERDTreeMarkBookmarks', 1)
-call s:initVariable('g:NERDTreeMouseMode', 1)
-call s:initVariable('g:NERDTreeNotificationThreshold', 100)
-call s:initVariable('g:NERDTreeQuitOnOpen', 0)
-call s:initVariable('g:NERDTreeRespectWildIgnore', 0)
-call s:initVariable('g:NERDTreeShowBookmarks', 0)
-call s:initVariable('g:NERDTreeShowFiles', 1)
-call s:initVariable('g:NERDTreeShowHidden', 0)
-call s:initVariable('g:NERDTreeShowLineNumbers', 0)
-call s:initVariable('g:NERDTreeSortDirs', 1)
+"SECTION: Initialize variable calls and other random constants {{{2
+let g:NERDTreeAutoCenter            = get(g:, 'NERDTreeAutoCenter',            1)
+let g:NERDTreeAutoCenterThreshold   = get(g:, 'NERDTreeAutoCenterThreshold',   3)
+let g:NERDTreeCaseSensitiveSort     = get(g:, 'NERDTreeCaseSensitiveSort',     0)
+let g:NERDTreeNaturalSort           = get(g:, 'NERDTreeNaturalSort',           0)
+let g:NERDTreeSortHiddenFirst       = get(g:, 'NERDTreeSortHiddenFirst',       1)
+let g:NERDTreeUseTCD                = get(g:, 'NERDTreeUseTCD',                0)
+let g:NERDTreeChDirMode             = get(g:, 'NERDTreeChDirMode',             0)
+let g:NERDTreeCreatePrefix          = get(g:, 'NERDTreeCreatePrefix',          'silent')
+let g:NERDTreeMinimalUI             = get(g:, 'NERDTreeMinimalUI',             0)
+let g:NERDTreeMinimalMenu           = get(g:, 'NERDTreeMinimalMenu',           0)
+let g:NERDTreeIgnore                = get(g:, 'NERDTreeIgnore',                ['\~$'])
+let g:NERDTreeBookmarksFile         = get(g:, 'NERDTreeBookmarksFile',         expand('$HOME') . '/.NERDTreeBookmarks')
+let g:NERDTreeBookmarksSort         = get(g:, 'NERDTreeBookmarksSort',         1)
+let g:NERDTreeHighlightCursorline   = get(g:, 'NERDTreeHighlightCursorline',   1)
+let g:NERDTreeHijackNetrw           = get(g:, 'NERDTreeHijackNetrw',           1)
+let g:NERDTreeMarkBookmarks         = get(g:, 'NERDTreeMarkBookmarks',         1)
+let g:NERDTreeMouseMode             = get(g:, 'NERDTreeMouseMode',             1)
+let g:NERDTreeNotificationThreshold = get(g:, 'NERDTreeNotificationThreshold', 100)
+let g:NERDTreeQuitOnOpen            = get(g:, 'NERDTreeQuitOnOpen',            0)
+let g:NERDTreeRespectWildIgnore     = get(g:, 'NERDTreeRespectWildIgnore',     0)
+let g:NERDTreeShowBookmarks         = get(g:, 'NERDTreeShowBookmarks',         0)
+let g:NERDTreeShowFiles             = get(g:, 'NERDTreeShowFiles',             1)
+let g:NERDTreeShowHidden            = get(g:, 'NERDTreeShowHidden',            0)
+let g:NERDTreeShowLineNumbers       = get(g:, 'NERDTreeShowLineNumbers',       0)
+let g:NERDTreeSortDirs              = get(g:, 'NERDTreeSortDirs',              1)
 
 if !nerdtree#runningWindows() && !nerdtree#runningCygwin()
-    call s:initVariable('g:NERDTreeDirArrowExpandable', '▸')
-    call s:initVariable('g:NERDTreeDirArrowCollapsible', '▾')
+    let g:NERDTreeDirArrowExpandable  = get(g:, 'NERDTreeDirArrowExpandable',  '▸')
+    let g:NERDTreeDirArrowCollapsible = get(g:, 'NERDTreeDirArrowCollapsible', '▾')
 else
-    call s:initVariable('g:NERDTreeDirArrowExpandable', '+')
-    call s:initVariable('g:NERDTreeDirArrowCollapsible', '~')
+    let g:NERDTreeDirArrowExpandable  = get(g:, 'NERDTreeDirArrowExpandable',  '+')
+    let g:NERDTreeDirArrowCollapsible = get(g:, 'NERDTreeDirArrowCollapsible', '~')
 endif
 
-call s:initVariable('g:NERDTreeCascadeOpenSingleChildDir', 1)
-call s:initVariable('g:NERDTreeCascadeSingleChildDir', 1)
+let g:NERDTreeCascadeOpenSingleChildDir = get(g:, 'NERDTreeCascadeOpenSingleChildDir', 1)
+let g:NERDTreeCascadeSingleChildDir     = get(g:, 'NERDTreeCascadeSingleChildDir',     1)
 
-if !exists('g:NERDTreeSortOrder')
-    let g:NERDTreeSortOrder = ['\/$', '*', '\.swp$',  '\.bak$', '\~$']
-endif
+let g:NERDTreeSortOrder    = get(g:, 'NERDTreeSortOrder', ['\/$', '*', '\.swp$', '\.bak$', '\~$'])
 let g:NERDTreeOldSortOrder = []
 
-call s:initVariable('g:NERDTreeGlyphReadOnly', 'RO')
+let g:NERDTreeGlyphReadOnly = get(g:, 'NERDTreeGlyphReadOnly', 'RO')
 
 if has('conceal')
-    call s:initVariable('g:NERDTreeNodeDelimiter', "\x07")
+    let g:NERDTreeNodeDelimiter = get(g:, 'NERDTreeNodeDelimiter', "\x07")
 elseif (g:NERDTreeDirArrowExpandable ==# "\u00a0" || g:NERDTreeDirArrowCollapsible ==# "\u00a0")
-    call s:initVariable('g:NERDTreeNodeDelimiter', "\u00b7")
+    let g:NERDTreeNodeDelimiter = get(g:, 'NERDTreeNodeDelimiter', "\u00b7")
 else
-    call s:initVariable('g:NERDTreeNodeDelimiter', "\u00a0")
+    let g:NERDTreeNodeDelimiter = get(g:, 'NERDTreeNodeDelimiter', "\u00a0")
 endif
 
-if !exists('g:NERDTreeStatusline')
+"the exists() crap here is a hack to stop vim spazzing out when
+"loading a session that was created with an open nerd tree. It spazzes
+"because it doesnt store b:NERDTree(its a b: var, and its a hash)
+let g:NERDTreeStatusline = get(g:, 'NERDTreeStatusline', "%{exists('b:NERDTree')?b:NERDTree.root.path.str():''}")
 
-    "the exists() crap here is a hack to stop vim spazzing out when
-    "loading a session that was created with an open nerd tree. It spazzes
-    "because it doesnt store b:NERDTree(its a b: var, and its a hash)
-    let g:NERDTreeStatusline = "%{exists('b:NERDTree')?b:NERDTree.root.path.str():''}"
-
-endif
-call s:initVariable('g:NERDTreeWinPos', 'left')
-call s:initVariable('g:NERDTreeWinSize', 31)
+let g:NERDTreeWinPos  = get(g:, 'NERDTreeWinPos', 'left')
+let g:NERDTreeWinSize = get(g:, 'NERDTreeWinSize', 31)
 
 "init the shell commands that will be used to copy nodes, and remove dir trees
-"
 "Note: the space after the command is important
 if nerdtree#runningWindows()
-    call s:initVariable('g:NERDTreeRemoveDirCmd', 'rmdir /s /q ')
-    call s:initVariable('g:NERDTreeCopyDirCmd', 'xcopy /s /e /i /y /q ')
-    call s:initVariable('g:NERDTreeCopyFileCmd', 'copy /y ')
+    let g:NERDTreeRemoveDirCmd = get(g:, 'NERDTreeRemoveDirCmd', 'rmdir /s /q ')
+    let g:NERDTreeCopyDirCmd   = get(g:, 'NERDTreeCopyDirCmd',   'xcopy /s /e /i /y /q ')
+    let g:NERDTreeCopyFileCmd  = get(g:, 'NERDTreeCopyFileCmd',  'copy /y ')
 else
-    call s:initVariable('g:NERDTreeRemoveDirCmd', 'rm -rf ')
-    call s:initVariable('g:NERDTreeCopyCmd', 'cp -r ')
+    let g:NERDTreeRemoveDirCmd = get(g:, 'NERDTreeRemoveDirCmd', 'rm -rf ')
+    let g:NERDTreeCopyCmd      = get(g:, 'NERDTreeCopyCmd',      'cp -r ')
 endif
 
-
 "SECTION: Init variable calls for key mappings {{{2
-call s:initVariable('g:NERDTreeMapCustomOpen', '<CR>')
-call s:initVariable('g:NERDTreeMapActivateNode', 'o')
-call s:initVariable('g:NERDTreeMapChangeRoot', 'C')
-call s:initVariable('g:NERDTreeMapChdir', 'cd')
-call s:initVariable('g:NERDTreeMapCloseChildren', 'X')
-call s:initVariable('g:NERDTreeMapCloseDir', 'x')
-call s:initVariable('g:NERDTreeMapDeleteBookmark', 'D')
-call s:initVariable('g:NERDTreeMapMenu', 'm')
-call s:initVariable('g:NERDTreeMapHelp', '?')
-call s:initVariable('g:NERDTreeMapJumpFirstChild', 'K')
-call s:initVariable('g:NERDTreeMapJumpLastChild', 'J')
-call s:initVariable('g:NERDTreeMapJumpNextSibling', '<C-j>')
-call s:initVariable('g:NERDTreeMapJumpParent', 'p')
-call s:initVariable('g:NERDTreeMapJumpPrevSibling', '<C-k>')
-call s:initVariable('g:NERDTreeMapJumpRoot', 'P')
-call s:initVariable('g:NERDTreeMapOpenExpl', 'e')
-call s:initVariable('g:NERDTreeMapOpenInTab', 't')
-call s:initVariable('g:NERDTreeMapOpenInTabSilent', 'T')
-call s:initVariable('g:NERDTreeMapOpenRecursively', 'O')
-call s:initVariable('g:NERDTreeMapOpenSplit', 'i')
-call s:initVariable('g:NERDTreeMapOpenVSplit', 's')
-call s:initVariable('g:NERDTreeMapPreview', 'g' . NERDTreeMapActivateNode)
-call s:initVariable('g:NERDTreeMapPreviewSplit', 'g' . NERDTreeMapOpenSplit)
-call s:initVariable('g:NERDTreeMapPreviewVSplit', 'g' . NERDTreeMapOpenVSplit)
-call s:initVariable('g:NERDTreeMapQuit', 'q')
-call s:initVariable('g:NERDTreeMapRefresh', 'r')
-call s:initVariable('g:NERDTreeMapRefreshRoot', 'R')
-call s:initVariable('g:NERDTreeMapToggleBookmarks', 'B')
-call s:initVariable('g:NERDTreeMapToggleFiles', 'F')
-call s:initVariable('g:NERDTreeMapToggleFilters', 'f')
-call s:initVariable('g:NERDTreeMapToggleHidden', 'I')
-call s:initVariable('g:NERDTreeMapToggleZoom', 'A')
-call s:initVariable('g:NERDTreeMapUpdir', 'u')
-call s:initVariable('g:NERDTreeMapUpdirKeepOpen', 'U')
-call s:initVariable('g:NERDTreeMapCWD', 'CD')
-call s:initVariable('g:NERDTreeMenuDown', 'j')
-call s:initVariable('g:NERDTreeMenuUp', 'k')
+let g:NERDTreeMapCustomOpen      = get(g:, 'NERDTreeMapCustomOpen',      '<CR>')
+let g:NERDTreeMapActivateNode    = get(g:, 'NERDTreeMapActivateNode',    'o')
+let g:NERDTreeMapChangeRoot      = get(g:, 'NERDTreeMapChangeRoot',      'C')
+let g:NERDTreeMapChdir           = get(g:, 'NERDTreeMapChdir',           'cd')
+let g:NERDTreeMapCloseChildren   = get(g:, 'NERDTreeMapCloseChildren',   'X')
+let g:NERDTreeMapCloseDir        = get(g:, 'NERDTreeMapCloseDir',        'x')
+let g:NERDTreeMapDeleteBookmark  = get(g:, 'NERDTreeMapDeleteBookmark',  'D')
+let g:NERDTreeMapMenu            = get(g:, 'NERDTreeMapMenu',            'm')
+let g:NERDTreeMapHelp            = get(g:, 'NERDTreeMapHelp',            '?')
+let g:NERDTreeMapJumpFirstChild  = get(g:, 'NERDTreeMapJumpFirstChild',  'K')
+let g:NERDTreeMapJumpLastChild   = get(g:, 'NERDTreeMapJumpLastChild',   'J')
+let g:NERDTreeMapJumpNextSibling = get(g:, 'NERDTreeMapJumpNextSibling', '<C-j>')
+let g:NERDTreeMapJumpParent      = get(g:, 'NERDTreeMapJumpParent',      'p')
+let g:NERDTreeMapJumpPrevSibling = get(g:, 'NERDTreeMapJumpPrevSibling', '<C-k>')
+let g:NERDTreeMapJumpRoot        = get(g:, 'NERDTreeMapJumpRoot',        'P')
+let g:NERDTreeMapOpenExpl        = get(g:, 'NERDTreeMapOpenExpl',        'e')
+let g:NERDTreeMapOpenInTab       = get(g:, 'NERDTreeMapOpenInTab',       't')
+let g:NERDTreeMapOpenInTabSilent = get(g:, 'NERDTreeMapOpenInTabSilent', 'T')
+let g:NERDTreeMapOpenRecursively = get(g:, 'NERDTreeMapOpenRecursively', 'O')
+let g:NERDTreeMapOpenSplit       = get(g:, 'NERDTreeMapOpenSplit',       'i')
+let g:NERDTreeMapOpenVSplit      = get(g:, 'NERDTreeMapOpenVSplit',      's')
+let g:NERDTreeMapPreview         = get(g:, 'NERDTreeMapPreview',         'g'.NERDTreeMapActivateNode)
+let g:NERDTreeMapPreviewSplit    = get(g:, 'NERDTreeMapPreviewSplit',    'g'.NERDTreeMapOpenSplit)
+let g:NERDTreeMapPreviewVSplit   = get(g:, 'NERDTreeMapPreviewVSplit',   'g'.NERDTreeMapOpenVSplit)
+let g:NERDTreeMapQuit            = get(g:, 'NERDTreeMapQuit',            'q')
+let g:NERDTreeMapRefresh         = get(g:, 'NERDTreeMapRefresh',         'r')
+let g:NERDTreeMapRefreshRoot     = get(g:, 'NERDTreeMapRefreshRoot',     'R')
+let g:NERDTreeMapToggleBookmarks = get(g:, 'NERDTreeMapToggleBookmarks', 'B')
+let g:NERDTreeMapToggleFiles     = get(g:, 'NERDTreeMapToggleFiles',     'F')
+let g:NERDTreeMapToggleFilters   = get(g:, 'NERDTreeMapToggleFilters',   'f')
+let g:NERDTreeMapToggleHidden    = get(g:, 'NERDTreeMapToggleHidden',    'I')
+let g:NERDTreeMapToggleZoom      = get(g:, 'NERDTreeMapToggleZoom',      'A')
+let g:NERDTreeMapUpdir           = get(g:, 'NERDTreeMapUpdir',           'u')
+let g:NERDTreeMapUpdirKeepOpen   = get(g:, 'NERDTreeMapUpdirKeepOpen',   'U')
+let g:NERDTreeMapCWD             = get(g:, 'NERDTreeMapCWD',             'CD')
+let g:NERDTreeMenuDown           = get(g:, 'NERDTreeMenuDown',           'j')
+let g:NERDTreeMenuUp             = get(g:, 'NERDTreeMenuUp',             'k')
 
 "SECTION: Load class files{{{2
 call nerdtree#loadClassFiles()

syntax/nerdtree.vim

@@ -93,3 +93,5 @@ hi def link NERDTreeBookmark Statement
 hi def link NERDTreeFlags Number
 
 hi def link NERDTreeCurrentNode Search
+
+hi NERDTreeFile ctermbg=NONE guibg=NONE