Improve F.A.Q. Answers and Issue Templates (#1249)

* Update the issue templates, making them simpler to use.

* Update FAQ answers.

Closes #1246.
- Add an if statement to the autocommand to prevent its running in the
  Command Window.

Closes #1248.
- Add a new answer to show closing a tab when only NERDTree remains.

* Update the Bug issue template.

* Update version number in change log.

.github/ISSUE_TEMPLATE/bug.md

@@ -5,41 +5,42 @@ labels: bug
 ---
 <!-- Attention! Please Read!
 
-Please fill out ALL the information below so that the issue can be fully
-understood. Omitting information will delay the resolution of your issue. It
-will be labeled "Needs More Info", and may be closed until there is enough
-information.
+Please fill out ALL the information below so that the issue can be fully understood. Omitting
+information will delay the resolution of your issue. It will be labeled "Needs More Info", and
+may be closed until there is enough information.
 
-Keep in mind that others may have the same question in the future. The better
-your information, the more likely they'll be able to help themselves. -->
+Keep in mind that others may have the same question in the future. The better your information,
+the more likely they'll be able to help themselves.
+-->
 
 #### Self-Diagnosis
-<!-- Check the boxes after creating the issue, or use [x]. -->
-- [ ] I have searched the [issues](https://github.com/scrooloose/nerdtree/issues) for an answer to my question.
-- [ ] I have reviewed the NERDTree documentation. `:h NERDTree`
-- [ ] I have reviewed the [Wiki](https://github.com/scrooloose/nerdtree/wiki).
-- [ ] I have searched the web for an answer to my question.
+Before creating an issue, take some time to search these resources for an answer. It's possible that someone else has already seen and solved your issue.
+- [old NERDTree issues](https://github.com/preservim/nerdtree/issues?q=is%3Aissue)
+- NERDTree documentation - `:h NERDTree`
+- [NERDTree Wiki](https://github.com/preservim/nerdtree/wiki)
+- Other resources: <https://stackoverflow.com>, <https://vi.stackexchange.com>, etc.
 
-#### Environment (for bug reports)
-- [ ] Operating System: 
-- [ ] Vim/Neovim version `:echo v:version`: 
-- [ ] NERDTree version, found on 1st line in NERDTree quickhelp `?`: 
-- [ ] vimrc settings
-    - [ ] NERDTree variables
-    ```vim
-    ```
-    - Other NERDTree-dependent Plugins
-        - [ ] jistr/vim-nerdtree-tabs
-        - [ ] ryanoasis/vim-devicons
-        - [ ] tiagofumo/vim-nerdtree-syntax-highlight
-        - [ ] Xuyuanp/nerdtree-git-plugin
+#### Environment
+- Operating System: 
+- Vim/Neovim version `:version`: 
+- NERDTree version, found on first line of quickhelp `?`: 
+- Are you using any of these NERDTree-dependent plugins?  <!-- Check the boxes after creating the issue. -->
+    - [ ] [Xuyuanp/nerdtree-git-plugin](https://github.com/Xuyuanp/nerdtree-git-plugin)
+    - [ ] [ryanoasis/vim-devicons](https://github.com/ryanoasis/vim-devicons)
+    - [ ] [tiagofumo/vim-nerdtree-syntax-highlight](https://github.com/tiagofumo/vim-nerdtree-syntax-highlight)
+    - [ ] [scrooloose/nerdtree-project-plugin](https://github.com/scrooloose/nerdtree-project-plugin)
+    - [ ] [PhilRunninger/nerdtree-buffer-ops](https://github.com/PhilRunninger/nerdtree-buffer-ops)
+    - [ ] [PhilRunninger/nerdtree-visual-selection](https://github.com/PhilRunninger/nerdtree-visual-selection)
+    - [ ] [jistr/vim-nerdtree-tabs](https://github.com/jistr/vim-nerdtree-tabs)
     - [ ] Others (specify):
-    - [ ] I've verified the issue occurs with only NERDTree installed.
+- Provide a minimal **.vimrc** file that will reproduce the issue.
+```vim
+```
 
 #### Steps to Reproduce the Issue
 1. 
 
-#### Current Result (Include screenshots where appropriate.)
+#### Current Behavior (Include screenshots where appropriate.)
 
 #### Expected Result
 

.github/ISSUE_TEMPLATE/question.md

@@ -3,22 +3,11 @@ name: "General Question"
 about: "Having trouble setting up NERDTree? Need clarification on a setting? Ask your question here."
 labels: "general question"
 ---
-<!-- Attention! Please Read!
-
-Please fill out ALL the information below so that the issue can be fully
-understood. Omitting information will delay the resolution of your issue. It
-will be labeled "Needs More Info", and may be closed until there is enough
-information.
-
-Keep in mind that others may have the same question in the future. The better
-your information, the more likely they'll be able to help themselves. -->
-
-#### Self-Diagnosis
-<!-- Check the boxes after creating the issue, or use [x]. -->
-- [ ] I have searched the [issues](https://github.com/scrooloose/nerdtree/issues) for an answer to my question.
-- [ ] I have reviewed the NERDTree documentation. `:h NERDTree`
-- [ ] I have reviewed the [Wiki](https://github.com/scrooloose/nerdtree/wiki).
-- [ ] I have searched the web for an answer to my question.
+Before creating an issue, take some time to search these resources. It's possible that someone else has already asked your question and gotten an answer.
+- [old NERDTree issues](https://github.com/preservim/nerdtree/issues?q=is%3Aissue)
+- NERDTree documentation - `:h NERDTree`
+- [NERDTree Wiki](https://github.com/scrooloose/nerdtree/wiki)
+- Other resource: <https://stackoverflow.com>, <https://vi.stackexchange.com>, etc.
 
 #### State Your Question
 

CHANGELOG.md

@@ -5,6 +5,11 @@
         - **.PATCH**: Pull Request Title (PR Author) [PR Number](Link to PR)
 -->
 #### 6.10
+- **.10**: Improve F.A.Q. Answers and Issue Templates (PhilRunninger) [#1249](https://github.com/preservim/nerdtree/pull/1249)
+- **.9**: `go` on a bookmark directory will NERDTreeFind it. (PhilRunninger) [#1236](https://github.com/preservim/nerdtree/pull/1236)
+- **.8**: Put `Callback` function variables in local scope. (PhilRunninger) [#1230](https://github.com/preservim/nerdtree/pull/1230)
+- **.7**: Fix mouse-clicking a file to open it. (PhilRunninger) [#1225](https://github.com/preservim/nerdtree/pull/1225)
+- **.6**: Restore the default behavior of the `<CR>` key. (PhilRunninger) [#1221](https://github.com/preservim/nerdtree/pull/1221)
 - **.5**: Fix `{'keepopen':0}` in NERDTreeCustomOpenArgs (PhilRunninger) [#1217](https://github.com/preservim/nerdtree/pull/1217)
 - **.4**: Removed directory separator from sort key (Daniel E) [#1219](https://github.com/preservim/nerdtree/pull/1219)
 - **.3**: Add new FAQ and answer: How to prevent buffers replacing NERDTree. (PhilRunninger) [#1215](https://github.com/preservim/nerdtree/pull/1215)

README.markdown

@@ -8,7 +8,7 @@ The NERDTree is a file system explorer for the Vim editor. Using this plugin, us
 
 ## Installation
 
-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.**
+Use your favorite plugin manager to install this plugin. [tpope/vim-pathogen](https://github.com/tpope/vim-pathogen), [VundleVim/Vundle.vim](https://github.com/VundleVim/Vundle.vim), [junegunn/vim-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.**
 
 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).
 
@@ -148,18 +148,22 @@ 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 automatically when NERDTree is the last window?
+### How can I close Vim or a tab automatically when NERDTree is the last window?
 
 ```vim
-" Exit Vim if NERDTree is the only window left.
-autocmd BufEnter * if tabpagenr('$') == 1 && winnr('$') == 1 && exists('b:NERDTree') && b:NERDTree.isTabTree() |
-    \ quit | endif
+" Exit Vim if NERDTree is the only window remaining in the only tab.
+autocmd BufEnter * if tabpagenr('$') == 1 && winnr('$') == 1 && exists('b:NERDTree') && b:NERDTree.isTabTree() | quit | endif
+```
+---
+```vim
+" Close the tab if NERDTree is the only window remaining in it.
+autocmd BufEnter * if winnr('$') == 1 && exists('b:NERDTree') && b:NERDTree.isTabTree() | quit | endif
 ```
 
 ### How can I prevent other buffers replacing NERDTree in its window?
 
 ```vim
-" If another buffer tries to replace NERDTree, put in the other window, and bring back NERDTree.
+" If another buffer tries to replace NERDTree, put it in the other window, and bring back NERDTree.
 autocmd BufEnter * if bufname('#') =~ 'NERD_tree_\d\+' && bufname('%') !~ 'NERD_tree_\d\+' && winnr('$') > 1 |
     \ let buf=bufnr() | buffer# | execute "normal! \<C-W>w" | execute 'buffer'.buf | endif
 ```
@@ -168,7 +172,7 @@ autocmd BufEnter * if bufname('#') =~ 'NERD_tree_\d\+' && bufname('%') !~ 'NERD_
 
 ```vim
 " Open the existing NERDTree on each new tab.
-autocmd BufWinEnter * silent NERDTreeMirror
+autocmd BufWinEnter * if getcmdwintype() == '' | silent NERDTreeMirror | endif
 ```
 or change your NERDTree-launching shortcut key like so:
 ```vim
@@ -183,4 +187,3 @@ 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

@@ -30,12 +30,12 @@ endfunction
 " SECTION: General Functions {{{1
 "============================================================
 
-" FUNCTION: nerdtree#closeTreeOnOpen()
+" FUNCTION: nerdtree#closeTreeOnOpen() {{{2
 function! nerdtree#closeTreeOnOpen() abort
     return g:NERDTreeQuitOnOpen == 1 || g:NERDTreeQuitOnOpen == 3
 endfunction
 
-" FUNCTION: nerdtree#closeBookmarksOnOpen()
+" FUNCTION: nerdtree#closeBookmarksOnOpen() {{{2
 function! nerdtree#closeBookmarksOnOpen() abort
     return g:NERDTreeQuitOnOpen == 2 || g:NERDTreeQuitOnOpen == 3
 endfunction

autoload/nerdtree/ui_glue.vim

@@ -109,40 +109,16 @@ endfunction
 
 "FUNCTION: s:initCustomOpenArgs() {{{1
 function! s:initCustomOpenArgs() abort
-    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
+    let l:defaultOpenArgs = {'file': {'reuse': 'all', 'where': 'p', 'keepopen':!nerdtree#closeTreeOnOpen()}, 'dir': {}}
+    try
+        let g:NERDTreeCustomOpenArgs = get(g:, 'NERDTreeCustomOpenArgs', {})
+        call  extend(g:NERDTreeCustomOpenArgs, l:defaultOpenArgs, 'keep')
+    catch /^Vim(\a\+):E712:/
+        call nerdtree#echoWarning('g:NERDTreeCustomOpenArgs is not set properly. Using default value.')
+        let g:NERDTreeCustomOpenArgs = l:defaultOpenArgs
+    finally
+        return g:NERDTreeCustomOpenArgs
+    endtry
 endfunction
 
 "FUNCTION: s:activateAll() {{{1
@@ -397,7 +373,7 @@ function! s:handleLeftClick() abort
                 if currentNode.path.isDirectory
                     call currentNode.activate()
                 else
-                    call currentNode.activate({'reuse': 'all', 'where': 'p'})
+                    call currentNode.activate({'reuse': 'all', 'where': 'p', 'keepopen':!nerdtree#closeTreeOnOpen()})
                 endif
                 return
             endif
@@ -596,7 +572,11 @@ endfunction
 
 " FUNCTION: s:previewBookmark(bookmark) {{{1
 function! s:previewBookmark(bookmark) abort
-    call a:bookmark.activate(b:NERDTree, !a:bookmark.path.isDirectory ? {'stay': 1, 'where': 'p', 'keepopen': 1} : {})
+    if a:bookmark.path.isDirectory
+        execute 'NERDTreeFind '.a:bookmark.path.str()
+    else
+        call a:bookmark.activate(b:NERDTree, {'stay': 1, 'where': 'p', 'keepopen': 1})
+    endif
 endfunction
 
 "FUNCTION: s:previewNodeCurrent(node) {{{1

doc/NERDTree.txt

@@ -249,7 +249,7 @@ Key      Description                                                  help-tag~
 
 o........Open files, directories and bookmarks......................|NERDTree-o|
 go.......Open selected file, but leave cursor in the NERDTree......|NERDTree-go|
-         Open selected bookmark directory in current NERDTree
+         Find selected bookmark directory in current NERDTree
 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|
 i........Open selected file in a split window.......................|NERDTree-i|

lib/nerdtree/key_map.vim

@@ -66,11 +66,11 @@ endfunction
 "FUNCTION: KeyMap.invoke() {{{1
 "Call the KeyMaps callback function
 function! s:KeyMap.invoke(...)
-    let Callback = type(self.callback) ==# type(function('tr')) ? self.callback : function(self.callback)
+    let l:Callback = type(self.callback) ==# type(function('tr')) ? self.callback : function(self.callback)
     if a:0
-        call Callback(a:1)
+        call l:Callback(a:1)
     else
-        call Callback()
+        call l:Callback()
     endif
 endfunction
 

lib/nerdtree/notifier.vim

@@ -15,8 +15,8 @@ function! s:Notifier.NotifyListeners(event, path, nerdtree, params)
     let event = g:NERDTreeEvent.New(a:nerdtree, a:path, a:event, a:params)
 
     for Listener in s:Notifier.GetListenersForEvent(a:event)
-    	let Callback = type(Listener) == type(function('tr')) ? Listener : function(Listener)
-        call Callback(event)
+        let l:Callback = type(Listener) == type(function('tr')) ? Listener : function(Listener)
+        call l:Callback(event)
     endfor
 endfunction
 

lib/nerdtree/path.vim

@@ -459,9 +459,9 @@ function! s:Path.ignore(nerdtree)
             endif
         endfor
 
-        for Callback in g:NERDTree.PathFilters()
-            let Callback = type(Callback) ==# type(function('tr')) ? Callback : function(Callback)
-            if Callback({'path': self, 'nerdtree': a:nerdtree})
+        for l:Callback in g:NERDTree.PathFilters()
+            let l:Callback = type(l:Callback) ==# type(function('tr')) ? l:Callback : function(l:Callback)
+            if l:Callback({'path': self, 'nerdtree': a:nerdtree})
                return 1
             endif
         endfor