bug#60379: [PATCH] Eglot: don't use "nil" as minibuffer initial input

bug#60379: [PATCH] Eglot: don't use "nil" as minibuffer initial input

[Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 1004 bytes --]

Tags: patch

Hello,

Currently, doing emacs -Q and followed by M-x eglot in the scratch
buffer results in a prompt for major mode to manage with LSP, but the
initial minibuffer input as well as the default value for the
completing-read call are both set to the string "nil", which is not very
helpful as that's not a valid input.

This patch tweaks the prompt a little and avoids this issue by leaving
the minibuffer's initial input empty and making sure we don't set the
default value to "nil" either.

Thanks,
Eshel

In GNU Emacs 30.0.50 (build 19, x86_64-apple-darwin22.1.0, NS
 appkit-2299.00 Version 13.0 (Build 22A380)) of 2022-12-26 built on
 esmac
Repository revision: cc29fab3a66c59e77d0ff67c0f3e2e34ec80a03c
Repository branch: master
Windowing system distributor 'Apple', version 10.3.2299
System Description:  macOS 13.0

Configured using:
 'configure --with-native-compilation --enable-link-time-optimization
 --with-json --with-xwidgets --with-mailutils --with-imagemagick
 --without-dbus'


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Eglot-don-t-use-nil-as-minibuffer-initial-input.patch --]
[-- Type: text/patch, Size: 1915 bytes --]

From 66d17efabaca0f3d08b78529c8d64fc65dc799e2 Mon Sep 17 00:00:00 2001
From: Eshel Yaron <me@eshelyaron.com>
Date: Wed, 28 Dec 2022 13:59:53 +0200
Subject: [PATCH] Eglot: don't use "nil" as minibuffer initial input

Doing M-x eglot in a buffer for which buffer-file-name is nil, prompts
the user for a major mode to manage by invoking completing-read.  The
way completing-read was called would end up with the string "nil" as
the initial minibuffer input, which is not very useful nor is it a
valid input.

* lisp/progmodes/eglot.el (eglot--guess-contact): tweak prompt for
major mode.
---
 lisp/progmodes/eglot.el | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index 15cb1b6fad..57f9be718f 100644
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -991,6 +991,7 @@ eglot--guess-contact
 non-nil, maybe prompt user, else error as soon as something can't
 be guessed."
   (let* ((guessed-mode (if buffer-file-name major-mode))
+         (guessed-mode-name (and guessed-mode (symbol-name guessed-mode)))
          (main-mode
           (cond
            ((and interactive
@@ -998,9 +999,10 @@ eglot--guess-contact
                      (not guessed-mode)))
             (intern
              (completing-read
-              "[eglot] Start a server to manage buffers of what major mode? "
-              (mapcar #'symbol-name (eglot--all-major-modes)) nil t
-              (symbol-name guessed-mode) nil (symbol-name guessed-mode) nil)))
+              (format-prompt "Start LSP server for major mode"
+                             guessed-mode-name)
+              (mapcar #'symbol-name (eglot--all-major-modes))
+              nil t nil nil guessed-mode-name nil)))
            ((not guessed-mode)
             (eglot--error "Can't guess mode to manage for `%s'" (current-buffer)))
            (t guessed-mode)))
-- 
2.38.1

bug#60379: [PATCH] Eglot: don't use "nil" as minibuffer initial input

[Eli Zaretskii]

> Date: Wed, 28 Dec 2022 14:22:17 +0200
> From:  Eshel Yaron via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> Currently, doing emacs -Q and followed by M-x eglot in the scratch
> buffer results in a prompt for major mode to manage with LSP, but the
> initial minibuffer input as well as the default value for the
> completing-read call are both set to the string "nil", which is not very
> helpful as that's not a valid input.
> 
> This patch tweaks the prompt a little and avoids this issue by leaving
> the minibuffer's initial input empty and making sure we don't set the
> default value to "nil" either.

João, are you looking into this?  WDYT?

bug#60379: [PATCH] Eglot: don't use "nil" as minibuffer initial input

[João Távora]

Eli Zaretskii <eliz@gnu.org> writes:

>> Date: Wed, 28 Dec 2022 14:22:17 +0200
>> From:  Eshel Yaron via "Bug reports for GNU Emacs,
>>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>> 
>> Currently, doing emacs -Q and followed by M-x eglot in the scratch
>> buffer results in a prompt for major mode to manage with LSP, but the
>> initial minibuffer input as well as the default value for the
>> completing-read call are both set to the string "nil", which is not very
>> helpful as that's not a valid input.
>> 
>> This patch tweaks the prompt a little and avoids this issue by leaving
>> the minibuffer's initial input empty and making sure we don't set the
>> default value to "nil" either.
>
> João, are you looking into this?  WDYT?

No, I wasn't until now.

The idea looks sane, but I think 'format-prompt' can't be used if Eglot
is to continue supporting Emacs 26 and 27.  Also I'd prefer if the patch
is slightly less disruptive to whitespace, like this:

diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index 15cb1b6fad..eb3b51ed8b 100644
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -991,6 +991,7 @@ eglot--guess-contact
 non-nil, maybe prompt user, else error as soon as something can't
 be guessed."
   (let* ((guessed-mode (if buffer-file-name major-mode))
+         (guessed-mode-name (and guessed-mode (symbol-name guessed-mode)))
          (main-mode
           (cond
            ((and interactive
@@ -1000,7 +1001,7 @@ eglot--guess-contact
              (completing-read
               "[eglot] Start a server to manage buffers of what major mode? "
               (mapcar #'symbol-name (eglot--all-major-modes)) nil t
-              (symbol-name guessed-mode) nil (symbol-name guessed-mode) nil)))
+              guessed-mode-name nil guessed-mode-name nil)))
            ((not guessed-mode)
             (eglot--error "Can't guess mode to manage for `%s'" (current-buffer)))
            (t guessed-mode)))

Other than that, it's fine to commit.

João

bug#60379: [PATCH] Eglot: don't use "nil" as minibuffer initial input

[Eli Zaretskii]

> From: João Távora <joaotavora@gmail.com>
> Cc: Eshel Yaron <me@eshelyaron.com>,  60379@debbugs.gnu.org
> Date: Thu, 12 Jan 2023 10:20:27 +0000
> 
> The idea looks sane, but I think 'format-prompt' can't be used if Eglot
> is to continue supporting Emacs 26 and 27.  Also I'd prefer if the patch
> is slightly less disruptive to whitespace, like this:
> 
> diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
> index 15cb1b6fad..eb3b51ed8b 100644
> --- a/lisp/progmodes/eglot.el
> +++ b/lisp/progmodes/eglot.el
> @@ -991,6 +991,7 @@ eglot--guess-contact
>  non-nil, maybe prompt user, else error as soon as something can't
>  be guessed."
>    (let* ((guessed-mode (if buffer-file-name major-mode))
> +         (guessed-mode-name (and guessed-mode (symbol-name guessed-mode)))
>           (main-mode
>            (cond
>             ((and interactive
> @@ -1000,7 +1001,7 @@ eglot--guess-contact
>               (completing-read
>                "[eglot] Start a server to manage buffers of what major mode? "
>                (mapcar #'symbol-name (eglot--all-major-modes)) nil t
> -              (symbol-name guessed-mode) nil (symbol-name guessed-mode) nil)))
> +              guessed-mode-name nil guessed-mode-name nil)))
>             ((not guessed-mode)
>              (eglot--error "Can't guess mode to manage for `%s'" (current-buffer)))
>             (t guessed-mode)))
> 
> Other than that, it's fine to commit.

OK, done, and closing the bug.

Yaron, this change was small enough to accept without copyright
assignment, but if you intend to continue contributing to Emacs (and
we hope you do), I recommend to start your copyright assignment
paperwork rolling at this time.  If you agree, I will send you the
form to fill and the instructions to email it.

Thanks.

bug#60379: [PATCH] Eglot: don't use "nil" as minibuffer initial input

[Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: João Távora <joaotavora@gmail.com>
>> Cc: Eshel Yaron <me@eshelyaron.com>,  60379@debbugs.gnu.org
>> Date: Thu, 12 Jan 2023 10:20:27 +0000
>> 
>> The idea looks sane, but I think 'format-prompt' can't be used if Eglot
>> is to continue supporting Emacs 26 and 27.  Also I'd prefer if the patch
>> is slightly less disruptive to whitespace, like this:
>> 
>> diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
>> index 15cb1b6fad..eb3b51ed8b 100644
>> --- a/lisp/progmodes/eglot.el
>> +++ b/lisp/progmodes/eglot.el
>> @@ -991,6 +991,7 @@ eglot--guess-contact
>>  non-nil, maybe prompt user, else error as soon as something can't
>>  be guessed."
>>    (let* ((guessed-mode (if buffer-file-name major-mode))
>> +         (guessed-mode-name (and guessed-mode (symbol-name guessed-mode)))
>>           (main-mode
>>            (cond
>>             ((and interactive
>> @@ -1000,7 +1001,7 @@ eglot--guess-contact
>>               (completing-read
>>                "[eglot] Start a server to manage buffers of what major mode? "
>>                (mapcar #'symbol-name (eglot--all-major-modes)) nil t
>> -              (symbol-name guessed-mode) nil (symbol-name guessed-mode) nil)))
>> +              guessed-mode-name nil guessed-mode-name nil)))
>>             ((not guessed-mode)
>>              (eglot--error "Can't guess mode to manage for `%s'" (current-buffer)))
>>             (t guessed-mode)))
>> 
>> Other than that, it's fine to commit.
>
> OK, done, and closing the bug.

Hello João and Eli,

Thanks for looking into it and applying the patch.

> Yaron, this change was small enough to accept without copyright
> assignment, but if you intend to continue contributing to Emacs (and
> we hope you do), I recommend to start your copyright assignment
> paperwork rolling at this time.  If you agree, I will send you the
> form to fill and the instructions to email it.

Alright, please send it over.


Eshel

bug#60379: [PATCH] Eglot: don't use "nil" as minibuffer initial input

[Eli Zaretskii]

> From: Eshel Yaron <me@eshelyaron.com>
> Cc: João Távora <joaotavora@gmail.com>,
>   60379-done@debbugs.gnu.org
> Date: Sat, 14 Jan 2023 11:33:27 +0200
> 
> > Yaron, this change was small enough to accept without copyright
> > assignment, but if you intend to continue contributing to Emacs (and
> > we hope you do), I recommend to start your copyright assignment
> > paperwork rolling at this time.  If you agree, I will send you the
> > form to fill and the instructions to email it.
> 
> Alright, please send it over.

Form sent off-list.