[NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[Akib Azmain Turja]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.1: Patch --]
[-- Type: text/x-patch, Size: 1318 bytes --]

From f8c62ae3b8aaefb3bcdbeaf337d8083d91653767 Mon Sep 17 00:00:00 2001
From: Akib Azmain Turja <akib@disroot.org>
Date: Wed, 18 May 2022 20:41:07 +0600
Subject: [PATCH] * elpa-packages (popon, corfu-popup, flymake-popon): New
 packages

---
 elpa-packages | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/elpa-packages b/elpa-packages
index 7345840..6e0c8e8 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -79,6 +79,8 @@
 
  ("coffee-mode"		:url "https://github.com/defunkt/coffee-mode")
 
+ ("corfu-popup"         :url "https://codeberg.org/akib/emacs-corfu-popup")
+
  ("crux"		:url "https://github.com/bbatsov/crux"
   :readme "README.md"
   :news "CHANGELOG.md")
@@ -160,6 +162,8 @@
  ("flymake-kondor"	:url "https://github.com/turbo-cafe/flymake-kondor"
   :ignored-files ("COPYING.txt"))
 
+ ("flymake-popon"       :url "https://codeberg.org/akib/emacs-flymake-popon")
+
  ("forth-mode"          :url "https://github.com/larsbrinkhoff/forth-mode"
   :ignored-files ("test" "Makefile" "compile.el"))
 
@@ -432,6 +436,8 @@
   :news "CHANGELOG.md"
   :ignored-files ("LICENSE"))
 
+ ("popon"               :url "https://codeberg.org/akib/emacs-popon")
+
  ("popup"		:url "https://github.com/auto-complete/popup-el"
   :ignored-files ("LICENSE"))
 
-- 
2.34.0


[-- Attachment #1.2: Type: text/plain, Size: 661 bytes --]


I would like three new packages to NonGNU ELPA: popon, corfu-popup and
flymake-popon.

Popon is a popup library.  It shows floating text, which doesn't move
while scrolling, and even go away when switching buffer.

corfu-popon provides a global minor mode to make Corfu (an ELPA package)
use Popon instead of child frame.  This allows to use Corfu in
non-graphical displays.

flymake-popon provides a local minor mode to show a popon (popup) on
cursor hover containing Flymake diagnostics.

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[Philip Kaludercic]

Akib Azmain Turja <akib@disroot.org> writes:

> I would like three new packages to NonGNU ELPA: popon, corfu-popup and
> flymake-popon.

Would it be possible to add the packages to GNU ELPA?

Re: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[Akib Azmain Turja]

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

Philip Kaludercic <philipk@posteo.net> writes:

> Akib Azmain Turja <akib@disroot.org> writes:
>
>> I would like three new packages to NonGNU ELPA: popon, corfu-popup and
>> flymake-popon.
>
> Would it be possible to add the packages to GNU ELPA?

Yes and no.  There isn't any legal issue (e.g. contributors) for
submitting these to GNU ELPA.  But I'm not ready to do copyright
assignment right now.

I actually wanted to submit these directly to GNU ELPA, but someone is
much interested in my corfu-popup package before I even released it to
any archive.  As I will do my paperwork later (maybe several monthes),
in the meantime I would like to make these available on NonGNU ELPA.

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[Philip Kaludercic]

Akib Azmain Turja <akib@disroot.org> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>> Akib Azmain Turja <akib@disroot.org> writes:
>>
>>> I would like three new packages to NonGNU ELPA: popon, corfu-popup and
>>> flymake-popon.
>>
>> Would it be possible to add the packages to GNU ELPA?
>
> Yes and no.  There isn't any legal issue (e.g. contributors) for
> submitting these to GNU ELPA.  But I'm not ready to do copyright
> assignment right now.

Ok, that is no problem.  AFAIK the package could be transferred later
on, if you change your mind (it has been done in the opposite
direction).

> I actually wanted to submit these directly to GNU ELPA, but someone is
> much interested in my corfu-popup package before I even released it to
> any archive.  As I will do my paperwork later (maybe several monthes),
> in the meantime I would like to make these available on NonGNU ELPA.

One more question on that point, why is it called corfu-popup, when all
the other packages use the word "popon"?

[NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon (Was: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon)

[Akib Azmain Turja]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.1: Patch --]
[-- Type: text/x-patch, Size: 1324 bytes --]

From ded34fa481aed181d60113fef18652283fe82974 Mon Sep 17 00:00:00 2001
From: Akib Azmain Turja <akib@disroot.org>
Date: Wed, 18 May 2022 20:41:07 +0600
Subject: [PATCH] * elpa-packages (popon, corfu-terminal, flymake-popon): New
 packages

---
 elpa-packages | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/elpa-packages b/elpa-packages
index 7345840..792f808 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -79,6 +79,8 @@
 
  ("coffee-mode"		:url "https://github.com/defunkt/coffee-mode")
 
+ ("corfu-terminal"      :url "https://codeberg.org/akib/emacs-corfu-terminal")
+
  ("crux"		:url "https://github.com/bbatsov/crux"
   :readme "README.md"
   :news "CHANGELOG.md")
@@ -160,6 +162,8 @@
  ("flymake-kondor"	:url "https://github.com/turbo-cafe/flymake-kondor"
   :ignored-files ("COPYING.txt"))
 
+ ("flymake-popon"       :url "https://codeberg.org/akib/emacs-flymake-popon")
+
  ("forth-mode"          :url "https://github.com/larsbrinkhoff/forth-mode"
   :ignored-files ("test" "Makefile" "compile.el"))
 
@@ -432,6 +436,8 @@
   :news "CHANGELOG.md"
   :ignored-files ("LICENSE"))
 
