-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
After some feedback that shouldn't have the word "elm" in it
- Loading branch information
1 parent
73b7928
commit d8d5437
Showing
6 changed files
with
106 additions
and
106 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,19 @@ | ||
## Compatibility Constraints | ||
|
||
Zelm aims to be: | ||
Zokka aims to be: | ||
|
||
1. As in `README.md`, bicompatible with the Elm compiler when it comes to a | ||
given piece of Elm 0.19.1 code. | ||
2. Not interfere with the execution of the vanilla Elm compiler, i.e. a user | ||
should be able to switch back and forth arbitrarily between invocations of | ||
`zelm` and `elm` without the need to perform any sort of clean-up operation | ||
`zokka` and `elm` without the need to perform any sort of clean-up operation | ||
in-between, such as deleting `elm-stuff` or `$ELM_HOME`. | ||
3. Be reasonably compatible with existing IDE tooling. We add the caveat | ||
"reasonably," because without any updates to the IDE tools, we cannot ensure | ||
that those tools take dependency overrides into account when providing | ||
features such as "click to definition." However, outside of zelm-specific | ||
features such as "click to definition." However, outside of zokka-specific | ||
features, we should preserve IDE compatibility as much as possible. | ||
|
||
This has a variety of downstream effects on technical choices that Zelm has | ||
This has a variety of downstream effects on technical choices that Zokka has | ||
made, as elaborated further in the FAQs. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
|
||
## The design of Zelm | ||
## The design of Zokka | ||
|
||
+ Why have a separate `custom-package-repository-config.json` file in | ||
`$ELM_HOME` instead of just extending `elm.json` even more? Zelm aims to be | ||
`$ELM_HOME` instead of just extending `elm.json` even more? Zokka aims to be | ||
compatible with current Elm tooling, especially IDE tooling. Current IDE | ||
integrations assume that there is a global cache of packages located in | ||
`$ELM_HOME` rather than local per-project caches (as is e.g. the case with | ||
`npm`). This means that to play nicely with these tooling choices, Zelm also | ||
`npm`). This means that to play nicely with these tooling choices, Zokka also | ||
reuses the same global cache. However, because the cache is global to | ||
`$ELM_HOME`, while many Elm projects can use the same `$ELM_HOME`, if one project has a | ||
`custom-package-repository-config.json` that declares one location for a | ||
given package while another project declares another location and those two | ||
locations do not have the same code for that package, one project can break | ||
another. This sort of breakage can appear to be non-deterministic to a user | ||
and can be extremely frustrating to debug. To avoid this, we colocate | ||
`custom-package-repository-config.json` with $ELM_HOME. | ||
`custom-package-repository-config.json` with `$ELM_HOME`. | ||
+ More FAQs forthcoming... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.