search

elm-lang / elm-package

Command line tool to share Elm libraries
BSD 3-Clause "New" or "Revised" License
214 stars 66 forks source link

Document fields in elm-package.json #182

Closed Gozala closed 7 years ago

evancz commented 8 years ago

What does this mean?

Gozala commented 8 years ago

What does this mean?

Yeah sorry I should have definitely provided more info, it took me a while myself to recall what the hell did I mean & missing s in fields made it even worse.

What I meant is that there are bunch of fields in the elm-package.json like version, summary & more interesting / less obvious ones like native-modules. I was unable to find any documentation on what fields does elm package recognize and what are constraints on the values for those fields. It would be great if those fields that elm package supports where documented somewhere.

evancz commented 7 years ago

In the upcoming version of things, if there are problems in your elm.json you will get pointed to a link that explains how it works https://github.com/evancz/builder/blob/master/src/Reporting/Error/Assets.hs#L126-L132

So this documentation will get added when that TODO is completed before the release.