+ ("popon"               :url "https://codeberg.org/akib/emacs-popon")
+
  ("popup"		:url "https://github.com/auto-complete/popup-el"
   :ignored-files ("LICENSE"))
 
-- 
2.34.0


[-- Attachment #1.2: Type: text/plain, Size: 998 bytes --]

Akib Azmain Turja <akib@disroot.org> writes:

> I would like three new packages to NonGNU ELPA: popon, corfu-popup and
> flymake-popon.
>
> Popon is a popup library.  It shows floating text, which doesn't move
> while scrolling, and even go away when switching buffer.
>
> corfu-popon provides a global minor mode to make Corfu (an ELPA package)
> use Popon instead of child frame.  This allows to use Corfu in
> non-graphical displays.
>
> flymake-popon provides a local minor mode to show a popon (popup) on
> cursor hover containing Flymake diagnostics.
>
> -- 
> Akib Azmain Turja
>
> This message is signed by me with my GnuPG key.  It's fingerprint is:
>
>     7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

I have changed the name of corfu-popup to corfu-terminal, since that
name is somewhat misleading.

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[Akib Azmain Turja]

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

Philip Kaludercic <philipk@posteo.net> writes:

> Akib Azmain Turja <akib@disroot.org> writes:
>
>> Philip Kaludercic <philipk@posteo.net> writes:
>>
>>> Akib Azmain Turja <akib@disroot.org> writes:
>>>
>>>> I would like three new packages to NonGNU ELPA: popon, corfu-popup and
>>>> flymake-popon.
>>>
>>> Would it be possible to add the packages to GNU ELPA?
>>
>> Yes and no.  There isn't any legal issue (e.g. contributors) for
>> submitting these to GNU ELPA.  But I'm not ready to do copyright
>> assignment right now.
>
> Ok, that is no problem.  AFAIK the package could be transferred later
> on, if you change your mind (it has been done in the opposite
> direction).
>
>> I actually wanted to submit these directly to GNU ELPA, but someone is
>> much interested in my corfu-popup package before I even released it to
>> any archive.  As I will do my paperwork later (maybe several monthes),
>> in the meantime I would like to make these available on NonGNU ELPA.
>
> One more question on that point, why is it called corfu-popup, when all
> the other packages use the word "popon"?

It is named corfu-popup because it's older than Popon.  Actually Popon
was extracted from corfu-popup to allow other packages to use it, as
different popup implementation don't work together (and trying do so
will break both, and the buffer contents will probably be at risk too).
There is already a package named popup.el, so I named my package Popon,
but I didn't change the name of corfu-popup.  I wrote flymake-popon
later, so I included "popon" in the name.  I think this shouldn't be a
problem for submission, but if it is a problem, I have no problem
changing the name.

But, now it seems to me that name is misleading, because child frame and
Popon both are some type of popup.  So I have changed the name to
corfu-terminal (which Corfu author suggested me) to make it's purpose
clear.

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[João Pedro]

Hello Akib, just chiming in with some opinions as a user.

On Fri, May 20 2022 00:00, Akib Azmain Turja <akib@disroot.org> wrote:

> It is named corfu-popup because it's older than Popon.  Actually Popon
> was extracted from corfu-popup to allow other packages to use it, as
> different popup implementation don't work together (and trying do so
> will break both, and the buffer contents will probably be at risk too).
> There is already a package named popup.el, so I named my package Popon,
> but I didn't change the name of corfu-popup.  I wrote flymake-popon
> later, so I included "popon" in the name.  I think this shouldn't be a
> problem for submission, but if it is a problem, I have no problem
> changing the name.

I don't think it would be a problem for submission, Philip was just
wondering why the name was different, mostly because, as you noted
yourself, it can be misleading, leading users to think it would be a
package to make Corfu use popup.el.

