bug#66551: [PATCH] Add completion for Unix 'doas' command.

bug#66551: [PATCH] Add completion for Unix 'doas' command.

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

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

The attached patch adds a pcomplete procedure for doas, so shell/eshell
will do command completion correctly.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-completion-for-Unix-doas-command.patch --]
[-- Type: text/x-patch, Size: 1544 bytes --]

From df385c3055a23894ecde5943ffb249f94526523d Mon Sep 17 00:00:00 2001
From: Antero Mejr <antero@mailbox.org>
Date: Sun, 15 Oct 2023 00:32:57 +0000
Subject: [PATCH] Add completion for Unix 'doas' command.

* lisp/pcmpl-unix.el (pcomplete/doas): New procedure.
* etc/NEWS: Announce.
---
 etc/NEWS           | 4 ++++
 lisp/pcmpl-unix.el | 8 ++++++++
 2 files changed, 12 insertions(+)

diff --git a/etc/NEWS b/etc/NEWS
index 3bd47a0112b..d73ec031d85 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -477,6 +477,10 @@ When this option is non-nil, remote file names are not completed by
 Pcomplete.  Packages, like 'shell-mode', could set this in order to
 suppress remote file name completion at all.
 
+---
+*** Completions for the Unix 'doas' command are now provided.
+Command completion for 'doas' in Eshell and Shell mode will now work.
+
 ** Shell Mode
 
 +++
diff --git a/lisp/pcmpl-unix.el b/lisp/pcmpl-unix.el
index e6b67256a4c..ac8b71c0030 100644
--- a/lisp/pcmpl-unix.el
+++ b/lisp/pcmpl-unix.el
@@ -685,6 +685,14 @@ Includes files as well as host names followed by a colon."
   (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
 	       pcomplete-default-completion-function)))
 
+;;;###autoload
+(defun pcomplete/doas ()
+  "Completion for the `doas' command."
+  (pcomplete-opt "su")
+  (funcall pcomplete-command-completion-function)
+  (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
+	       pcomplete-default-completion-function)))
+
 (provide 'pcmpl-unix)
 
 ;;; pcmpl-unix.el ends here
-- 
2.41.0

bug#66551: [PATCH] Add completion for Unix 'doas' command.

[Stefan Kangas]

Antero Mejr via "Bug reports for GNU Emacs, the Swiss army knife of text
editors" <bug-gnu-emacs@gnu.org> writes:

> The attached patch adds a pcomplete procedure for doas, so shell/eshell
> will do command completion correctly.

Thanks, this is a useful addition.

> +;;;###autoload
> +(defun pcomplete/doas ()
> +  "Completion for the `doas' command."
> +  (pcomplete-opt "su")

Are there any other options that are worth adding?

    https://man.openbsd.org/doas

> +  (funcall pcomplete-command-completion-function)
> +  (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
> +	       pcomplete-default-completion-function)))
> +
>  (provide 'pcmpl-unix)
>
>  ;;; pcmpl-unix.el ends here
> --
> 2.41.0

bug#66551: [PATCH] Add completion for Unix 'doas' command.

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

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

Stefan Kangas <stefankangas@gmail.com> writes:

>> +;;;###autoload
>> +(defun pcomplete/doas ()
>> +  "Completion for the `doas' command."
>> +  (pcomplete-opt "su")
>
> Are there any other options that are worth adding?
>
>     https://man.openbsd.org/doas
>

The options "su" are the flags shared across BSD, Linux, and
eshell-builtin versions of doas. The revised patch (attached) has all
flags from the BSD version, but will provide completions for invalid
flags for Linux and eshell doas.

BSD and Linux doas doesn't have a -h/--help flag, so I don't think we
can get the flags using pcomplete-from-help unfortunately.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-completion-for-Unix-doas-command.patch --]
[-- Type: text/x-patch, Size: 1561 bytes --]

From 2519752ca39cfe8786a65dd3caca98a689b24777 Mon Sep 17 00:00:00 2001
From: Antero Mejr <antero@mailbox.org>
Date: Sun, 15 Oct 2023 00:32:57 +0000
Subject: [PATCH] Add completion for Unix 'doas' command.

* lisp/pcmpl-unix.el (pcomplete/doas): New procedure.
* etc/NEWS: Announce.  (Bug#66551)
---
 etc/NEWS           | 4 ++++
 lisp/pcmpl-unix.el | 8 ++++++++
 2 files changed, 12 insertions(+)

diff --git a/etc/NEWS b/etc/NEWS
index 3bd47a0112b..d73ec031d85 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -477,6 +477,10 @@ When this option is non-nil, remote file names are not completed by
 Pcomplete.  Packages, like 'shell-mode', could set this in order to
 suppress remote file name completion at all.
 
+---
+*** Completions for the Unix 'doas' command are now provided.
+Command completion for 'doas' in Eshell and Shell mode will now work.
+
 ** Shell Mode
 
 +++
diff --git a/lisp/pcmpl-unix.el b/lisp/pcmpl-unix.el
index e6b67256a4c..15462637df1 100644
--- a/lisp/pcmpl-unix.el
+++ b/lisp/pcmpl-unix.el
@@ -685,6 +685,14 @@ Includes files as well as host names followed by a colon."
   (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
 	       pcomplete-default-completion-function)))
 
