mdgriffith/elm-optimize-level-2
1
1
Fork 0
mirror of https://github.com/mdgriffith/elm-optimize-level-2.git synced 2024-11-25 22:50:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
mdgriffith 2020-08-19 08:27:47 -04:00
parent 9b99eee1d3
commit 5a0ba247fa
1 changed files with 30 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
README.md
View File

@ -1,8 +1,10 @@
# Elm Optimize
**Note, Experimental** - *This project is just starting. While we currently believe every adjustment to the resulting javascript should be safe and make things explicitly faster, it's hard to be 100% certain until we have a large number of projects using it successfully. So, beware!*
**NOT FOR SHARING YET** - _Please wait for the announcement before sharing widely, it should be coming soon_ :)
*And let us know how it goes.* :smiley:
**Note, Experimental** - _This project is just starting. While we currently believe every adjustment to the resulting javascript should be safe and make things explicitly faster, it's hard to be 100% certain until we have a large number of projects using it successfully. So, beware!_
_And let us know how it goes by leaving [a comment in this issue](https://github.com/mdgriffith/elm-optimize/issues/15)._ :smiley:
Elm is fast.
@ -14,10 +16,9 @@ Elm Optimize is a project for exploring different optimizations that are specifi
There are two parts to this.
1. Explore different javascript representations for Elm code. This means gathering data on what a given representation would mean on realworld projects, and across browsers.
2. A tool you can use *right now* to compile elm using the adjustments that have given us the most speed!
1. Explore different javascript representations for Elm code. This means gathering data on what a given representation would mean on realworld projects, and across browsers.
2. A tool you can use _right now_ to compile elm using the adjustments that have given us the most speed!
## Installation and Usage
@ -30,31 +31,32 @@ Then you can use `elm-optimize` just as you would `elm-make --optimize`.
```
elm-optimize Main.elm
```
will generate an `elm.js` file.
will generate an `elm.js` file.
The only configurable option is what to name the generated js file.
```
elm-optimize Main.elm --output app.js
```
**Note** — elm-optimize only generates a js file, it doesn't support generating HTML.
**Another Note** — Before deploying your app, you should also minify it and gzip it. `elm-optimize` does not do that for you. [Check out this doc for a recommended setup.](minification.md)
## Exploration
This is also a science project :bowtie:
The goal is to quantify different transformations that can be done to the JS output of the Elm compiler and what their effect would be.
To get started, [here's a current overview of all the JS transformations we explored](transformations.md) and a summary of their effect. Not all of them are included in the CLI tool because not all of them turned out to be beneficial.
A few are listed there as either incomplete or not attempted. That's future work!
To get started, [here's a current overview of all the JS transformations we explored](transformations.md) and a summary of their effect. Not all of them are included in the CLI tool because not all of them turned out to be beneficial.
A few are listed there as either incomplete or not attempted. That's future work!
## Benchmarks
**Note** — *These results are really exciting! However, it's not totally obvious that your project will see similar gains. Performance is a tricky beast! If you do see significant speedups in your project, [leave a comment here on this issue](https://github.com/mdgriffith/elm-optimize/issues/15), we love to see realworld cases.*
**Note** — _These results are really exciting! However, it's not totally obvious that your project will see similar gains. Performance is a tricky beast! If you do see significant speedups in your project, [leave a comment here on this issue](https://github.com/mdgriffith/elm-optimize/issues/15), we love to see realworld cases._
In an effort to quantify these transformations, we've put together a number of benchmarks, including some from exisiting Elm packages such as `dillonkearns/elm-markdown`, `w0rm/elm-obj-file`, and `mdgriffith/elm-ui`.
@ -64,33 +66,27 @@ Our goal is to have benchmarks that track performance on code where performance
Though here are a few highlights:
**Note** — keep in mind that these numbers have *all the caveats* that benchmarks usually have. You may not see similar numbers depending on your machine, your browser, subtle differences in your code, etc.
**Another Note** — From what we've seen, given that you're [minifying and gzipping your JS](minification.md), these transformations should either have no effect on asset size, or may even make your app slightly smaller.
**Note** — keep in mind that these numbers have _all the caveats_ that benchmarks usually have. You may not see similar numbers depending on your machine, your browser, subtle differences in your code, etc.
**Another Note** — From what we've seen, given that you're [minifying and gzipping your JS](minification.md), these transformations should either have no effect on asset size, or may even make your app slightly smaller.
## Html
|Name |Transformtions |Browser |Ops/Second |% Change |
|-----------------------------------------|------------------------------|----------|--------------|---------|
| create a 4 level nested html tree |baseline |firefox | 19,878| |
| create a 4 level nested html tree |optimized |firefox | 24,878| (125%) |
| create a 4 level nested html tree |baseline |chrome | 43,689| |
| create a 4 level nested html tree |optimized |chrome | 113,266| (259%) |
| Name | Transformtions | Browser | Ops/Second | % Change |
| --------------------------------- | -------------- | ------- | ---------- | -------- |
| create a 4 level nested html tree | baseline | firefox | 19,878 | |
| create a 4 level nested html tree | optimized | firefox | 24,878 | (125%) |
| create a 4 level nested html tree | baseline | chrome | 43,689 | |
| create a 4 level nested html tree | optimized | chrome | 113,266 | (259%) |
## Elm Markdown
|Name |Transformtions |Browser |Ops/Second |% Change |
|-----------------------------------------|------------------------------|----------|--------------|---------|
| dillonkearns/elm-markdown |baseline |firefox | 1,226| |
| dillonkearns/elm-markdown |optimized |firefox | 2,497| (204%) |
| dillonkearns/elm-markdown |baseline |chrome | 3,116| |
| dillonkearns/elm-markdown |optimized |chrome | 5,099| (164%) |
| Name | Transformtions | Browser | Ops/Second | % Change |
| ------------------------- | -------------- | ------- | ---------- | -------- |
| dillonkearns/elm-markdown | baseline | firefox | 1,226 | |
| dillonkearns/elm-markdown | optimized | firefox | 2,497 | (204%) |
| dillonkearns/elm-markdown | baseline | chrome | 3,116 | |
| dillonkearns/elm-markdown | optimized | chrome | 5,099 | (164%) |
## Running Benchmarks Locally
@ -100,10 +96,9 @@ Though here are a few highlights:
**Note** you can control which benchmark runs with which transformation by adjusting `src/benchmarks/run.ts`.
## Contributing
*For this project, contributions always start with communication before code!*
_For this project, contributions always start with communication before code!_
That being said, there are a few areas that might be opportunities for contribution.
@ -115,6 +110,6 @@ If your project saw an explicit improvement or performance regression, [leave a
For more serious issues, feel free to file a separate issue.
**Secondly**, if you believe there are public benchmarks that we could track that are *not essentially covered* by our current benchmarks, let us know! We want the benchmarking suite to be as comprehensive as possible, though we have to weigh that against having a million benchmarks that essentially test the same thing.
**Secondly**, if you believe there are public benchmarks that we could track that are _not essentially covered_ by our current benchmarks, let us know! We want the benchmarking suite to be as comprehensive as possible, though we have to weigh that against having a million benchmarks that essentially test the same thing.
**Thirdly**, if you believe there are additional JS transformations that would be interesting to explore, or would like to try improving existing transformations in some way, get in touch!
**Thirdly**, if you believe there are additional JS transformations that would be interesting to explore, or would like to try improving existing transformations in some way, get in touch!