Document project.janet more thoroughly. about janet-lang.org HOT 8 CLOSED

Perhaps putting something appropriate in this section could improve things a bit.

from janet-lang.org.

I looked over a collection of project.janet files I had collected locally and found the following "top-level" keywords (filtered out some typos) used in declare-project:

:author
:authors
:dependencies
:desc
:description
:doc
:email
:jeep/dev-dependencies
:jeep/tree
:license
:name
:repo
:source
:url
:version

I think some of these are "unofficial" in the sense that AFAIU they don't have any current meaning (code-wise) from the perspective of jpm:

:authors
:desc
:doc
:email
:jeep/dev-dependencies
:jeep/tree
:source

For comparison, in the Clojure world, I think there might be a convention of using prefixed keywords for naming some kinds of things to avoid collisions. I guess jeep is doing that sort of thing with :jeep/tree.

FWIW :tag (mentioned in the OP), is not a "top-level" keyword so it didn't turn up during this investigation.

On a side note, there is a content subdirectory at the jpm repository now. Perhaps there is an intent to separate out jpm docs eventually.

from janet-lang.org.

Thanks for investigating this, @sogaiu !

from janet-lang.org.

Regarding :tag and some others, currently, there is the following code in jpm's pm.janet:

  (if (dictionary? bundle)
    (do
      (set repo (or (get bundle :url) (get bundle :repo)))
      (set tag (or (get bundle :tag) (get bundle :sha) (get bundle :commit) (get bundle :ref)))
      (set btype (get bundle :type :git))
      (set shallow (get bundle :shallow false)))

As a list that includes:

• :url
• :repo
• :tag
• :sha
• :commit
• :ref
• :type
• :shallow

In the wild though, so far I've only noticed :tag and :repo.

from janet-lang.org.

Closing this for now.

from janet-lang.org.

Wait though. Looks like this should stay open until someone submits a PR for the jpm doc page that includes sogaiu's findings.

As an aside, I'm surprised that jpm allows synonyms like that in the declare-project. Seems like it would be simpler in the long run to have one and only one keyword for each item.

from janet-lang.org.

I don't think that synonyms are being allowed but rather that people have made typos or were mistaken. May be that's not correct though.

from janet-lang.org.

I'm in the process of retiring this github account. Create a new issue if you want.

from janet-lang.org.