git.iko.soy/elk
on master help sign in
Updated visual style of elm.json docs
commit2861e0eacccfdeb42e59ec91bf281da9f14da0c0 authorEvan Czaplicki <evancz@users.noreply.github.com> dateTue 8 May 2018, 15:39 (8 years ago) parent1ce549b
2 files changed+29−2
compare with master
unifiedsplit
docs/elm.json/application.md+11−1 docs/elm.json/package.md+18−1
docs/elm.json/application.md+11−1
@@ -25,27 +25,37 @@ This is a decent baseline for pretty much any applications made with Elm. You wi
2525}
2626```
2727
28+<br>
29+
2830
2931## `"type"`
3032
3133Either `"application"` or `"package"`. All the other fields are based on this choice!
3234
35+<br>
36+
3337
3438## `"source-directories"`
3539
3640A list of directories where Elm code lives. Most projects just use `"src"` for everything.
3741
42+<br>
43+
3844
3945## `"elm-version"`
4046
4147The exact version of Elm this builds with. Should be `"0.19.0"` for most people!
4248
49+<br>
50+
4351
4452## `"dependencies"`
4553
4654All the packages you depend upon. We use exact versions, so your `elm.json` file doubles as a "lock file" that ensures reliable builds.
4755
48−> **Note:** We plan to eventually have a screen in `reactor` that helps add, remove, and upgrade packages. It can sometimes be tricky to keep all of the constraints happy, so we think having a UI will help a lot. If you get into trouble in the meantime, adding things back one-by-one often helps, and I hope you do not get into trouble!
56+**Note:** We plan to eventually have a screen in `reactor` that helps add, remove, and upgrade packages. It can sometimes be tricky to keep all of the constraints happy, so we think having a UI will help a lot. If you get into trouble in the meantime, adding things back one-by-one often helps, and I hope you do not get into trouble!
57+
58+<br>
4959
5060
5161## `"test-dependencies"`
docs/elm.json/package.md+18−1
@@ -21,12 +21,15 @@ This is roughly `elm.json` for the `elm-lang/json` package:
2121}
2222```
2323
24+<br>
2425
2526
2627## `"type"`
2728
2829Either `"application"` or `"package"`. All the other fields are based on this choice.
2930
31+<br>
32+
3033
3134## `"name"`
3235
@@ -34,16 +37,22 @@ The name of a GitHub repo like `"elm-lang/core"` or `"rtfeldman/elm-css"`.
3437
3538> **Note:** We currently only support GitHub repos to ensure that there are no author name collisions. This seems like a pretty tricky problem to solve in a pleasant way For example, do we have to keep an author name registry and give them out as we see them? But if someone is the same person on two platforms? And how to make this all happen in a way this is really nice for typical Elm users? Etc. So adding other hosting endpoints is harder than it sounds.
3639
40+<br>
41+
3742
3843## `"summary"`
3944
4045A short summary that will appear on [`package.elm-lang.org`](https://package.elm-lang.org/) that describes what the package is for. Must be under 80 characters.
4146
47+<br>
48+
4249
4350## `"license"`
4451
4552An OSI approved SPDX code like `"BSD-3-Clause"` or `"MIT"`. These are the two most common licenses in the Elm ecosystem, but you can see the full list of options [here](https://spdx.org/licenses/).
4653
54+<br>
55+
4756
4857## `"version"`
4958
@@ -51,18 +60,24 @@ All packages start at `"1.0.0"` and from there, Elm automatically enforces seman
5160
5261So if you make a PATCH change and call `elm bump` it will update you to `"1.0.1"`. And if you then decide to remove a function (a MAJOR change) and call `elm bump` it will update you to `"2.0.0"`. Etc.
5362
63+<br>
64+
5465
5566## `"exposed-modules"`
5667
5768A list of modules that will be exposed to people using your package. The order you list them will be the order they appear on [`package.elm-lang.org`](https://package.elm-lang.org/).
5869
59−> **Note:** If you have five or more modules, you can use a labelled list like [this](https://github.com/elm-lang/core/blob/master/elm.json). We show the labels on the package website to help people sort through larger packages with distinct categories. Labels must be under 20 characters.
70+**Note:** If you have five or more modules, you can use a labelled list like [this](https://github.com/elm-lang/core/blob/master/elm.json). We show the labels on the package website to help people sort through larger packages with distinct categories. Labels must be under 20 characters.
71+
72+<br>
6073
6174
6275## `"elm-version"`
6376
6477The range of Elm compilers that work with your package. Right now `"0.19.0 <= v < 0.20.0"` is always what you want for this.
6578
79+<br>
80+
6681
6782## `"dependencies"`
6883
@@ -70,6 +85,8 @@ A list of packages that you depend upon. In each application, there can only be
7085
7186> **Note:** Dependency ranges should only express _tested_ ranges. It is not nice to use optimistic ranges and end up causing build failures for your users down the line. Eventually we would like to have an automated system that tries to build and test packages as new packages come out. If it all works, we could send a PR to the author widening the range.
7287
88+<br>
89+
7390
7491## `"test-dependencies"`
7592