+;;;###autoload
+(defun pcomplete/doas ()
+  "Completion for the `doas' command."
+  (pcomplete-opt "aCLnsu")
+  (funcall pcomplete-command-completion-function)
+  (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
+	       pcomplete-default-completion-function)))
+
 (provide 'pcmpl-unix)
 
 ;;; pcmpl-unix.el ends here
-- 
2.41.0

bug#66551: [PATCH] Add completion for Unix 'doas' command.

[Stefan Kangas]

Antero Mejr <antero@mailbox.org> writes:

> The options "su" are the flags shared across BSD, Linux, and
> eshell-builtin versions of doas. The revised patch (attached) has all
> flags from the BSD version, but will provide completions for invalid
> flags for Linux and eshell doas.

I believe it might be better to align with the flags available on
GNU/Linux, then.  Especially considering our larger GNU/Linux user base
compared to BSD.

It's less cumbersome for users to manually add a missing flag than for
pcomplete to suggest an incorrect one.

> BSD and Linux doas doesn't have a -h/--help flag, so I don't think we
> can get the flags using pcomplete-from-help unfortunately.

Thank you for pointing that out.  Noted.

bug#66551: [PATCH] Add completion for Unix 'doas' command.

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

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

Stefan Kangas <stefankangas@gmail.com> writes:

> I believe it might be better to align with the flags available on
> GNU/Linux, then.  Especially considering our larger GNU/Linux user base
> compared to BSD.
>
> It's less cumbersome for users to manually add a missing flag than for
> pcomplete to suggest an incorrect one.

Sounds good, patch with Linux flags is below.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-completion-for-Unix-doas-command.patch --]
[-- Type: text/x-patch, Size: 1560 bytes --]

From 2e54ecf8714088a1c5cf596edb7cf66bc3468dfe Mon Sep 17 00:00:00 2001
From: Antero Mejr <antero@mailbox.org>
Date: Sun, 15 Oct 2023 00:32:57 +0000
Subject: [PATCH] Add completion for Unix 'doas' command.

* lisp/pcmpl-unix.el (pcomplete/doas): New procedure.
* etc/NEWS: Announce.  (Bug#66551)
---
 etc/NEWS           | 4 ++++
 lisp/pcmpl-unix.el | 8 ++++++++
 2 files changed, 12 insertions(+)

diff --git a/etc/NEWS b/etc/NEWS
index 3bd47a0112b..d73ec031d85 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -477,6 +477,10 @@ When this option is non-nil, remote file names are not completed by
 Pcomplete.  Packages, like 'shell-mode', could set this in order to
 suppress remote file name completion at all.
 
+---
+*** Completions for the Unix 'doas' command are now provided.
+Command completion for 'doas' in Eshell and Shell mode will now work.
+
 ** Shell Mode
 
 +++
diff --git a/lisp/pcmpl-unix.el b/lisp/pcmpl-unix.el
index e6b67256a4c..0626bc5a890 100644
--- a/lisp/pcmpl-unix.el
+++ b/lisp/pcmpl-unix.el
@@ -685,6 +685,14 @@ Includes files as well as host names followed by a colon."
   (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
 	       pcomplete-default-completion-function)))
 