> But, now it seems to me that name is misleading, because child frame and
> Popon both are some type of popup.  So I have changed the name to
> corfu-terminal (which Corfu author suggested me) to make it's purpose
> clear.

Now I must wonder -- and keep in mind that it is not a problem per-se at
all -- why you didn't rename it to corfu-popon, keeping it aligned with
the other packages... 

Overall, great contributions to this package ecosystem, and I hope to
see it in ELPA in the near future!

Best regards,

-- 
João Pedro de Amorim Paula
IT undergraduate at Universidade Federal do Rio Grande do Norte (UFRN)

Re: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[Akib Azmain Turja]

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

João Pedro <jpedrodeamorim@gmail.com> writes:

> Hello Akib, just chiming in with some opinions as a user.
>
> On Fri, May 20 2022 00:00, Akib Azmain Turja <akib@disroot.org> wrote:
>
>> It is named corfu-popup because it's older than Popon.  Actually Popon
>> was extracted from corfu-popup to allow other packages to use it, as
>> different popup implementation don't work together (and trying do so
>> will break both, and the buffer contents will probably be at risk too).
>> There is already a package named popup.el, so I named my package Popon,
>> but I didn't change the name of corfu-popup.  I wrote flymake-popon
>> later, so I included "popon" in the name.  I think this shouldn't be a
>> problem for submission, but if it is a problem, I have no problem
>> changing the name.
>
> I don't think it would be a problem for submission, Philip was just
> wondering why the name was different, mostly because, as you noted
> yourself, it can be misleading, leading users to think it would be a
> package to make Corfu use popup.el.
>
>> But, now it seems to me that name is misleading, because child frame and
>> Popon both are some type of popup.  So I have changed the name to
>> corfu-terminal (which Corfu author suggested me) to make it's purpose
>> clear.
>
> Now I must wonder -- and keep in mind that it is not a problem per-se at
> all -- why you didn't rename it to corfu-popon, keeping it aligned with
> the other packages... 
>
> Overall, great contributions to this package ecosystem, and I hope to
> see it in ELPA in the near future!
>
> Best regards,
>
> -- 
> João Pedro de Amorim Paula
> IT undergraduate at Universidade Federal do Rio Grande do Norte (UFRN)

Well, many may not understand what does popon in the name mean, and this
name change is just to reflect the main purpose of the package, allowing
to use Corfu in terminal, in its name.  corfu-terminal is mainly for
terminal, as there is already a better solution for graphical interface.
But the other two packages are for both GUI and terminal.  And
flymake-popon uses but posframe on GUI by default, as child frames are
nicer and more stable.  I probably ought to name it flymake-posframe as
posframe is the default, but when I started it it used Popon to show the
popup, and the Popon interface is still the priority.

Please don't hestitate to tell if you have any suggestions about the
names or any other thing, I'm willing to hear from the community.

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[João Pedro]

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

On Fri, May 20 2022 01:45, Akib Azmain Turja <akib@disroot.org> wrote:

> Well, many may not understand what does popon in the name mean, and this
> name change is just to reflect the main purpose of the package, allowing
> to use Corfu in terminal, in its name.  corfu-terminal is mainly for
> terminal, as there is already a better solution for graphical interface.

Ohh, I get it! Welp, keeping corfu-terminal or going for corfu-popon now
is a matter of what you'd like to advertise more, the fact that it uses
popon.el, or the fact that it enables Corfu to be used on the terminal.
By your answer I can already suppose that the latter is more important
to you, in which case it makes total sense keeping corfu-terminal.

> But the other two packages are for both GUI and terminal.  And
> flymake-popon uses but posframe on GUI by default, as child frames are
> nicer and more stable.  I probably ought to name it flymake-posframe as
> posframe is the default, but when I started it it used Popon to show the
> popup, and the Popon interface is still the priority.

