commit de0e2edeac61039d8c9fb01a43b0305baad0a28b
parent 81f3eaba295b3fceb2d032db57e5eae99ae480f8
Author: Phil Runninger <PhilRunninger@users.noreply.github.com>
Date: Tue, 13 Jul 2021 14:28:29 -0400
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.
Diffstat:
4 files changed, 45 insertions(+), 50 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.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.
-
-#### 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
- - [ ] Others (specify):
- - [ ] I've verified the issue occurs with only NERDTree installed.
+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
+- 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):
+- 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
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.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
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,10 +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)
+- **.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)
diff --git a/README.markdown b/README.markdown
@@ -148,12 +148,16 @@ 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?
@@ -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