+;;;###autoload
+(defun pcomplete/doas ()
+  "Completion for the `doas' command."
+  (pcomplete-opt "CLnsu")
+  (funcall pcomplete-command-completion-function)
+  (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
+	       pcomplete-default-completion-function)))
+
 (provide 'pcmpl-unix)
 
 ;;; pcmpl-unix.el ends here
-- 
2.41.0

bug#66551: [PATCH] Add completion for Unix 'doas' command.

[Stefan Kangas]

Antero Mejr <antero@mailbox.org> writes:

> Stefan Kangas <stefankangas@gmail.com> writes:
>
>> I believe it might be better to align with the flags available on
>> GNU/Linux, then.  Especially considering our larger GNU/Linux user base
>> compared to BSD.
>>
>> It's less cumbersome for users to manually add a missing flag than for
>> pcomplete to suggest an incorrect one.
>
> Sounds good, patch with Linux flags is below.

Thanks, LGTM.

Let's see if anyone else has any comments.  If not, I'll install it on
master in a week or two (feel free to ping me if I forget).

bug#66551: [PATCH] Add completion for Unix 'doas' command.

[Visuwesh]

[ஞாயிறு அக்டோபர் 15, 2023] Antero Mejr via "Bug reports for GNU Emacs, the Swiss army knife of text editors" wrote:

> Stefan Kangas <stefankangas@gmail.com> writes:
>
>> I believe it might be better to align with the flags available on
>> GNU/Linux, then.  Especially considering our larger GNU/Linux user base
>> compared to BSD.
>>
>> It's less cumbersome for users to manually add a missing flag than for
>> pcomplete to suggest an incorrect one.
>
> Sounds good, patch with Linux flags is below.
>
> From 2e54ecf8714088a1c5cf596edb7cf66bc3468dfe Mon Sep 17 00:00:00 2001
> From: Antero Mejr <antero@mailbox.org>
> Date: Sun, 15 Oct 2023 00:32:57 +0000
> Subject: [PATCH] Add completion for Unix 'doas' command.
>
> * lisp/pcmpl-unix.el (pcomplete/doas): New procedure.
> * etc/NEWS: Announce.  (Bug#66551)
> ---
>  etc/NEWS           | 4 ++++
>  lisp/pcmpl-unix.el | 8 ++++++++
>  2 files changed, 12 insertions(+)
>
> diff --git a/etc/NEWS b/etc/NEWS
> index 3bd47a0112b..d73ec031d85 100644
> --- a/etc/NEWS
> +++ b/etc/NEWS
> @@ -477,6 +477,10 @@ When this option is non-nil, remote file names are not completed by
>  Pcomplete.  Packages, like 'shell-mode', could set this in order to
>  suppress remote file name completion at all.
>  
> +---
> +*** Completions for the Unix 'doas' command are now provided.
> +Command completion for 'doas' in Eshell and Shell mode will now work.
> +
>  ** Shell Mode
>  
>  +++
> diff --git a/lisp/pcmpl-unix.el b/lisp/pcmpl-unix.el
> index e6b67256a4c..0626bc5a890 100644
> --- a/lisp/pcmpl-unix.el
> +++ b/lisp/pcmpl-unix.el
> @@ -685,6 +685,14 @@ Includes files as well as host names followed by a colon."
>    (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
>  	       pcomplete-default-completion-function)))
>  
> +;;;###autoload
> +(defun pcomplete/doas ()
> +  "Completion for the `doas' command."
> +  (pcomplete-opt "CLnsu")

Could we not provide completion for -u and -C?  I have the following
function in my init.el:

    (defun pcomplete/doas ()
      "Completion for the `doas' command."
      (when (string-prefix-p "-" (pcomplete-arg 0))
        (pcomplete-opt "Lnsu(pcmpl-unix-user-names)C(pcomplete-entries nil #'file-regular-p)"))
      (funcall pcomplete-command-completion-function)
      (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
               pcomplete-default-completion-function)))

> +  (funcall pcomplete-command-completion-function)
> +  (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
> +	       pcomplete-default-completion-function)))
> +
>  (provide 'pcmpl-unix)
>  
>  ;;; pcmpl-unix.el ends here

bug#66551: [PATCH] Add completion for Unix 'doas' command.

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

Visuwesh <visuweshm@gmail.com> writes:

> Could we not provide completion for -u and -C?  I have the following
> function in my init.el:
>
>     (defun pcomplete/doas ()
>       "Completion for the `doas' command."
>       (when (string-prefix-p "-" (pcomplete-arg 0))
>         (pcomplete-opt "Lnsu(pcmpl-unix-user-names)C(pcomplete-entries nil #'file-regular-p)"))
>       (funcall pcomplete-command-completion-function)
>       (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
>                pcomplete-default-completion-function)))
>

