[DONE] Make better use of Eglot's mode-line

[nemethf]

In a similar vein to #784, Eglot could make better use of its mode-line especially because it doesn't have a menu. However, all I can think of is adding links to the documentation and the main customization group. WDYT?

index 922b922..6b33e08 100644
--- a/eglot.el
+++ b/eglot.el
@@ -1690,6 +1690,19 @@ Uses THING, FACE, DEFS and PREPEND."
                                          keymap ,map help-echo ,(concat prepend blurb)
                                          mouse-face mode-line-highlight))))
 
+(defun eglot--find-documentation ()
+  "Show EGLOT's documenation to the user."
+  (interactive)
+  (let ((readme (expand-file-name "README.md"
+                                  (file-name-directory
+                                   (find-lisp-object-file-name 'eglot "def")))))
+    (if (file-readable-p readme)
+        ;; Local documentation is prefered as it coresponds to the
+        ;; installed version.  However, the website can show animgifs.
+        ;; Also, README.md is hard to read without markdown-mode.
+        (find-file readme)
+      (browse-url "https://github.com/joaotavora/eglot#readme"))))
+
 (defun eglot--mode-line-format ()
   "Compose the EGLOT's mode-line."
   (pcase-let* ((server (eglot-current-server))
@@ -1699,7 +1712,15 @@ Uses THING, FACE, DEFS and PREPEND."
                (`(,_id ,doing ,done-p ,_detail) (and server (eglot--spinner server)))
                (last-error (and server (jsonrpc-last-error server))))
     (append
-     `(,(eglot--mode-line-props "eglot" 'eglot-mode-line nil))
+     `(,(eglot--mode-line-props
+         "eglot" 'eglot-mode-line
+         '((mouse-1 eglot--find-documentation  "read the documentation")
+           (C-mouse-1 (lambda ()
+                        (interactive)
+                        (customize-group "eglot"))
+                      "customize Eglot"))
+         "Eglot: an LSP client\n"))
      (when nick
        `(":" ,(eglot--mode-line-props
                nick 'eglot-mode-line

[joaotavora]

I think this is a good idea, and eglot--find-documentation could be a command without the --

[joaotavora]

Also if youre going to use lambdas, use lambdas for both. If named functions, use named functions for both.

[skangas]

Yup, this is a good idea. I'd suggest opening a PR to track this work. Thanks!

[nemethf]

commit d28170b fixes this.