feat: jump to bookmark table shortcut. (#1394)

Co-authored-by: Daniel Schreck <daniel.s.schreck@gmail.com>
preservim · May 13, 2024 · 6ad85ec · 6ad85ec
1 parent f3a4d8e
commit 6ad85ec
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 4 deletions.
diff --git a/autoload/nerdtree/ui_glue.vim b/autoload/nerdtree/ui_glue.vim
@@ -70,6 +70,7 @@ function! nerdtree#ui_glue#createDefaultBindings() abort
     call NERDTreeAddKeyMap({ 'key': g:NERDTreeMapJumpRoot, 'scope': 'all', 'callback': s.'jumpToRoot' })
     call NERDTreeAddKeyMap({ 'key': g:NERDTreeMapJumpNextSibling, 'scope': 'Node', 'callback': s.'jumpToNextSibling' })
     call NERDTreeAddKeyMap({ 'key': g:NERDTreeMapJumpPrevSibling, 'scope': 'Node', 'callback': s.'jumpToPrevSibling' })
+    call NERDTreeAddKeyMap({ 'key': g:NERDTreeMapJumpBookmarks, 'scope': 'all', 'callback': s.'jumpToBookmarks' })
 
     call NERDTreeAddKeyMap({ 'key': g:NERDTreeMapOpenInTab, 'scope': 'Node', 'callback': s . 'openInNewTab' })
     call NERDTreeAddKeyMap({ 'key': g:NERDTreeMapOpenInTabSilent, 'scope': 'Node', 'callback': s . 'openInNewTabSilent' })
@@ -496,6 +497,21 @@ function! s:jumpToSibling(node, forward) abort
     call b:NERDTree.ui.centerView()
 endfunction
 
+" FUNCTION: s:jumpToBookmarks() {{{1
+" moves the cursor to the bookmark table
+function! s:jumpToBookmarks() abort
+    try
+        if b:NERDTree.ui.getShowBookmarks()
+            call g:NERDTree.CursorToBookmarkTable()
+        else
+            call b:NERDTree.ui.setShowBookmarks(1)
+        endif
+    catch /^NERDTree/
+        call nerdtree#echoError('Failed to jump to the bookmark table')
+        return
+    endtry
+endfunction
+
 " FUNCTION: nerdtree#ui_glue#openBookmark(name) {{{1
 " Open the Bookmark that has the specified name. This function provides the
 " implementation for the :OpenBookmark command.

diff --git a/lib/nerdtree/ui.vim b/lib/nerdtree/ui.vim
@@ -62,6 +62,7 @@ function! s:UI._dumpHelp()
         let help .= "\"\n\" ----------------------------\n"
         let help .= "\" Bookmark table mappings~\n"
         let help .= "\" double-click,\n"
+        let help .= '" '. g:NERDTreeMapJumpBookmarks .": jump to bookmark table\n"
         let help .= '" '. g:NERDTreeMapActivateNode .": open bookmark\n"
         let help .= '" '. g:NERDTreeMapPreview .": preview file\n"
         let help .= '" '. g:NERDTreeMapPreview .": find dir in tree\n"
@@ -482,10 +483,10 @@ function! s:UI.toggleIgnoreFilter()
     call self.centerView()
 endfunction
 
-" FUNCTION: s:UI.toggleShowBookmarks() {{{1
-" Toggle the visibility of the Bookmark table.
-function! s:UI.toggleShowBookmarks()
-    let self._showBookmarks = !self._showBookmarks
+" FUNCTION: s:UI.setShowBookmarks() {{{1
+" Sets the visibility of the Bookmark table.
+function! s:UI.setShowBookmarks(value)
+    let self._showBookmarks = a:value
 
     if self.getShowBookmarks()
         call self.nerdtree.render()
@@ -503,6 +504,12 @@ function! s:UI.toggleShowBookmarks()
     call self.centerView()
 endfunction
 
+" FUNCTION: s:UI.toggleShowBookmarks() {{{1
+" Toggle the visibility of the Bookmark table.
+function! s:UI.toggleShowBookmarks()
+    call self.setShowBookmarks(!self._showBookmarks)
+endfunction
+
 " FUNCTION: s:UI.toggleShowFiles() {{{1
 " toggles the display of hidden files
 function! s:UI.toggleShowFiles()

diff --git a/plugin/NERD_tree.vim b/plugin/NERD_tree.vim
@@ -101,6 +101,7 @@ endif
 
 "SECTION: Init variable calls for key mappings {{{2
 let g:NERDTreeMapCustomOpen      = get(g:, 'NERDTreeMapCustomOpen',      '<CR>')
+let g:NERDTreeMapJumpBookmarks   = get(g:, 'NERDTreeMapJumpBookmarks',   'gb')
 let g:NERDTreeMapActivateNode    = get(g:, 'NERDTreeMapActivateNode',    'o')
 let g:NERDTreeMapChangeRoot      = get(g:, 'NERDTreeMapChangeRoot',      'C')
 let g:NERDTreeMapChdir           = get(g:, 'NERDTreeMapChdir',           'cd')