A tool to generate HTML code from Elm source in the terminal using [QuickJS](https://bellard.org/quickjs/). # Requirements * depends only on elm compiler, quickjs cli and a posix shell * do not alter elm compiler * do not alter quickjs cli * do not patch elm compiler output * provide acceptable performances (500ms for a big script) # Design QuickJS (Qjs) is a [JavaScript runtime](https://en.wikipedia.org/wiki/List_of_JavaScript_engines), similar to V8 or SpiderMonkey, but lighter and faster. As any runtime, Qjs can interpret JavaScript code, but it is not a web browser. It has no concept of an HTML document. To bridge this gap, we add a minimal [DOM](https://dom.spec.whatwg.org/) implementation. Next, we concatenate this with the Elm JavaScript output and an app launcher snippet, then ask Qjs to interpret all of it. ## Limitations * No event loop * Hence, no [TEA](https://guide.elm-lang.org/architecture/); the `main` function must return a static view * Hence, no Time, no Random, no Json Encoder/Decoder (!), no Http * Nodes can only have one parent (this should always be the case) * Does not scale well : creating thousands of Nodes consumes a [lot of RAM](#Performances) # Usage 1. Clone this repository and navigate into your local copy 2. Run `elm init`. 3. Create `src/Hello.elm` with the following content: ```elm module Hello exposing(main) import Html exposing (p, text) main = p [] [text "Hello World!"] ``` 4. Run `./build.sh src/Hello.elm`; this generates the corresponding HTML code: ```html
Hello World!
``` ## Performances Acceptable for small scripts : 250ms on a modest x86_64 CPU and 64MB RAM for a 500 records into a table ; but is does not scale well as everything is loaded before processing ; no streaming contrary to the usual Unix way. Generate 500k "li" loop took 17s and 900MB RAM. # Prior Work There are more complete tools for generating static sites with Elm: * [elm-pages](https://elm-pages.com/) * [elmstatic](https://korban.net/elm/elmstatic) * [elm-starter](https://github.com/lucamug/elm-starter) * [siteelm](https://github.com/nikueater/siteelm) You should probably consider using one of them instead of this one. :)