Thanks, that is better. However the -C file completion doesn't work for
me unless I reorder the pcomplete-opt flags like this:

;;;###autoload
(defun pcomplete/doas ()
  "Completion for the `doas' command."
  (pcomplete-opt
   "C(pcomplete-entries nil #'file-regular-p)Lnsu(pcmpl-unix-user-names)")
  (funcall pcomplete-command-completion-function)
  (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
               pcomplete-default-completion-function)))

The above also lets pcomplete-opt handle the '-' prefix. WDYT?

bug#66551: [PATCH] Add completion for Unix 'doas' command.

[Stefan Kangas]

Antero Mejr <antero@mailbox.org> writes:

> Thanks, that is better. However the -C file completion doesn't work for
> me unless I reorder the pcomplete-opt flags like this:
>
> ;;;###autoload
> (defun pcomplete/doas ()
>   "Completion for the `doas' command."
>   (pcomplete-opt
>    "C(pcomplete-entries nil #'file-regular-p)Lnsu(pcmpl-unix-user-names)")
>   (funcall pcomplete-command-completion-function)
>   (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
>                pcomplete-default-completion-function)))
>
> The above also lets pcomplete-opt handle the '-' prefix. WDYT?

Could you send an updated patch based on the above?

Thanks in advance.

bug#66551: [PATCH] Add completion for Unix 'doas' command.

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

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

Stefan Kangas <stefankangas@gmail.com> writes:

> Could you send an updated patch based on the above?

Patch is attached.

After some more testing I replaced:
(pcomplete-entries nil #'file-regular-p)
with:
(pcomplete-entries)

because the former makes it difficult to traverse directories to get to
the config file, and I've never seen pcomplete work like that anywhere
else.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-completion-for-Unix-doas-command.patch --]
[-- Type: text/x-patch, Size: 1657 bytes --]

From e00d8af1e17853def979d88efd80624a2793bad3 Mon Sep 17 00:00:00 2001
From: Antero Mejr <antero@mailbox.org>
Date: Sun, 15 Oct 2023 00:32:57 +0000
Subject: [PATCH] Add completion for Unix 'doas' command.

* lisp/pcmpl-unix.el (pcomplete/doas): New procedure.
* etc/NEWS: Announce.  (Bug#66551)

Co-authored-by: Visuwesh <visuweshm@gmail.com>
---
 etc/NEWS           | 4 ++++
 lisp/pcmpl-unix.el | 8 ++++++++
 2 files changed, 12 insertions(+)

diff --git a/etc/NEWS b/etc/NEWS
index 3bd47a0112b..d73ec031d85 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -477,6 +477,10 @@ When this option is non-nil, remote file names are not completed by
 Pcomplete.  Packages, like 'shell-mode', could set this in order to
 suppress remote file name completion at all.
 
+---
+*** Completions for the Unix 'doas' command are now provided.
+Command completion for 'doas' in Eshell and Shell mode will now work.
+
 ** Shell Mode
 
 +++
diff --git a/lisp/pcmpl-unix.el b/lisp/pcmpl-unix.el
index e6b67256a4c..7af5f2bce74 100644
--- a/lisp/pcmpl-unix.el
+++ b/lisp/pcmpl-unix.el
@@ -685,6 +685,14 @@ Includes files as well as host names followed by a colon."
   (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
 	       pcomplete-default-completion-function)))
 
+;;;###autoload
+(defun pcomplete/doas ()
+  "Completion for the `doas' command."
+  (pcomplete-opt "C(pcomplete-entries)Lnsu(pcmpl-unix-user-names)")
+  (funcall pcomplete-command-completion-function)
+  (funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
+               pcomplete-default-completion-function)))
+
 (provide 'pcmpl-unix)
 
 ;;; pcmpl-unix.el ends here
-- 
2.41.0

bug#66551: [PATCH] Add completion for Unix 'doas' command.

[Stefan Kangas]

Version: 30.1

Antero Mejr <antero@mailbox.org> writes:

> Patch is attached.

Thanks, installed on master.

[1: cfc796f6f24]: 2023-10-23 00:42:05 +0200
  Add completion for 'doas' to pcomplete
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=cfc796f6f24efd7cbc0dcac07f8eccd5200236bd