Request to add tomelr package to GNU ELPA

Request to add tomelr package to GNU ELPA

[Kaushal Modi]

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

Hello,

I have been working on a small library very much inspired and reused from
the core library json.el.

The library is called tomelr, and it does just one job: convert the input
lisp S-exp (alist or plist) to a TOML (see https://toml.io) config string.

Purpose: I plan to replace a lot of custom logic for TOML generation in my
ox-hugo package (Org mode to Markdown exporter for Hugo static site
generator) with this dedicated and fully tested TOML generation library.

The source code is at https://github.com/kaushalmodi/tomelr.

Companion blog post: https://scripter.co/defining-tomelr/

The README.org on the repo has a lot more details, but here's a short
example of what this library does:

** Alist data

'((title . "Some Title") ;String
  (author . ("fn ln")) ;List
  (description . "some long description\nthat spans multiple\nlines")
;Multi-line string
  (date . 2022-03-14T01:49:00-04:00) ;RFC 3339 date format
  (tags . ("tag1" "tag2"))
  (draft . "false") ;Boolean
  (versions . ((emacs . "28.1.50") (org . "release_9.5-532-gf6813d"))) ;Map
or TOML Table
  (org_logbook . (((timestamp . 2022-04-08T14:53:00-04:00) ;Array of maps
or TOML Tables
                   (note . "This note addition prompt shows up on typing
the `C-c C-z` binding.\nSee [org#Drawers](
https://www.gnu.org/software/emacs/manual/html_mono/org.html#Drawers)."))
                  ((timestamp . 2018-09-06T11:45:00-04:00)
                   (note . "Another note **bold** _italics_."))
                  ((timestamp . 2018-09-06T11:37:00-04:00)
                   (note . "A note `mono`.")))))

** Plist data

'(:title "Some Title" ;String
  :author ("fn ln") ;List
  :description "some long description\nthat spans multiple\nlines"
;Multi-line string
  :date 2022-03-14T01:49:00-04:00 ;RFC 3339 date format
  :tags ("tag1" "tag2")
  :draft "false" ;Boolean
  :versions (:emacs "28.1.50" :org "release_9.5-532-gf6813d") ;Map or TOML
Table
  :org_logbook ((:timestamp 2022-04-08T14:53:00-04:00 ;Array of maps or
TOML Tables
                 :note "This note addition prompt shows up on typing the
`C-c C-z` binding.\nSee [org#Drawers](
https://www.gnu.org/software/emacs/manual/html_mono/org.html#Drawers).")
                (:timestamp 2018-09-06T11:45:00-04:00
                 :note "Another note **bold** _italics_.")
                (:timestamp 2018-09-06T11:37:00-04:00
                 :note "A note `mono`.")))

** TOML Output

You will get the below TOML output for either of the above input data.

title = "Some Title"
author = ["fn ln"]
description = """
some long description
that spans multiple
lines"""
date = 2022-03-14T01:49:00-04:00
tags = ["tag1", "tag2"]
draft = false
[versions]
  emacs = "28.1.50"
  org = "release_9.5-532-gf6813d"
[[org_logbook]]
  timestamp = 2022-04-08T14:53:00-04:00
  note = """
This note addition prompt shows up on typing the `C-c C-z` binding.
See [org#Drawers](
https://www.gnu.org/software/emacs/manual/html_mono/org.html#Drawers)."""
[[org_logbook]]
  timestamp = 2018-09-06T11:45:00-04:00
  note = "Another note **bold** _italics_."
[[org_logbook]]
  timestamp = 2018-09-06T11:37:00-04:00
  note = "A note `mono`."


Thanks!

--
Kaushal Modi

[-- Attachment #2: Type: text/html, Size: 5828 bytes --]

Re: Request to add tomelr package to GNU ELPA

[Stefan Monnier]

Kaushal Modi [2022-05-03 06:57:12] wrote:
> I have been working on a small library very much inspired and reused from
> the core library json.el.
[...]
> The source code is at https://github.com/kaushalmodi/tomelr.

Thanks, I just pushed it to GNU ELPA.

> The library is called tomelr, and it does just one job: convert the input
> lisp S-exp (alist or plist) to a TOML (see https://toml.io) config string.

"TOML aims to be a minimal configuration file format that's easy to read
due to obvious semantics."

I can't believe someone would write something like that with
a straight face.  [ Unless that someone is very naive, I guess.  ]
:-)


        Stefan

Re: Request to add tomelr package to GNU ELPA

[Kaushal Modi]

On Tue, May 3, 2022 at 9:09 AM Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>
>
> Thanks, I just pushed it to GNU ELPA.

Thanks! That was quick.

> "TOML aims to be a minimal configuration file format that's easy to read
> due to obvious semantics."
>
> I can't believe someone would write something like that with
> a straight face.  [ Unless that someone is very naive, I guess.  ]
> :-)

It's easy to read as long as you are dealing with normal INI style key
assignments and maps. But once you start having arrays of maps, I
agree that it's not very readable.
Reasons I like TOML: Concise spec, mutli-line strings support like
Python, indentation insensitivity. All of that makes the job of
auto-generating (and parsing) TOML very easy.

Re: Request to add tomelr package to GNU ELPA

[tomas]

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

On Tue, May 03, 2022 at 09:09:28AM -0400, Stefan Monnier wrote:
> Kaushal Modi [2022-05-03 06:57:12] wrote:
> > I have been working on a small library very much inspired and reused from
> > the core library json.el.
> [...]
> > The source code is at https://github.com/kaushalmodi/tomelr.
> 
> Thanks, I just pushed it to GNU ELPA.
> 
> > The library is called tomelr, and it does just one job: convert the input
> > lisp S-exp (alist or plist) to a TOML (see https://toml.io) config string.
> 
> "TOML aims to be a minimal configuration file format that's easy to read
> due to obvious semantics."
> 
> I can't believe someone would write something like that with
> a straight face.  [ Unless that someone is very naive, I guess.  ]
> :-)

We're bound to start from zero again and again. Especially in this
profession. I believe it's some punishment by some Gods for someone
having stolen some fire or something ;-P

Cheers
-- 
t

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

Re: Request to add tomelr package to GNU ELPA

[Stefan Monnier]

Kaushal Modi [2022-05-03 10:29:51] wrote:
> On Tue, May 3, 2022 at 9:09 AM Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>> Thanks, I just pushed it to GNU ELPA.
> Thanks! That was quick.

I just happened to be in the neighborhood.

>> "TOML aims to be a minimal configuration file format that's easy to read
>> due to obvious semantics."
>>
>> I can't believe someone would write something like that with
>> a straight face.  [ Unless that someone is very naive, I guess.  ]
>> :-)
>
> It's easy to read as long as you are dealing with normal INI style key
> assignments and maps. But once you start having arrays of maps, I
> agree that it's not very readable.

My point is just that it's only "easy to read" and "obvious" for those
already familiar with such syntax.  Just as is the case for pretty much
all syntaxes.


        Stefan

Re: Request to add tomelr package to GNU ELPA

[João Pedro]

On 03 May 2022 06:57, Kaushal Modi <kaushal.modi@gmail.com> wrote:

> Hello,

Hello, Kaushal.

> I have been working on a small library very much inspired and reused from
> the core library json.el.

It looks great, thanks for the contribution. I've only got one
suggestion, if I may.

>   (date . 2022-03-14T01:49:00-04:00) ;RFC 3339 date format

Instead of relying only on the RFC 3339 date format, couldn't you also
use Emacs' internal time representation as well? There is a quite robust
system for time manipulation in Emacs, below are some documentations for
it.

https://www.gnu.org/software/emacs/manual/html_node/elisp/Time-Zone-Rules.html

https://www.gnu.org/software/emacs/manual/html_node/elisp/Time-Conversion.html

https://www.gnu.org/software/emacs/manual/html_node/elisp/Time-Calculations.html

Best regards,

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

Re: Request to add tomelr package to GNU ELPA

[Kaushal Modi]

Hi João ,

Thanks for the feedback.

On Tue, May 3, 2022 at 12:07 PM João Pedro <jpedrodeamorim@gmail.com> wrote:
> It looks great, thanks for the contribution. I've only got one
> suggestion, if I may.
>
> >   (date . 2022-03-14T01:49:00-04:00) ;RFC 3339 date format
>
> Instead of relying only on the RFC 3339 date format, couldn't you also
> use Emacs' internal time representation as well?

I have special treatment for RFC 3339 because that's the only
date/time format recognized by TOML:
https://toml.io/en/v1.0.0#offset-date-time

I am expecting the elisp code using tomelr to provide it with the RFC
3339 formatted date/time string or symbol.

> There is a quite robust
> system for time manipulation in Emacs, below are some documentations for
> it.

Yes, I am using some of that to convert Org inserted date/time info to
RFC 3339 in ox-hugo here:
https://github.com/kaushalmodi/ox-hugo/blob/c24ea792484598ffd2f8e786fadb823d48c8ec12/ox-hugo.el#L1267-L1368
.
ox-hugo will then hand off that RFC 3339 formatted date/time to tomelr.

As you can see, that code is quite involved and I am not sure that
this library is the place for converting Emacs time to RFC 3339.
(Also, I briefly looked for it.. but I couldn't find something
analogous to timep that I can use to auto-convert that info to RFC
3339 that TOML needs.)


Kaushal

Re: Request to add tomelr package to GNU ELPA

[Stefan Monnier]

Oh, I just noticed that your file lacks a

    ;; Copyright (C) ??-2022 Free Software Foundation, Inc.

notice.  You'll need to add that before the elpa.gnu.org scripts will
agree to make a tarball for your package.


        Stefan

Re: Request to add tomelr package to GNU ELPA

[Kaushal Modi]

On Tue, May 3, 2022 at 1:42 PM Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>
> Oh, I just noticed that your file lacks a
>
>     ;; Copyright (C) ??-2022 Free Software Foundation, Inc.
>
> notice.  You'll need to add that before the elpa.gnu.org scripts will
> agree to make a tarball for your package.

Thanks for letting me know. I just pushed that change.

Re: Request to add tomelr package to GNU ELPA

[João Pedro]

On 03 May 2022 12:45, Kaushal Modi <kaushal.modi@gmail.com> wrote:

> Yes, I am using some of that to convert Org inserted date/time info to
> RFC 3339 in ox-hugo here:
> https://github.com/kaushalmodi/ox-hugo/blob/c24ea792484598ffd2f8e786fadb823d48c8ec12/ox-hugo.el#L1267-L1368
> .
> ox-hugo will then hand off that RFC 3339 formatted date/time to tomelr.
>
> As you can see, that code is quite involved and I am not sure that
> this library is the place for converting Emacs time to RFC 3339.
> (Also, I briefly looked for it.. but I couldn't find something
> analogous to timep that I can use to auto-convert that info to RFC
> 3339 that TOML needs.)

Oh, I see. I had assumed that you can already convert to RFC 3339 using
Emacs' built-in date and time functions. I guess it would be a matter of
introducing those to Emacs then via a patch, though I'm not sure how
exactly the code for converting time to a string works in regards to
different formats, and it doesn't seem like a simple format string would
do.

Thanks for the quick response!

Regards,

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

Re: Request to add tomelr package to GNU ELPA

[Kaushal Modi]

Hello Stefan,

tomelr now installs from GNU ELPA, thanks!

But.. I see that it's also installing and compiling all the test files
in <repo>/test/ directory. Can you please exclude those from the
installation?

Also.. not sure why the installation gave this failure?

test/all-tests.el:26:1: Error: Cannot open load file: No such file or
directory, tjson-utils

`make test` is working alright for me locally and on GitHub Actions:

Contacting host: elpa.gnu.org:443
Parsing tar file...
Parsing tar file...done
Extracting... \
Extracting...done
  INFO     Scraping files for tomelr-autoloads.el...
  INFO     Scraping files for tomelr-autoloads.el...done
Checking /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/tomelr-autoloads.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/tomelr-pkg.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/tomelr.el...
Checking /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/doc...
Checking /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/all-tests.el...

In toplevel form:
test/all-tests.el:26:1: Error: Cannot open load file: No such file or
directory, tjson-utils
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/tarray.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/tcoerce.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/tjson-utils.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/tkey.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/tnil.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/tplist.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/tpredicates.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/tscalar.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/tstring.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/ttable-array.el...
Compiling /tmp/kmodi/ox-hugo-dev/elpa_28/tomelr-0.2.2/test/ttable.el...
Done (Total of 12 files compiled, 1 failed, 2 skipped in 2 directories)
Package ‘tomelr’ installed.

Re: Request to add tomelr package to GNU ELPA

[Stefan Monnier]

Kaushal Modi [2022-05-03 17:39:29] wrote:
> But.. I see that it's also installing and compiling all the test files
> in <repo>/test/ directory. Can you please exclude those from the
> installation?

Even better: you can do it yourself by adding a `.elpaignore` file which
contains just `test` in it.
[ Actually, I'd recommend you put `test` on one line and `COPYING` on
  the other since that's not needed in a tarball downloaded by Emacs
  which already comes with that COPYING file.  ]

> Also.. not sure why the installation gave this failure?
>
> test/all-tests.el:26:1: Error: Cannot open load file: No such file or
> directory, tjson-utils

I guess it's because tomelr/test is not added to `load-path` (which
sounds like a good thing).  If you care to fix it (not needed if you
add the `.elpaignore`) then you could use

    (require 'tjson-utils "test/tjson-utils")


-- Stefan

Re: Request to add tomelr package to GNU ELPA

[Kaushal Modi]

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

On Tue, May 3, 2022, 6:41 PM Stefan Monnier <monnier@iro.umontreal.ca>
wrote:

>
> Even better: you can do it yourself by adding a `.elpaignore` file which
> contains just `test` in it.
>

Thanks. I'll do that.

[ Actually, I'd recommend you put `test` on one line and `COPYING` on
>   the other since that's not needed in a tarball downloaded by Emacs
>   which already comes with that COPYING file.  ]
>

I didn't understand the "COPYING" file reference. My repo doesn't have that
file.

> Also.. not sure why the installation gave this failure?
> >
> > test/all-tests.el:26:1: Error: Cannot open load file: No such file or
> > directory, tjson-utils
>
> I guess it's because tomelr/test is not added to `load-path` (which
> sounds like a good thing).
>

That makes sense. It was confusing because it gave an error only for the
require of that one test file, and not the others.

>

[-- Attachment #2: Type: text/html, Size: 1944 bytes --]

Re: Request to add tomelr package to GNU ELPA

[Stefan Monnier]

> I didn't understand the "COPYING" file reference. My repo doesn't have that
> file.

Oh, sorry, you call it "LICENSE", indeed.  Does it make more sense now?

>> Also.. not sure why the installation gave this failure?
>> >
>> > test/all-tests.el:26:1: Error: Cannot open load file: No such file or
>> > directory, tjson-utils
>>
>> I guess it's because tomelr/test is not added to `load-path` (which
>> sounds like a good thing).
>>
>
> That makes sense. It was confusing because it gave an error only for the
> require of that one test file, and not the others.

I guess the others only require files found in other directories than
`test`.


        Stefan

Re: Request to add tomelr package to GNU ELPA

[Kaushal Modi]

On Tue, May 3, 2022 at 7:02 PM Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>
> > I didn't understand the "COPYING" file reference. My repo doesn't have that
> > file.
>
> Oh, sorry, you call it "LICENSE", indeed.  Does it make more sense now?

Thanks. I ended up adding these lines:

.github
doc
test
Makefile
LICENSE


> I guess the others only require files found in other directories than
> `test`.

No, all tests are in the same test/ dir. That's why I was surprised
that it complained of just the first require.

```
(setq load-prefer-newer t)

(require 'tjson-utils)

(require 'tpredicates)
(require 'tkey)
(require 'tscalar)
(require 'tstring)
(require 'tnil)
(require 'tarray)
(require 'ttable)
(require 'ttable-array)
(require 'tplist)
(require 'tcoerce)
```

Re: Request to add tomelr package to GNU ELPA

[Stefan Monnier]

>> I guess the others only require files found in other directories than
>> `test`.
>
> No, all tests are in the same test/ dir. That's why I was surprised
> that it complained of just the first require.

Oh, that!  It's much simpler: it's not just a warning, it's an error so
the compilation of the file stops right there.


        Stefan

Re: Request to add tomelr package to GNU ELPA

[Kaushal Modi]

On Tue, May 3, 2022 at 10:10 PM Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>
> >> I guess the others only require files found in other directories than
> >> `test`.
> >
> > No, all tests are in the same test/ dir. That's why I was surprised
> > that it complained of just the first require.
>
> Oh, that!  It's much simpler: it's not just a warning, it's an error so
> the compilation of the file stops right there.

Yep. Sorry for the noise; I missed seeing that after that error, it
had quit compiling all-tests.el.

Re: Request to add tomelr package to GNU ELPA

[Robert Pluim]

>>>>> On Tue, 03 May 2022 10:38:13 -0400, Stefan Monnier <monnier@iro.umontreal.ca> said:

    Stefan> My point is just that it's only "easy to read" and "obvious" for those
    Stefan> already familiar with such syntax.  Just as is the case for pretty much
    Stefan> all syntaxes.

Letʼs be fair: unlike a certain other file format ending in 'ML', this
one is not going to cause you to spend hours staring at a screen until
you find the one spot where thereʼs a space too many, causing your
network interfaces not to come up, so that your only access is an
80x24 grey on dark black terminal implemented in java, without
scrollback [1][2]

But it probably has other failure modes.

Robert

Footnotes:
[1]  Any resemblance to any real persons or events is purely coincidental.

[2]  And of course, the resulting syntax is 'legal', so the parser
     doesnʼt complain about it.

-- 

Unable to get .elpaignore to work [Was: Request to add tomelr package to GNU ELPA]

[Kaushal Modi]

On Tue, May 3, 2022 at 8:40 PM Kaushal Modi <kaushal.modi@gmail.com> wrote:
>
> On Tue, May 3, 2022 at 7:02 PM Stefan Monnier <monnier@iro.umontreal.ca> wrote:
> >
> > > I didn't understand the "COPYING" file reference. My repo doesn't have that
> > > file.
> >
> > Oh, sorry, you call it "LICENSE", indeed.  Does it make more sense now?
>
> Thanks. I ended up adding these lines:
>
> .github
> doc
> test
> Makefile
> LICENSE

I added an .elpaignore in this[1] commit, and then bumped the release
number. But the latest release of tomelr 0.2.4 is still attempting to
build the test files.

```
Leaving directory ‘/home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4’

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/tomelr.el at
Wed May  4 08:34:51 2022
Entering directory ‘/home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/’
Leaving directory ‘/home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/’

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/all-tests.el
at Wed May  4 08:34:51 2022
Entering directory ‘/home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/’
all-tests.el:26:1: Error: Cannot open load file: No such file or
directory, tjson-utils

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/tarray.el
at Wed May  4 08:34:51 2022

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/tcoerce.el
at Wed May  4 08:34:51 2022

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/tjson-utils.el
at Wed May  4 08:34:51 2022

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/tkey.el
at Wed May  4 08:34:51 2022

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/tnil.el
at Wed May  4 08:34:51 2022

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/tplist.el
at Wed May  4 08:34:51 2022

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/tpredicates.el
at Wed May  4 08:34:51 2022

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/tscalar.el
at Wed May  4 08:34:51 2022

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/tstring.el
at Wed May  4 08:34:51 2022

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/ttable-array.el
at Wed May  4 08:34:51 2022

Compiling file /home/kmodi/.emacs.d/elpa_28/tomelr-0.2.4/test/ttable.el
at Wed May  4 08:34:51 2022
```
I searched around to see how others are solving this problem. But I
found this another thread with the same issue where the .elpaignore
doesn't seem to work:
https://lists.gnu.org/archive/html/emacs-devel/2021-02/msg01287.html


[1]: https://git.savannah.gnu.org/gitweb/?p=emacs/elpa.git;a=blob;f=.elpaignore;h=d6a32d6b92970db02706d973fa774388ebed4c3f;hb=884674e168cbef35275a325f707c588ac2b5c866

Re: Unable to get .elpaignore to work [Was: Request to add tomelr package to GNU ELPA]

[Kaushal Modi]

Adding more info..

If I run this locally inside the tomelr repo:

> tar -X.elpaignore -cf foo.tar * && tar tvf foo.tar

I see the expected output:

-rw-r--r-- kmodi/users   12340 2022-05-03 14:34 CHANGELOG.org
-rw-r--r-- kmodi/users   28985 2022-05-04 08:50 README.org
-rw-r--r-- kmodi/users   18449 2022-05-03 22:35 tomelr.el

Then may be the same "tar -X.elpaignore" is not being run on the GNU
ELPA server?

Re: Request to add tomelr package to GNU ELPA

[Stefan Monnier]

Robert Pluim [2022-05-04 09:10:03] wrote:
>>>>>> On Tue, 03 May 2022 10:38:13 -0400, Stefan Monnier <monnier@iro.umontreal.ca> said:
>     Stefan> My point is just that it's only "easy to read" and "obvious" for those
>     Stefan> already familiar with such syntax.  Just as is the case for pretty much
>     Stefan> all syntaxes.
>
> Letʼs be fair: unlike a certain other file format ending in 'ML', this
> one is not going to cause you to spend hours staring at a screen until

Don't get me wrong: I have no particular complaint abut the TOML syntax.
I just found the claim to be ridiculous.  It's a bit like me saying we
should all write in French because it's so much easier to read due to its
obvious meaning.


        Stefan

Re: Unable to get .elpaignore to work [Was: Request to add tomelr package to GNU ELPA]

[Kaushal Modi]

> Then may be the same "tar -X.elpaignore" is not being run on the GNU
> ELPA server?

I looked at the dash package's .elpaignore and its archive downloaded
from GNU ELPA and I see the same problem there.

It's as if the .elpaignore is.. ignored :)

Then I looked at another ELPA package arbitrarily: vundo and there its
test/ directory is not getting packaged in the archive.. because its
ignore specification is put in the elpa-packages file.

I'd like to help debug the issue with .elpaignore. And here's Plan B
if we cannot get .elpaignore to work as expected:

From 9d790d72e754a46a1722164da2fe82271369e030 Mon Sep 17 00:00:00 2001
From: Kaushal Modi <kaushal.modi@gmail.com>
Date: Wed, 4 May 2022 09:00:01 -0400
Subject: [PATCH] * elpa-packages (tomelr): Update ignored-files list

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

diff --git a/elpa-packages b/elpa-packages
index 4336648387..498221124f 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -607,7 +607,7 @@
   :ignored-files ("COPYING" "doclicense.texi"))
  ("tNFA"        :url "http://www.dr-qubit.org/git/predictive.git")
  ("tomelr"        :url "https://github.com/kaushalmodi/tomelr"
-  :ignored-files ("LICENSE")
+  :ignored-files (".github" "doc" "test" "Makefile" "LICENSE")
   :news "CHANGELOG.org"
   :auto-sync t)
  ("tramp"        :url "git://git.sv.gnu.org/tramp.git"
-- 
2.34.0

Re: Unable to get .elpaignore to work [Was: Request to add tomelr package to GNU ELPA]

[Stefan Monnier]

Kaushal Modi [2022-05-04 09:06:15] wrote:
>> Then may be the same "tar -X.elpaignore" is not being run on the GNU
>> ELPA server?

Hmm... let me try and dig further into it.  Thanks for the heads up.


        Stefan

Re: Unable to get .elpaignore to work [Was: Request to add tomelr package to GNU ELPA]

[Stefan Monnier]

> I looked at the dash package's .elpaignore and its archive downloaded
> from GNU ELPA and I see the same problem there.

Duh!  For some reason my `elpa-admin.el` code ignored the `.elpaignore`
files when a `:ignored-files` property was given in the
`elpa-packages` file.
Sorry 'bout that, should be fixed now, and thanks for bringing it to
my attention.


        Stefan

Re: Unable to get .elpaignore to work [Was: Request to add tomelr package to GNU ELPA]

[Kaushal Modi]

On Wed, May 4, 2022 at 11:03 AM Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>
> > I looked at the dash package's .elpaignore and its archive downloaded
> > from GNU ELPA and I see the same problem there.
>
> Duh!  For some reason my `elpa-admin.el` code ignored the `.elpaignore`
> files when a `:ignored-files` property was given in the
> `elpa-packages` file.
> Sorry 'bout that, should be fixed now, and thanks for bringing it to
> my attention.

No problem, and thank you!

btw do I need to create a new release, or will the next GNU ELPA
update do the right thing?

Also, based on the docs, I think that GNU ELPA picks up the Version:
header right? (I wish it picked up git tags)

So right now, I need to make dummy commits to just bump up the
Version: header number, and I also git tag that for consistency with
my other git projects.

Re: Unable to get .elpaignore to work [Was: Request to add tomelr package to GNU ELPA]

[Stefan Monnier]

> btw do I need to create a new release, or will the next GNU ELPA
> update do the right thing?

tarballs are not re-created unless a new release is made, so if you want
your tarball to be smaller, you'll need to make a new release.

> Also, based on the docs, I think that GNU ELPA picks up the Version:
> header right? (I wish it picked up git tags)

Yes.


        Stefan

Re: Unable to get .elpaignore to work [Was: Request to add tomelr package to GNU ELPA]

[Kaushal Modi]

On Wed, May 4, 2022 at 11:11 AM Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>
> > btw do I need to create a new release, or will the next GNU ELPA
> > update do the right thing?
>
> tarballs are not re-created unless a new release is made, so if you want
> your tarball to be smaller, you'll need to make a new release.

I confirm the fix in tomelr 0.2.5 ELPA release. Thanks!

Re: Request to add tomelr package to GNU ELPA

[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 wonder: would it be useful to convert in the other direction,
TOML config data to Lisp data?

Would it make sense to handle other somewhat similar formats
of configuration data?  For instance, the data in .ssh/config?
The data in /etc/network/interfaces?

-- 
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: Request to add tomelr package to GNU ELPA

[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 wonder: Is the TOML syntax actually in use by users, or is
it effectively just a proposal for programs to possibly adopt?

If it is the latter, I think it's not useful to include in GNU ELPA.
Let's instead wait and see if it catches on.  That would be the time
to include support for it in Emacs.

-- 
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: Request to add tomelr package to GNU ELPA

[Kaushal Modi]

On Wed, May 4, 2022 at 6:47 PM Richard Stallman <rms@gnu.org> wrote:
> I wonder: would it be useful to convert in the other direction,
> TOML config data to Lisp data?

I haven't found a use for parsing TOML (yet). Once I do, it will be a
challenging task to develop that library (I have zero experience
writing parsers).

The TOML generation on the other hand was easier as Emacs did all the
Lisp data processing for me :)

> Would it make sense to handle other somewhat similar formats
> of configuration data?  For instance, the data in .ssh/config?
> The data in /etc/network/interfaces?

It should be possible to generate that but the tomelr.el won't be the
place for that. I started with a strict definition for this package:
https://scripter.co/defining-tomelr/

This package only converts Lisp data to TOML and follows the TOML v1.0.0 spec.

Re: Request to add tomelr package to GNU ELPA

[Kaushal Modi]

On Thu, May 5, 2022 at 2:36 PM Richard Stallman <rms@gnu.org> wrote:
>
> I wonder: Is the TOML syntax actually in use by users

I have seen TOML in wild at multiple places:

1. Hugo static site generator config file (config.toml):
https://gohugo.io/getting-started/configuration/
2. Blog post front-matter (meta-data). The top portion of each blog
post contains meta-data for the post, like title, author, tags, etc.
*This is the primary reason why I created tomerl.el.*
3. I haven't coded in Rust but I have seen TOML gain popularity due to
its package config (cargo.toml) files:
https://doc.rust-lang.org/cargo/reference/manifest.html
4. Many languages (Python, Perl, Rust, Nim, C, C++, Go, Java, Swift,
Dart, Fortran, etc.) have parsers and generators for TOML.

> , or is it effectively just a proposal for programs to possibly adopt?

Based on above, it's used in many large projects already. These
projects definitely saw the value of using TOML over YAML and JSON.

> If it is the latter, I think it's not useful to include in GNU ELPA.
> Let's instead wait and see if it catches on.

Sorry, but this package is already on GNU ELPA and I am already using
it as a dependency for my other project ox-hugo (it converts Org mode
content to Markdown for the Hugo static site generator, and converts
the meta-data from Org mode to TOML front-matter for the posts (now
using this tomelr library)).

>  That would be the time to include support for it in Emacs.

I requested to have this package included only to GNU ELPA, and it's
already there. So I am grateful for that.
https://elpa.gnu.org/packages/tomelr.html

Thanks for your comments!

Re: Request to add tomelr package to GNU ELPA

[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. ]]]

  > > Would it make sense to handle other somewhat similar formats
  > > of configuration data?  For instance, the data in .ssh/config?
  > > The data in /etc/network/interfaces?

  > It should be possible to generate that but the tomelr.el won't be the
  > place for that.

I expact that _generating_ various similar formats will be
straightforward, so I encourage people to try adding those
changes to the existing tomelr package.

-- 
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)