Aha! You would've beaten me to it! I have a version of flymake-posframe
in my Emacs configuration, which I copied and modified from a repo of
the same name (which isn't on any package archives, FYI) [1]. I could
send you my version of flymake-posframe and I could try yours out to see
which one works best, and maybe we could merge our implementations and
publish it! How about it? I attached my version in this email.

> Please don't hestitate to tell if you have any suggestions about the
> names or any other thing, I'm willing to hear from the community.

That's great! Thank you for your time on both answering my questions and
developing these packages.

Best,

-- 
João Pedro de Amorim Paula
IT undergraduate at Universidade Federal do Rio Grande do Norte (UFRN)


[-- Attachment #2: flymake-posframe.el --]
[-- Type: text/plain, Size: 6737 bytes --]

;;; flymake-posframe.el --- Display flymake diagnostics at point  -*- lexical-binding: t; -*-

;; Copyright (C) 2018 Aya Igarashi

;; Author: Aya Igarashi <ladiclexxx@gmail.com>
;; URL: https://github.com/Ladicle/flymake-posframe
;; Keywords: convenience, languages, tools
;; Version: 1.0.0
;; Package-Requires: ((emacs "26.1") (posframe "0.4.2"))

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <https://www.gnu.org/licenses/>.

;;; Commentary:

;; Display flymake message at point using a posframe.
;; Check out the README for more information.

;;; Code:
(require 'flymake)
(require 'posframe)
(require 'subr-x)

(defcustom flymake-posframe-error-prefix "!! "
  "String to be displayed before every error line."
  :group 'flymake-posframe
  :type '(choice (const :tag "No prefix" nil)
                 string))

(defcustom flymake-posframe-warning-prefix "! "
  "String to be displayed before every warning line."
  :group 'flymake-posframe
  :type '(choice (const :tag "No prefix" nil)
                 string))

(defcustom flymake-posframe-note-prefix "? "
  "String to be displayed before every note line."
  :group 'flymake-posframe
  :type '(choice (const :tag "No prefix" nil)
                 string))

(defcustom flymake-posframe-buffer " *flymake-posframe-buffer*"
  "Name of the flymake posframe buffer."
  :group 'flymake-posframe
  :type 'string)

(defcustom flymake-posframe-idle-delay 0.5
  "Amount of seconds to wait before displaying the posframe.
If you'd like for the posframe to be displayed instantly, set
this to 0 instead of nil. When this variable is nil, we just fall
back to the default value."
  :group 'flymake-posframe
  :type 'float)

(defface flymake-posframe-face
  '((t :inherit nil))
  "The background color of the flymake-posframe frame.
Only the `background' and `:foreground' are used from this face."
  :group 'flymake-posframe)

(defvar flymake-posframe--last-diag nil
  "Last buffer diagnostics displayed in a Flymake posframe.")

(defvar flymake-posframe--last-position nil
  "Last position for which a posframe for Flymake was displayed.")

(defvar flymake-posframe--hide-posframe-hooks
  '(pre-command-hook post-command-hook focus-out-hook)
  "The hooks which should trigger automatic removal of the posframe.")

(defvar flymake-posframe--prefix-alist
  '((:error . flymake-posframe-error-prefix)
    (:warning . flymake-posframe-warning-prefix)
    (:note . flymake-posframe-note-prefix))
  "Alist of (DIAG-TYPE . PREFIX).
The DIAG-TYPE is the return of `flymake--diag-type' and PREFIX is
the prefix text to be shown for that type.")

(defvar flymake-posframe--face-alist
  '((:error . error)
    (:warning . warning)
    (:note . success))
  "Alist of (DIAG-TYPE . FACE).
The DIAG-TYPE is the return of `flymake--diag-type' and FACE is
the face to propertize the prefix text with.")

(defvar flymake-posframe--timer nil
  "Variable to hold a timer in order to display the posframe.")

(defun flymake-posframe--check-position ()
  "Update `flymake-posframe--last-position', returning t if there was no change."
  (equal flymake-posframe--last-position
         (setq flymake-posframe--last-position
               (list (current-buffer) (buffer-modified-tick) (point)))))

(defun flymake-posframe--hide ()
  "Hide the Flymake posframe.
Also remove the `flymake-posframe--hide-posframe-hooks'."
  (posframe-hide flymake-posframe-buffer)
  (dolist (hook flymake-posframe--hide-posframe-hooks)
    (remove-hook hook #'flymake-posframe--hide t)))

(defun flymake-posframe--format-diag (diag)
  "Propertize DIAG according to `flymake--diag-type'.
The argument DIAG is a `flymake--diag' object from Flymake."
  (let* ((type (flymake--diag-type diag))
         (prefix (alist-get type flymake-posframe--prefix-alist))
         (face (alist-get type flymake-posframe--face-alist)))
    (concat (propertize (eval prefix) 'face face) (flymake--diag-text diag))))

(defun flymake-posframe--current-frame ()
  "Return current `posframe--frame' or nil if none."
  (buffer-local-value
   'posframe--frame
   (get-buffer-create flymake-posframe-buffer)))

(defun flymake-posframe--show (contents)
  "Show CONTENTS with `posframe-show'."
  (let* ((fg (face-foreground 'flymake-posframe-face nil t))
         (bg (face-background 'flymake-posframe-face nil t))
         (frame (posframe-show
                 flymake-posframe-buffer
                 :internal-border-width 2
                 :left-fringe 1
                 :right-fringe 1
                 :position (point)
                 :foreground-color fg
                 :background-color bg
                 :string contents)))
    (redirect-frame-focus frame (frame-parent frame))

    (dolist (hook flymake-posframe--hide-posframe-hooks)
      (add-hook hook #'flymake-posframe--hide nil t))))

(defun flymake-posframe--display-or-hide ()
  "Display the Flymake posframe."
  (when flymake-posframe--timer
    (cancel-timer flymake-posframe--timer)
    (setq flymake-posframe--timer nil))
  (when flymake-mode
    (if-let ((diag (get-char-property (point) 'flymake-diagnostic)))
        (unless (and (eq flymake-posframe--last-diag
                         (setq flymake-posframe--last-diag diag))
                     (ignore-error 'wrong-type-argument
                       (frame-visible-p (flymake-posframe--current-frame))))
          (flymake-posframe--check-position)

          (setq flymake-posframe--timer
                (run-at-time
                 (or flymake-posframe-idle-delay
                     (default-value 'flymake-posframe-idle-delay))
                 nil
                 (lambda ()
                   (flymake-posframe--show
                    (flymake-posframe--format-diag diag))))))
      (flymake-posframe--hide))))

;;;###autoload
(define-minor-mode flymake-posframe-mode
  "Minor mode for displaying Flymake diagnostics using `posframe'."
  :lighter nil
  :group flymake-posframe
  (cond
   (flymake-posframe-mode
    (add-hook 'post-command-hook #'flymake-posframe--display-or-hide nil 'local))
   (t
    (remove-hook 'post-command-hook #'flymake-posframe--display-or-hide 'local))))

(provide 'flymake-posframe)
;;; flymake-posframe.el ends here

Re: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[João Pedro]

On Fri, May 20 2022 01:37, João Pedro <jpedrodeamorim@gmail.com> wrote:

> Aha! You would've beaten me to it! I have a version of flymake-posframe
> in my Emacs configuration, which I copied and modified from a repo of
> the same name (which isn't on any package archives, FYI) [1]. I could
> send you my version of flymake-posframe and I could try yours out to see
> which one works best, and maybe we could merge our implementations and
> publish it! How about it? I attached my version in this email.

Silly me forgot the link. Here it goes:

<https://github.com/Ladicle/flymake-posframe>

> ;;; flymake-posframe.el --- Display flymake diagnostics at point  -*- lexical-binding: t; -*-
>
> ;; Copyright (C) 2018 Aya Igarashi

> ;; Author: Aya Igarashi <ladiclexxx@gmail.com>
> ;; URL: https://github.com/Ladicle/flymake-posframe
> ;; Keywords: convenience, languages, tools
> ;; Version: 1.0.0
> ;; Package-Requires: ((emacs "26.1") (posframe "0.4.2"))

Also, I have just now realized that I never modified the Copyright nor
the Author header for the package... I'll make sure to change it before
making it public :P

Best,

-- 
João Pedro de Amorim Paula
IT undergraduate at Universidade Federal do Rio Grande do Norte (UFRN)

Re: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[Richard Stallman]

[[[ To any NSA and FBI agents reading my email: please consider    ]]]
[[[ whether defending the US Constitution against all enemies,     ]]]
[[[ foreign or domestic, requires you to follow Snowden's example. ]]]

  > I would like three new packages to NonGNU ELPA: popon, corfu-popup and
  > flymake-popon.

Before we decide what to do, let's consider, for each of these
libraries, (1) whether we would prefer to have it in GNU ELPA,
and (2) whether we can get the legal papers to do so.

If the answers are yes and yes, we can arrange to put it in GNU ELPA.

Otherwise, we can still go ahead and put it in NonGNU ELPA.

-- 
Dr Richard Stallman (https://stallman.org)
Chief GNUisance of the GNU Project (https://gnu.org)
Founder, Free Software Foundation (https://fsf.org)
Internet Hall-of-Famer (https://internethalloffame.org)

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Philip Kaludercic]

Akib Azmain Turja <akib@disroot.org> writes:

> Akib Azmain Turja <akib@disroot.org> writes:
>
>> I would like three new packages to NonGNU ELPA: popon, corfu-popup and
>> flymake-popon.
>>
>> Popon is a popup library.  It shows floating text, which doesn't move
>> while scrolling, and even go away when switching buffer.
>>
>> corfu-popon provides a global minor mode to make Corfu (an ELPA package)
>> use Popon instead of child frame.  This allows to use Corfu in
>> non-graphical displays.
>>
>> flymake-popon provides a local minor mode to show a popon (popup) on
>> cursor hover containing Flymake diagnostics.
>>
>> -- 
>> Akib Azmain Turja
>>
>> This message is signed by me with my GnuPG key.  It's fingerprint is:
>>
>>     7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5
>
> I have changed the name of corfu-popup to corfu-terminal, since that
> name is somewhat misleading.

I think this is preferable.  One last point is that I see you have
images in your repository.  These should preferably not be distributed
with the package.  They can be removed on ELPA's side by adding a
:ignored-files key, or on the repository side if you add a .elpaignore
file that functions like a .gitignore file.  I think the latter is
preferable, in which case you don't have to patch nongnu.git if
something minor changes on your end.

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Akib Azmain Turja]

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

Philip Kaludercic <philipk@posteo.net> writes:

> Akib Azmain Turja <akib@disroot.org> writes:
>
>> Akib Azmain Turja <akib@disroot.org> writes:
>>
>>> I would like three new packages to NonGNU ELPA: popon, corfu-popup and
>>> flymake-popon.
>>>
>>> Popon is a popup library.  It shows floating text, which doesn't move
>>> while scrolling, and even go away when switching buffer.
>>>
>>> corfu-popon provides a global minor mode to make Corfu (an ELPA package)
>>> use Popon instead of child frame.  This allows to use Corfu in
>>> non-graphical displays.
>>>
>>> flymake-popon provides a local minor mode to show a popon (popup) on
>>> cursor hover containing Flymake diagnostics.
>>>
>>> -- 
>>> Akib Azmain Turja
>>>
>>> This message is signed by me with my GnuPG key.  It's fingerprint is:
>>>
>>>     7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5
>>
>> I have changed the name of corfu-popup to corfu-terminal, since that
>> name is somewhat misleading.
>
> I think this is preferable.  One last point is that I see you have
> images in your repository.  These should preferably not be distributed
> with the package.  They can be removed on ELPA's side by adding a
> :ignored-files key, or on the repository side if you add a .elpaignore
> file that functions like a .gitignore file.  I think the latter is
> preferable, in which case you don't have to patch nongnu.git if
> something minor changes on your end.

Ok, I have commited "*.png" to corfu-terminal.  I think that pattern
should ignore PNG files.

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-popup, flymake-popon

[Akib Azmain Turja]

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

Richard Stallman <rms@gnu.org> writes:

> [[[ To any NSA and FBI agents reading my email: please consider    ]]]
> [[[ whether defending the US Constitution against all enemies,     ]]]
> [[[ foreign or domestic, requires you to follow Snowden's example. ]]]
>
>   > I would like three new packages to NonGNU ELPA: popon, corfu-popup and
>   > flymake-popon.
>
> Before we decide what to do, let's consider, for each of these
> libraries, (1) whether we would prefer to have it in GNU ELPA,
> and (2) whether we can get the legal papers to do so.
>
> If the answers are yes and yes, we can arrange to put it in GNU ELPA.
>
> Otherwise, we can still go ahead and put it in NonGNU ELPA.
>
> -- 
> Dr Richard Stallman (https://stallman.org)
> Chief GNUisance of the GNU Project (https://gnu.org)
> Founder, Free Software Foundation (https://fsf.org)
> Internet Hall-of-Famer (https://internethalloffame.org)
>
>

I don't whether the answer of (1) is yes, but the answer of (2) is
(quoted from another message of this thread I sent):

> Yes and no.  There isn't any legal issue (e.g. contributors) for
> submitting these to GNU ELPA.  But I'm not ready to do copyright
> assignment right now.
> 
> I actually wanted to submit these directly to GNU ELPA, but someone is
> much interested in my corfu-popup package before I even released it to
> any archive.  As I will do my paperwork later (maybe several monthes),
> in the meantime I would like to make these available on NonGNU ELPA.

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Philip Kaludercic]

Akib Azmain Turja <akib@disroot.org> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>> Akib Azmain Turja <akib@disroot.org> writes:
>>
>>> Akib Azmain Turja <akib@disroot.org> writes:
>>>
>>>> I would like three new packages to NonGNU ELPA: popon, corfu-popup and
>>>> flymake-popon.
>>>>
>>>> Popon is a popup library.  It shows floating text, which doesn't move
>>>> while scrolling, and even go away when switching buffer.
>>>>
>>>> corfu-popon provides a global minor mode to make Corfu (an ELPA package)
>>>> use Popon instead of child frame.  This allows to use Corfu in
>>>> non-graphical displays.
>>>>
>>>> flymake-popon provides a local minor mode to show a popon (popup) on
>>>> cursor hover containing Flymake diagnostics.
>>>>
>>>> -- 
>>>> Akib Azmain Turja
>>>>
>>>> This message is signed by me with my GnuPG key.  It's fingerprint is:
>>>>
>>>>     7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5
>>>
>>> I have changed the name of corfu-popup to corfu-terminal, since that
>>> name is somewhat misleading.
>>
>> I think this is preferable.  One last point is that I see you have
>> images in your repository.  These should preferably not be distributed
>> with the package.  They can be removed on ELPA's side by adding a
>> :ignored-files key, or on the repository side if you add a .elpaignore
>> file that functions like a .gitignore file.  I think the latter is
>> preferable, in which case you don't have to patch nongnu.git if
>> something minor changes on your end.
>
> Ok, I have commited "*.png" to corfu-terminal.  I think that pattern
> should ignore PNG files.

Ok, it looks good.  My local ELPA checkout seems to have no issues with
the packages.

Just don't forget to bump the version tags, for otherwise ELPA will
distribute older versions of the packages.

I will wait a day or something like that before pushing the changes,
in case someone has objections or comments.

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Akib Azmain Turja]

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

Philip Kaludercic <philipk@posteo.net> writes:

> Akib Azmain Turja <akib@disroot.org> writes:
>
>> Philip Kaludercic <philipk@posteo.net> writes:
>>
>>> Akib Azmain Turja <akib@disroot.org> writes:
>>>
>>>> Akib Azmain Turja <akib@disroot.org> writes:
>>>>
>>>>> I would like three new packages to NonGNU ELPA: popon, corfu-popup and
>>>>> flymake-popon.
>>>>>
>>>>> Popon is a popup library.  It shows floating text, which doesn't move
>>>>> while scrolling, and even go away when switching buffer.
>>>>>
>>>>> corfu-popon provides a global minor mode to make Corfu (an ELPA package)
>>>>> use Popon instead of child frame.  This allows to use Corfu in
>>>>> non-graphical displays.
>>>>>
>>>>> flymake-popon provides a local minor mode to show a popon (popup) on
>>>>> cursor hover containing Flymake diagnostics.
>>>>>
>>>>> -- 
>>>>> Akib Azmain Turja
>>>>>
>>>>> This message is signed by me with my GnuPG key.  It's fingerprint is:
>>>>>
>>>>>     7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5
>>>>
>>>> I have changed the name of corfu-popup to corfu-terminal, since that
>>>> name is somewhat misleading.
>>>
>>> I think this is preferable.  One last point is that I see you have
>>> images in your repository.  These should preferably not be distributed
>>> with the package.  They can be removed on ELPA's side by adding a
>>> :ignored-files key, or on the repository side if you add a .elpaignore
>>> file that functions like a .gitignore file.  I think the latter is
>>> preferable, in which case you don't have to patch nongnu.git if
>>> something minor changes on your end.
>>
>> Ok, I have commited "*.png" to corfu-terminal.  I think that pattern
>> should ignore PNG files.
>
> Ok, it looks good.  My local ELPA checkout seems to have no issues with
> the packages.
>
> Just don't forget to bump the version tags, for otherwise ELPA will
> distribute older versions of the packages.
>
> I will wait a day or something like that before pushing the changes,
> in case someone has objections or comments.

Just a question, how do I format tag names so that it is recognized as a
stable version?

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Philip Kaludercic]

Akib Azmain Turja <akib@disroot.org> writes:

>> I will wait a day or something like that before pushing the changes,
>> in case someone has objections or comments.
>
> Just a question, how do I format tag names so that it is recognized as a
> stable version?

ELPA does not use tags to indicate new releases, but instead interprets
any commit that increases the version header (see Info node `(elisp)
Library Headers') according to `version-list-<'.

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Akib Azmain Turja]

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

Philip Kaludercic <philipk@posteo.net> writes:

> Akib Azmain Turja <akib@disroot.org> writes:
>
>>> I will wait a day or something like that before pushing the changes,
>>> in case someone has objections or comments.
>>
>> Just a question, how do I format tag names so that it is recognized as a
>> stable version?
>
> ELPA does not use tags to indicate new releases, but instead interprets
> any commit that increases the version header (see Info node `(elisp)
> Library Headers') according to `version-list-<'.
>

Great, that is a better approach than tags, while being VCS independent.

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Philip Kaludercic]

Akib Azmain Turja <akib@disroot.org> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>> Akib Azmain Turja <akib@disroot.org> writes:
>>
>>>> I will wait a day or something like that before pushing the changes,
>>>> in case someone has objections or comments.
>>>
>>> Just a question, how do I format tag names so that it is recognized as a
>>> stable version?
>>
>> ELPA does not use tags to indicate new releases, but instead interprets
>> any commit that increases the version header (see Info node `(elisp)
>> Library Headers') according to `version-list-<'.
>>
>
> Great, that is a better approach than tags, while being VCS independent.

Theoretically yes, but the ELPA build system depends heavily on Git.  A
different advantage is that you can download a package from source and
M-x package-install-file or M-x package-install-from-buffer it.

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Philip Kaludercic]

Philip Kaludercic <philipk@posteo.net> writes:

> I will wait a day or something like that before pushing the changes,
> in case someone has objections or comments.

Pushed, the packages should appear when ELPA refreshes (approx. every 12
hours).

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Akib Azmain Turja]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.1: 0001-elpa-packages-corfu-popup-Rename-to-corfu-terminal.patch --]
[-- Type: text/x-patch, Size: 769 bytes --]

From dd57026f96e1a903fbb5470ba8d6183a7d010b26 Mon Sep 17 00:00:00 2001
From: Akib Azmain Turja <akib@disroot.org>
Date: Mon, 23 May 2022 13:01:55 +0600
Subject: [PATCH] * elpa-packages (corfu-popup): Rename to corfu-terminal

---
 elpa-packages | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/elpa-packages b/elpa-packages
index 6e0c8e8..792f808 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -79,7 +79,7 @@
 
  ("coffee-mode"		:url "https://github.com/defunkt/coffee-mode")
 
- ("corfu-popup"         :url "https://codeberg.org/akib/emacs-corfu-popup")
+ ("corfu-terminal"      :url "https://codeberg.org/akib/emacs-corfu-terminal")
 
  ("crux"		:url "https://github.com/bbatsov/crux"
   :readme "README.md"
-- 
2.34.0


[-- Attachment #1.2: Type: text/plain, Size: 605 bytes --]

Philip Kaludercic <philipk@posteo.net> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>> I will wait a day or something like that before pushing the changes,
>> in case someone has objections or comments.
>
> Pushed, the packages should appear when ELPA refreshes (approx. every 12
> hours).
>

Ahh, you applied the wrong patch.  :(

I'm send a new patch fixing the mistake.  Please apply it to the current
main branch.

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Philip Kaludercic]

Akib Azmain Turja <akib@disroot.org> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>> Philip Kaludercic <philipk@posteo.net> writes:
>>
>>> I will wait a day or something like that before pushing the changes,
>>> in case someone has objections or comments.
>>
>> Pushed, the packages should appear when ELPA refreshes (approx. every 12
>> hours).
>>
>
> Ahh, you applied the wrong patch.  :(
>
> I'm send a new patch fixing the mistake.  Please apply it to the current
> main branch.

Oh no, my bad.  I have applied the patch, but am afraid that ELPA might
not remove the old package from the archive.  This might be a good
excuse to implement garbage collection.

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Akib Azmain Turja]

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

Philip Kaludercic <philipk@posteo.net> writes:

> Akib Azmain Turja <akib@disroot.org> writes:
>
>> Philip Kaludercic <philipk@posteo.net> writes:
>>
>>> Philip Kaludercic <philipk@posteo.net> writes:
>>>
>>>> I will wait a day or something like that before pushing the changes,
>>>> in case someone has objections or comments.
>>>
>>> Pushed, the packages should appear when ELPA refreshes (approx. every 12
>>> hours).
>>>
>>
>> Ahh, you applied the wrong patch.  :(
>>
>> I'm send a new patch fixing the mistake.  Please apply it to the current
>> main branch.
>
> Oh no, my bad.  I have applied the patch, but am afraid that ELPA might
> not remove the old package from the archive.  This might be a good
> excuse to implement garbage collection.

Thanks.  Not removing the old package shouldn't be a problem, as there
is a compatibility file corfu-popup.el that warns the user.  But will
the old package be updated?  Then that will probably be a problem when I
remove the compatibility file.

-- 
Akib Azmain Turja

This message is signed by me with my GnuPG key.  It's fingerprint is:

    7001 8CE5 819F 17A3 BBA6  66AF E74F 0EFA 922A E7F5

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

Re: [NonGNU ELPA] New packages: popon, corfu-terminal, flymake-popon

[Philip Kaludercic]

Akib Azmain Turja <akib@disroot.org> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>> Akib Azmain Turja <akib@disroot.org> writes:
>>
>>> Philip Kaludercic <philipk@posteo.net> writes:
>>>
>>>> Philip Kaludercic <philipk@posteo.net> writes:
>>>>
>>>>> I will wait a day or something like that before pushing the changes,
>>>>> in case someone has objections or comments.
>>>>
>>>> Pushed, the packages should appear when ELPA refreshes (approx. every 12
>>>> hours).
>>>>
>>>
>>> Ahh, you applied the wrong patch.  :(
>>>
>>> I'm send a new patch fixing the mistake.  Please apply it to the current
>>> main branch.
>>
>> Oh no, my bad.  I have applied the patch, but am afraid that ELPA might
>> not remove the old package from the archive.  This might be a good
>> excuse to implement garbage collection.
>
> Thanks.  Not removing the old package shouldn't be a problem, as there
> is a compatibility file corfu-popup.el that warns the user.  But will
> the old package be updated?  Then that will probably be a problem when I
> remove the compatibility file.

To my understanding the package will remain in the archive as is, and
will not be updated.  Stefan will know more.