Re: [NonGNU ELPA] New package: sweep

[Philip Kaludercic]

Eshel Yaron <eshelshay.yaron@gmail.com> writes:

> [posting again since the last message didn't seem to reach the list, sorry 
> for the noise if you receive this message twice]
>
>
> Hello emacs-devel,
> Long time listener, first time caller :)
>
>
> I would like to submit a new package to NonGNU ELPA, called "sweep":

May I ask what the name is supposed to mean?

> sweep is SWI-Prolog Embedded in Emacs. Quoting from the manual[0]:
>
>> sweep provides an interface for executing Prolog queries and consuming
>> their results from Emacs Lisp.  sweep further builds on top of this
>> interface and on top of the standard Emacs facilities to provide
>> advanced features for developing SWI-Prolog programs in Emacs.
>
> The aim of this package is to provide a fully integrated development
> environment for SWI-Prolog[1] in GNU Emacs.  It does so by creating a
> dynamic Emacs module that contains the SWI-Prolog runtime, which allows
> us to leverage the SWI-Prolog analysis and introspection facilities
> directly from Elisp.

This sound very interesting!

>From briefly skimming through the code I see that you define a new major
that doesn't inherit from the default `prolog-mode'.  Is there a reason
not to do so, or even implement sweep as a minor mode?

> The dynamic module ("sweep-module") is distributed and built as part of
> the latest SWI-Prolog version, so the only files that need to be
> distributed via the ELPA package are the Elisp package sweep.el and the
> user manual.

What happens if someone doesn't have a recent version of SWI Prolog?
Also, I am guessing this is the reason you want to add it to NonGNU ELPA
instead of GNU ELPA, right?

> sweep is licensed under the BSD-2 license, similarly to the rest of
> SWI-Prolog.  Its source code is available at
> https://git.sr.ht/~eshel/sweep and at
> https://github.com/SWI-Prolog/packages-sweep.

I see you've added Sourcehut as the "official" URL in the package
header, do you plan to use your mailing list
(https://lists.sr.ht/~eshel/dev) too?  If so, I recommend adding the
mailing list as the "maintainer" email address so that people can easily
send you a "public" message.

> This project is still in active development, any comments or suggestions
> will be appreciated!
>
> I'm attaching below the proposed patch to nongnu.git:
>
> From 48c15e1354b7b49028f82369fddc458c40ade5ed Mon Sep 17 00:00:00 2001
> From: Eshel Yaron <me@eshelyaron.com>
> Date: Wed, 14 Sep 2022 23:26:20 +0300
> Subject: [PATCH] * elpa-packages (sweep): New package
>
> ---
>  elpa-packages | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/elpa-packages b/elpa-packages
> index 6ad5f44aee..51816e285c 100644
> --- a/elpa-packages
> +++ b/elpa-packages
> @@ -567,6 +567,13 @@
>    :lisp-dir "subed"
>    :ignored-files "LICENSES/GPL-3.0-or-later.txt")
>  
> + ("sweep"               :url "https://github.com/SWI-Prolog/packages-sweep";
> +  :ignored-files ("LICENSE"
> +                  "sweep.c"
> +                  "sweep.pl"
> +                  "CMakeLists.txt")
> +  :doc "README.org")
> +
>   ("swift-mode"               :url "https://github.com/swift-emacs/swift-mode";
>    :ignored-files ("COPYING" "scripts" "test" "Eldev" "Makefile"))