Improve lsp-define-conditional-key to include short description for whichkey (#2643)

Author: kiennq

lsp-mode.el

@@ -2218,27 +2218,34 @@ WORKSPACE is the workspace that contains the diagnostics."
 
 
 ;; keybindings
+(defvar lsp--binding-descriptions nil
+  "List of key binding/short description pair.")
 
-(defmacro lsp-define-conditional-key (keymap key def cond &rest bindings)
+(defmacro lsp-define-conditional-key (keymap key def desc cond &rest bindings)
   "In KEYMAP, define key sequence KEY as DEF conditionally.
 This is like `define-key', except the definition disappears
 whenever COND evaluates to nil.
-BINDINGS is a list of (key def cond)."
+DESC is the short-description for the binding.
+BINDINGS is a list of (key def desc cond)."
   (declare (indent defun)
-           (debug (form form form form &rest sexp)))
-  (->> (cl-list* key def cond bindings)
-       (-partition 3)
-       (-map (-lambda ((key def cond))
-               `(define-key ,keymap ,key
-                  '(menu-item
-                    ,(format "maybe-%s" def)
-                    ,def
-                    :filter (lambda (item)
-                              (when (with-current-buffer (or (when (buffer-live-p lsp--describe-buffer)
-                                                               lsp--describe-buffer)
-                                                             (current-buffer))
-                                      ,cond)
-                                item))))))
+           (debug (form form form form form &rest sexp)))
+  (->> (cl-list* key def desc cond bindings)
+       (-partition 4)
+       (-mapcat (-lambda ((key def desc cond))
+                  `((define-key ,keymap ,key
+                      '(menu-item
+                        ,(format "maybe-%s" def)
+                        ,def
+                        :filter
+                        (lambda (item)
+                          (when (with-current-buffer (or (when (buffer-live-p lsp--describe-buffer)
+                                                           lsp--describe-buffer)
+                                                         (current-buffer))
+                                  ,cond)
+                            item))))
+                    (when (stringp ,key)
+                      (setq lsp--binding-descriptions
+                            (nconc lsp--binding-descriptions '(,key ,desc)))))))
        macroexp-progn))
 
 (defvar lsp--describe-buffer nil)
@@ -2261,70 +2268,76 @@ BINDINGS is a list of (key def cond)."
   (-doto (make-sparse-keymap)
     (lsp-define-conditional-key
       ;; sessions
-      "sr" lsp-workspace-restart (lsp-workspaces)
-      "ss" lsp t
-      "sq" lsp-workspace-shutdown (lsp-workspaces)
-      "sd" lsp-describe-session t
-      "sD" lsp-disconnect (lsp-workspaces)
+      "sD" lsp-disconnect "disconnect" (lsp-workspaces)
+      "sd" lsp-describe-session "describe session" t
+      "sq" lsp-workspace-shutdown "shutdown server" (lsp-workspaces)
+      "sr" lsp-workspace-restart "restart server" (lsp-workspaces)
+      "ss" lsp "start server" t
 
       ;; formatting
-      "==" lsp-format-buffer (or (lsp-feature? "textDocument/rangeFormatting")
-                                 (lsp-feature? "textDocument/formatting"))
-      "=r" lsp-format-region (lsp-feature? "textDocument/rangeFormatting")
+      "==" lsp-format-buffer "format buffer" (or (lsp-feature? "textDocument/rangeFormatting")
+                                                 (lsp-feature? "textDocument/formatting"))
+      "=r" lsp-format-region "format region" (lsp-feature? "textDocument/rangeFormatting")
 
       ;; folders
-      "Fa" lsp-workspace-folders-add t
-      "Fr" lsp-workspace-folders-remove t
-      "Fb" lsp-workspace-blacklist-remove t
+      "Fa" lsp-workspace-folders-add "add folder" t
+      "Fb" lsp-workspace-blacklist-remove "un-blacklist folder" t
+      "Fr" lsp-workspace-folders-remove "remove folder" t
 
       ;; toggles
-      "Tl" lsp-lens-mode (lsp-feature? "textDocument/codeLens")
-      "TL" lsp-toggle-trace-io t
-      "Th" lsp-toggle-symbol-highlight (lsp-feature? "textDocument/documentHighlight")
-      "Tb" lsp-headerline-breadcrumb-mode (lsp-feature? "textDocument/documentSymbol")
-      "Ta" lsp-modeline-code-actions-mode (lsp-feature? "textDocument/codeAction")
-      "TD" lsp-modeline-diagnostics-mode (lsp-feature? "textDocument/publishDiagnostics")
-      "TS" lsp-ui-sideline-mode (featurep 'lsp-ui-sideline)
-      "Td" lsp-ui-doc-mode (featurep 'lsp-ui-doc)
-      "Ts" lsp-toggle-signature-auto-activate (lsp-feature? "textDocument/signatureHelp")
-      "Tf" lsp-toggle-on-type-formatting (lsp-feature? "textDocument/onTypeFormatting")
-      "TT" lsp-treemacs-sync-mode (featurep 'lsp-treemacs)
+      "TD" lsp-modeline-diagnostics-mode "toggle modeline diagnostics" (lsp-feature?
+                                                                        "textDocument/publishDiagnostics")
+      "TL" lsp-toggle-trace-io "toggle log io" t
+      "TS" lsp-ui-sideline-mode "toggle sideline" (featurep 'lsp-ui-sideline)
+      "TT" lsp-treemacs-sync-mode "toggle treemacs integration" (featurep 'lsp-treemacs)
+      "Ta" lsp-modeline-code-actions-mode "toggle modeline code actions" (lsp-feature?
+                                                                          "textDocument/codeAction")
+      "Tb" lsp-headerline-breadcrumb-mode "toggle breadcrumb" (lsp-feature?
+                                                               "textDocument/documentSymbol")
+      "Td" lsp-ui-doc-mode "toggle documentation popup" (featurep 'lsp-ui-doc)
+      "Tf" lsp-toggle-on-type-formatting "toggle on type formatting" (lsp-feature?
+                                                                      "textDocument/onTypeFormatting")
+      "Th" lsp-toggle-symbol-highlight "toggle highlighting" (lsp-feature? "textDocument/documentHighlight")
+      "Tl" lsp-lens-mode "toggle lenses" (lsp-feature? "textDocument/codeLens")
+      "Ts" lsp-toggle-signature-auto-activate "toggle signature" (lsp-feature? "textDocument/signatureHelp")
 
       ;; goto
-      "gg" lsp-find-definition (lsp-feature? "textDocument/definition")
-      "gr" lsp-find-references (lsp-feature? "textDocument/references")
-      "gi" lsp-find-implementation (lsp-feature? "textDocument/implementation")
-      "gt" lsp-find-type-definition (lsp-feature? "textDocument/typeDefinition")
-      "gd" lsp-find-declaration (lsp-feature? "textDocument/declaration")
-      "gh" lsp-treemacs-call-hierarchy (and (lsp-feature? "callHierarchy/incomingCalls")
-                                            (fboundp 'lsp-treemacs-call-hierarchy))
-      "ga" xref-find-apropos (lsp-feature? "workspace/symbol")
-      "ge" lsp-treemacs-errors-list (fboundp 'lsp-treemacs-errors-list)
+      "ga" xref-find-apropos "find symbol in workspace" (lsp-feature? "workspace/symbol")
+      "gd" lsp-find-declaration "find declarations" (lsp-feature? "textDocument/declaration")
+      "ge" lsp-treemacs-errors-list "show errors" (fboundp 'lsp-treemacs-errors-list)
+      "gg" lsp-find-definition "find definitions" (lsp-feature? "textDocument/definition")
+      "gh" lsp-treemacs-call-hierarchy "call hierarchy" (and (lsp-feature? "callHierarchy/incomingCalls")
+                                                             (fboundp 'lsp-treemacs-call-hierarchy))
+      "gi" lsp-find-implementation "find implementations" (lsp-feature? "textDocument/implementation")
+      "gr" lsp-find-references "find references" (lsp-feature? "textDocument/references")
+      "gt" lsp-find-type-definition "find type definition" (lsp-feature? "textDocument/typeDefinition")
 
       ;; help
-      "hh" lsp-describe-thing-at-point (lsp-feature? "textDocument/hover")
-      "hs" lsp-signature-activate (lsp-feature? "textDocument/signatureHelp")
-      "hg" lsp-ui-doc-glance (and (featurep 'lsp-ui-doc)
-                                  (lsp-feature? "textDocument/hover"))
+      "hg" lsp-ui-doc-glance "glance symbol" (and (featurep 'lsp-ui-doc)
+                                                  (lsp-feature? "textDocument/hover"))
+      "hh" lsp-describe-thing-at-point "describe symbol at point" (lsp-feature? "textDocument/hover")
+      "hs" lsp-signature-activate "signature help" (lsp-feature? "textDocument/signatureHelp")
 
       ;; refactoring
-      "rr" lsp-rename (lsp-feature? "textDocument/rename")
-      "ro" lsp-organize-imports (lsp-feature? "textDocument/codeAction")
+      "ro" lsp-organize-imports "organize imports" (lsp-feature? "textDocument/codeAction")
+      "rr" lsp-rename "rename" (lsp-feature? "textDocument/rename")
 
       ;; actions
-      "aa" lsp-execute-code-action (lsp-feature? "textDocument/codeAction")
-      "al" lsp-avy-lens (and (bound-and-true-p lsp-lens-mode) (featurep 'avy))
-      "ah" lsp-document-highlight (lsp-feature? "textDocument/documentHighlight")
+      "aa" lsp-execute-code-action "code actions" (lsp-feature? "textDocument/codeAction")
+      "ah" lsp-document-highlight "highlight symbol" (lsp-feature? "textDocument/documentHighlight")
+      "al" lsp-avy-lens "lens" (and (bound-and-true-p lsp-lens-mode) (featurep 'avy))
 
       ;; peeks
-      "Gg" lsp-ui-peek-find-definitions (and (lsp-feature? "textDocument/definition")
-                                             (fboundp 'lsp-ui-peek-find-definitions))
-      "Gr" lsp-ui-peek-find-references (and (fboundp 'lsp-ui-peek-find-references)
-                                            (lsp-feature? "textDocument/references"))
-      "Gi" lsp-ui-peek-find-implementation (and (fboundp 'lsp-ui-peek-find-implementation)
-                                                (lsp-feature? "textDocument/implementation"))
-      "Gs" lsp-ui-peek-find-workspace-symbol (and (fboundp 'lsp-ui-peek-find-workspace-symbol)
-                                                  (lsp-feature? "workspace/symbol")))))
+      "Gg" lsp-ui-peek-find-definitions "peek definitions" (and (lsp-feature? "textDocument/definition")
+                                                                (fboundp 'lsp-ui-peek-find-definitions))
+      "Gi" lsp-ui-peek-find-implementation "peek implementations" (and
+                                                                   (fboundp 'lsp-ui-peek-find-implementation)
+                                                                   (lsp-feature? "textDocument/implementation"))
+      "Gr" lsp-ui-peek-find-references "peek references" (and (fboundp 'lsp-ui-peek-find-references)
+                                                              (lsp-feature? "textDocument/references"))
+      "Gs" lsp-ui-peek-find-workspace-symbol "peek workspace symbol" (and (fboundp
+                                                                           'lsp-ui-peek-find-workspace-symbol)
+                                                                          (lsp-feature? "workspace/symbol")))))
 
 
 ;; which-key integration
@@ -2341,65 +2354,18 @@ active `major-mode', or for all major modes when ALL-MODES is t."
     (apply
      #'which-key-fn
      (lsp--prepend-prefix
-      (list
-       ""    "lsp"
-       "s"   "sessions"
-       "s s" "start server"
-       "s r" "restart server"
-       "s q" "shutdown server"
-       "s d" "describe session"
-       "s D" "disconnect"
-
-       "F"   "folders"
-       "F a" "add folder"
-       "F r" "remove folder"
-       "F b" "un-blacklist folder"
-
-       "="   "formatting"
-       "= r" "format region"
-       "= =" "format buffer"
-
-       "T"   "toggle"
-       "T l" "toggle lenses"
-       "T h" "toggle highlighting"
-       "T L" "toggle log io"
-       "T s" "toggle signature"
-       "T a" "toggle modeline code actions"
-       "T S" "toggle sideline"
-       "T d" "toggle documentation popup"
-       "T p" "toggle signature help"
-       "T f" "toggle on type formatting"
-       "T T" "toggle treemacs integration"
-
-       "g"   "goto"
-       "g g" "find definitions"
-       "g r" "find references"
-       "g i" "find implementations"
-       "g d" "find declarations"
-       "g t" "find type definition"
-       "g h" "call hierarchy"
-       "g a" "find symbol in workspace"
-       "g A" "find symbol in all workspaces"
-       "g e" "show errors"
-
-       "h"   "help"
-       "h h" "describe symbol at point"
-       "h s" "signature help"
-
-       "r"   "refactor"
-       "r r" "rename"
-       "r o" "organize imports"
-
-       "a"   "code actions"
-       "a a" "code actions"
-       "a l" "lens"
-       "a h" "highlight symbol"
-
-       "G"   "peek"
-       "G g" "peek definitions"
-       "G r" "peek references"
-       "G i" "peek implementations"
-       "G s" "peek workspace symbol")))))
+      (nconc
+       '(""    "lsp"
+         "s"   "sessions"
+         "F"   "folders"
+         "="   "formatting"
+         "T"   "toggle"
+         "g"   "goto"
+         "h"   "help"
+         "r"   "refactor"
+         "a"   "code actions"
+         "G"   "peek")
+       lsp--binding-descriptions)))))
 
 
 ;; Globbing syntax