Re: [NonGNU ELPA] New package: flymake-guile

[Philip Kaludercic]

Distopico <distopico@riseup.net> writes:

> Hi all!
>
> I'm the author of a new package `flymake-guile` and I
> would like to include it in Nongnu ELPA.

Just to be sure, you are sure you don't want to include your package in
GNU ELPA?

> Here the repo: https://framagit.org/flymake-backends/flymake-guile

I am not familiar with the "flymake-quickdef" package, but it doesn't
seem to be much shorter than just defining a regular flymake backend.
As there have been some discussions wrt providing a kind of DSL for
Flymake backends, I am not sure if adding flymake-quickdef would be that
constructive at this point.  Would you consider updating your package to
not use the dependency?  You can check out other flymake-... modes in
GNU and NonGNU ELPA for inspiration.

> ;;; Commentary:
>
> ;; Flymake backend for GNU Guile using `guild' compile.
> ;;
> ;; Usage:
> ;;   (require 'flymake-guile)
> ;;   (add-hook 'scheme-mode-hook 'flymake-guile)

It would probably make sense to autoload the `flymake-guile' function,
so that it is not necessary to require it in a user configuration.

> Best!
>
> From c6a3d53bb56d3e0d8638fe069a49fc4d364e0e84 Mon Sep 17 00:00:00 2001
> From: Distopico <distopico@riseup.net>
> Date: Wed, 30 Aug 2023 20:41:28 -0500
> Subject: [PATCH 1/2] * elpa-packages (flymake-quickdef): New package
>
> ---
>  elpa-packages | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/elpa-packages b/elpa-packages
> index 0d9da00c84..93e7c38600 100644
> --- a/elpa-packages
> +++ b/elpa-packages
> @@ -220,6 +220,9 @@
>    :ignored-files (".travis.yml" "Cask" "LICENSE" "tests" "Makefile"
>                    "flx.el" "misc/flx-helm-demo.el" "misc/flx-test-list.el"))
>  
> + (flymake-quickdef      :url 
> "https://github.com/karlotness/flymake-quickdef.git";
> +  :readme "README.md")
> +
>   (flymake-kondor     :url "https://github.com/turbo-cafe/flymake-kondor";
>    :ignored-files ("COPYING.txt"))
>  
> -- 
> 2.41.0
>
>
> From 50674f93285692a4e7ca1c9b22d13bbffa89eabe Mon Sep 17 00:00:00 2001
> From: Distopico <distopico@riseup.net>
> Date: Wed, 30 Aug 2023 20:53:27 -0500
> Subject: [PATCH 2/2] * elpa-packages (flymake-guile): New package
>
> ---
>  elpa-packages | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/elpa-packages b/elpa-packages
> index 93e7c38600..b07894fe1a 100644
> --- a/elpa-packages
> +++ b/elpa-packages
> @@ -223,6 +223,9 @@
>   (flymake-quickdef      :url 
> "https://github.com/karlotness/flymake-quickdef.git";
>    :readme "README.md")
>  
> + (flymake-guile              :url 
> "https://framagit.org/flymake-backends/flymake-guile.git";
> +  :readme "README.md")

Are you sure the README.md is right thing to include here?  It includes
installation instructions, that are usually redundant when you install
the package using package.el.  I would recommend writing out the
"Commentary" section in flymake-guile.el with a brief description of
what package and its entry points.

Also, the package appears to include files that needn't be distributed
in the release tarball, such as .envrc and guix.scm.  It would be nice
if you could track these and future files of this type in a .elpaignore
file, to instruct the build server that they should be removed before
packaging.

> > +
>   (flymake-kondor     :url "https://github.com/turbo-cafe/flymake-kondor";
>    :ignored-files ("COPYING.txt"))