Fix feedback in 'sweeprolog-pack-install'

Have 'sweeprolog-pack-install' actually report its result, instead of
reporting failure even when successful.

* sweep.pl (sweep_pack_install/2): Bind the output argument to non-nil
on success.
* sweeprolog.el (sweeprolog-pack-description-max-width): New user
option.
(sweeprolog-read-pack-name): Use display text properties for alignment
instead of repeated spaces.

diff --git a/README.org b/README.org
index adfa29811d2c5c008d20b74fb83844fb07562c14..fcb651f0ae13cf1f6f9e08bff8f8cc1b2b32521c 100644 (file)
--- a/README.org
+++ b/README.org
@@ -2659,11 +2659,16 @@ A = [102, 111, 111].
 :ALT_TITLE: Prolog Packages
 :END:
 
+You can install SWI-Prolog add-ons, also known as /packs/, with the
+following command:
+
 #+FINDEX: sweeprolog-pack-install
-The command =M-x sweeprolog-pack-install= can be used to install
-or upgrade a SWI-Prolog =pack=. When selecting a =pack= to install, the
-completion candidates are annotated with description and the version
-of each package.
+- Command: sweeprolog-pack-install :: Install or upgrade a Prolog pack.
+
+This command prompts from a pack name, with completion, and installs it
+or upgrades it to the latest available version.  (See also [[https://www.swi-prolog.org/pldoc/man?section=packs][Packs]] in the
+SWI-Prolog manual.)
+
 
 * Contributing
 :PROPERTIES:

diff --git a/sweep.pl b/sweep.pl
index 515cc59a08a72c8d328c88f0af31dd327c2f1513..01ad05e86550c1f11280ad29a8231b274250e79a 100644 (file)
--- a/sweep.pl
+++ b/sweep.pl
@@ -555,8 +555,9 @@ sweep_pack_info(pack(Name0, _, Desc0, Version0, URLS0), [Name, Desc, Version, UR
     atom_string(Version0, Version),
     maplist(atom_string, URLS0, URLS).
 
-sweep_pack_install(PackName, []) :-
-    atom_string(Pack, PackName), pack_install(Pack, [silent(true), upgrade(true), interactive(false)]).
+sweep_pack_install(PackName, true) :-
+    atom_string(Pack, PackName),
+    pack_install(Pack, [silent(true), upgrade(true), interactive(false)]).
 
 sweep_colourise_query([String|Offset], _) :-
     prolog_colourise_query(String, module(sweep), sweep_handle_fragment_(Offset)).

diff --git a/sweeprolog.el b/sweeprolog.el
index deb69cc557d0f024a4faac0853061c59f9b89ec1..ef376f3cc0a339bed841d5817d9e8ea8df04fa37 100644 (file)
--- a/sweeprolog.el
+++ b/sweeprolog.el
@@ -479,6 +479,15 @@ for top-level buffers that don't belong to any project."
                  (string   :tag "History file name")
                  (function :tag "Function returning history file name")))
 
+(defcustom sweeprolog-pack-description-max-width 80
+  "Maximum pack description width to display during completion.
+
+This is an integer specifying a string width at which
+`sweeprolog-pack-install' truncates pack descriptions annotating
+pack completion candidates."
+  :package-version '((sweeprolog "0.22.2"))
+  :type 'integer)
+
 ;;;; Keymaps
 
 (defvar sweeprolog-mode-map
@@ -1741,16 +1750,28 @@ inside a comment, string or quoted atom."
 (defun sweeprolog-read-pack-name ()
   "Read a Prolog pack name from the minibuffer, with completion."
   (let* ((col (sweeprolog-packs-collection))
+         (max-pack (seq-max (mapcar #'string-width (mapcar #'car col))))
+         (max-desc (min sweeprolog-pack-description-max-width
+                        (seq-max (mapcar #'string-width
+                                         (mapcar #'cadr col)))))
          (completion-extra-properties
           (list :annotation-function
-                (lambda (key)
-                  (let* ((val (cdr (assoc-string key col)))
-                         (des (car val))
-                         (ver (cadr val)))
-                    (concat (make-string (max 0 (- 32 (length key))) ? )
-                            (if des
-                                (concat ver (make-string (max 0 (- 16 (length ver))) ? ) des)
-                              ver)))))))
+                (lambda (pack)
+                  (message pack)
+                  (let* ((info (alist-get pack col nil nil #'string=))
+                         (des (car info))
+                         (ver (cadr info)))
+                    (concat
+                     (propertize " " 'display
+                                 `(space :align-to
+                                         ,(+ 2 max-pack)))
+                     (truncate-string-to-width
+                      des sweeprolog-pack-description-max-width
+                      nil nil t)
+                     (propertize " " 'display
+                                 `(space :align-to
+                                         ,(+ 2 max-pack 2 max-desc)))
+                     ver))))))
     (completing-read sweeprolog-read-pack-prompt col)))
 
 ;;;###autoload