Re: Add zuul.el package to ELPA

[Niklas Eklund]

Philip Kaludercic <philipk@posteo.net> writes:

> Niklas Eklund <niklas.eklund@posteo.net> writes:
>
>> Niklas Eklund <niklas.eklund@posteo.net> writes:
>>
>>> Philip Kaludercic <philipk@posteo.net> writes:
>>>
>>>> Niklas Eklund <niklas.eklund@posteo.net> writes:
>>>>
>>>>>> I believe if you used compat, you can reduce the minimal version of
>>>>>> Emacs down to 26.1, and the only hard dependency appears to be
>>>>>> project.el?
>>
>> One other thing I saw that package lint complained about, and that I
>> couldn't find in the compat package was with-connection-local-variables?
>>
>> 486:3: error: You should depend on (emacs "27.1") if you need
>> `with-connection-local-variables'.
>>
>> I see in the manual that it doesn't seem to be supported
>> https://git.sr.ht/~pkal/compat/tree/master/compat.texi#L1753. So I guess
>> I can lower it to 27.1 the most, but that would be a good win over 28.1 :)
>
> True, that is missing, but reading through the source in files-x.el, it
> *might* be possible to add that functionality in a backwards
>  way?  But if not, 27.1 is still a considerable improvement considering
>  that Debian Stable is currently distributing that version.

Absolutely, a great improvement! :) If that is added in the future that
would be even better of course, seems like that's the only thing
blocking the package from supporting 26. 

Once you have released a new version of compat I'll try to depend on
that. Would this patch be sufficient you think? (given that I update the
version of compat to the latest)

0001-Use-compat-package-to-support-older-Emacs-version.patch
Description: patch

/Niklas

>> /Niklas
>>
>>>>> I wasn't familiar with the compat library. But if I have a dependency to
>>>>> project.el which package-lint tells me I need to have Emacs 28.1 for, is
>>>>> the proper way to add project to Package-Requires to circumvent the
>>>>> need? Should I then do the same for e.g. seq or does compat provide
>>>>> functionality for that library?
>>>>
>>>> No, compat does not automatically add other dependencies.  If you need
>>>> some other core package that is also available from ELPA, you will need
>>>> to add the dependency to the "Package-Requires" list yourself.
>>>
>>> Alright, then I understand. I'll look into that.
>>>
>>>> But I have noticed that compat is missing `text-property-search-forward'
>>>> and `text-property-search-backward'.  If you are interested in using
>>>> compat, I've already implemented the code and could publish a release
>>>> with these functions added.
>>>
>>> I am interested in adding support for compat, would be good to not
>>> provide a package that only works for the most recent Emacs. Let me know
>>> when the new release is available :)
>>>
>>>>>> I'd also recommend using more specific custom types for your user
>>>>>> options.  See (elisp) Composite Types.
>>>>>
>>>>> Thanks for the suggestion, I wasn't aware about these composite types!
>>>>
>>>> This is also useful since the new `setopt' macro can use this for
>>>> type-checking!
>>>
>>> That's neat!
>>>
>>> /Niklas
>>>
>>>>>> It also appears you should be able to use defconst and defvar-local in
>>>>>> your private variable section.
>>>>>
>>>>> defvar-local I didn't know about.
>>>>>
>>>>>> Keywords (:foo) do not have to be quoted to prevent evaluation.
>>>>>>
>>>>>> I believe, but I might be mistaken, that it is advised to require rx in
>>>>>> a `eval-when-compile' block.
>>>>>
>>>>> Make sense.
>>>>>
>>>>>> (mapconcat #'identity ...) should do the same as `string-join'
>>>>>
>>>>> Yeah this becomes clearer.
>>>>>
>>>>>> Defining a map like zuul-log-mode-map is usually done using defvar
>>>>>>
>>>>>>     (defvar foo-map
>>>>>>       (let ((map (make-sparse-keymap)))
>>>>>>         (define-key map ...)
>>>>>>         ...
>>>>>>         map))
>>>>>
>>>>> I have taken your suggestions and made them into the following commits:
>>>>> - Add defvar to zuul-log-mode-map
>>>>> - Replace mapconcat with string-join
>>>>> - Require rx at compilation
>>>>> - Use defconst and defvar-local in private vars
>>>>> - Use composite types for defcustom variables
>>>>> https://git.sr.ht/~niklaseklund/zuul.el/log
>>>>>
>>>>> /Niklas
>>>>>
>>>>>>> The package allows users to access build logs from the Zuul,
>>>>>>> https://zuul-ci.org/, CI system. Users uses the completion interface of
>>>>>>> Emacs to select a specific build and a buffer is then opened with the
>>>>>>> build log.
>>>>>>>
>>>>>>> The package utilizes Emacs compilation mode to navigate between errors
>>>>>>> in the logs. It also lets the user configure where projects can be found
>>>>>>> on the local machine so that navigating to the source code of an error
>>>>>>> works, even though the absolute path might not be found on the local
>>>>>>> host.
>>>>>>>
>>>>>>> /Niklas Eklund
>>>>>>>
>>>>>>> From ed4201c73aa66b21b040169009dddb636ab76048 Mon Sep 17 00:00:00 2001
>>>>>>> From: Niklas Eklund <niklas.eklund@posteo.net>
>>>>>>> Date: Mon, 29 Aug 2022 20:26:35 +0200
>>>>>>> Subject: [PATCH] * elpa-packages (zuul): New package
>>>>>>>
>>>>>>> ---
>>>>>>>  elpa-packages | 4 ++++
>>>>>>>  1 file changed, 4 insertions(+)
>>>>>>>
>>>>>>> diff --git a/elpa-packages b/elpa-packages
>>>>>>> index 4ae12a26ca..5ab182f93b 100644
>>>>>>> --- a/elpa-packages
>>>>>>> +++ b/elpa-packages
>>>>>>> @@ -810,4 +810,8 @@
>>>>>>>   ("yasnippet-classic-snippets" :url nil)
>>>>>>>   ("zones"              :url nil)  
>>>>>>> ;https://www.emacswiki.org/emacs/zones.el
>>>>>>>   ("ztree"              :url "https://github.com/fourier/ztree";)
>>>>>>> + ("zuul"               :url "https://git.sr.ht/~niklaseklund/zuul.el";
>>>>>>> +  :news "CHANGELOG.org"
>>>>>>> +  :readme "README.md"
>>>>>>> +  :auto-sync t)
>>>>>>>   )