Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tweag/asterius
DEPRECATED in favor of ghc wasm backend, see https://www.tweag.io/blog/2022-11-22-wasm-backend-merged-in-ghc
https://github.com/tweag/asterius
compiler ghc haskell webassembly
Last synced: 3 months ago
JSON representation
DEPRECATED in favor of ghc wasm backend, see https://www.tweag.io/blog/2022-11-22-wasm-backend-merged-in-ghc
- Host: GitHub
- URL: https://github.com/tweag/asterius
- Owner: tweag
- Archived: true
- Created: 2017-11-20T13:18:05.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-14T00:45:01.000Z (about 2 years ago)
- Last Synced: 2024-09-21T16:16:32.769Z (3 months ago)
- Topics: compiler, ghc, haskell, webassembly
- Language: Haskell
- Homepage:
- Size: 88.1 MB
- Stars: 1,977
- Watchers: 72
- Forks: 55
- Open Issues: 137
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ccamel - tweag/asterius - DEPRECATED in favor of ghc wasm backend, see https://www.tweag.io/blog/2022-11-22-wasm-backend-merged-in-ghc (Haskell)
README
# Asterius: A Haskell to WebAssembly compiler
[](https://hub.docker.com/r/terrorjack/asterius)
[](https://asterius.netlify.app)
Asterius is a Haskell to WebAssembly compiler based on GHC. It compiles
Haskell source files or Cabal executable targets to WebAssembly+JavaScript code
which can be run in [Node.js][nodejs] or browsers.
It features seamless JavaScript interop
(lightweight Async FFI with `Promise` support) and small output code (~600KB
`hello.wasm` for a [Hello
World](https://hackage.haskell.org/package/hello-1.0.0.2)). A lot of common
Haskell packages like `lens` are already supported. The project is actively
maintained by [Tweag I/O](https://tweag.io/).
[nodejs]: https://nodejs.org
## Demos
Demos of popular Haskell apps, running in your browser:
- [`diagrams`](https://asterius.netlify.app/demo/diagrams/hilbert.html)
- [`ormolu`](https://asterius.netlify.app/demo/ormolu/WebOrmolu.html)
- [`pandoc`](https://asterius.netlify.app/demo/pandoc/pandoc.html)
- [`todomvc`](https://asterius.netlify.app/demo/todomvc/index.html)
## Quickstart using the prebuilt container image
We host a prebuilt container image on [Docker
Hub](https://hub.docker.com/r/terrorjack/asterius). The image also ships ~2k
prebuilt [packages](https://github.com/tweag/asterius/issues/354) from a recent
Stackage snapshot for convenience of testing simple programs without needing to
set up a Cabal project.
To use the image, mount the working directory containing the source code as a
shared volume, then use the `ahc-link` program:
```console
terrorjack@hostname:/project$ podman run -it --rm -v $(pwd):/workspace -w /workspace terrorjack/asterius
root@hostname:/workspace#
```
There are a lot of link-time options available to `ahc-link`, e.g. targeting
the browser platform instead of `node`, adding extra GHC options or setting
runtime parameters. Check the [documentation](https://asterius.netlify.app/) for
further details.
It's also possible to use `ahc-cabal` as a drop-in replacement of `cabal` to
build a Cabal project. Use `ahc-dist` with `--input-exe` on the output
"executable" file to generate actual WebAssembly and JavaScript artifacts. See
the `diagrams` blog
[post](https://www.tweag.io/posts/2019-12-19-asterius-diagrams.html) for an
example.
Check the documentation [section](https://asterius.netlify.app/images.html)
about the prebuilt image for more information, e.g. versioning policy, how to
use with `podman`/`docker`, etc.
## Building and using `asterius` locally
See the [Building guide](https://asterius.netlify.app/building.html) in the
documentation for details.
## Hacking on Asterius
We recommend using [VSCode Remote
Containers](https://code.visualstudio.com/docs/remote/containers) to reproduce
the very same dev environment used by our core team members. See the [Hacking
guide](https://asterius.netlify.app/hacking.html) in the documentation for
details.
## Documentation
We have [documentation](https://asterius.netlify.app/) and blog posts:
- [Fibonacci compiles end-to-end: Haskell to WebAssembly via
GHC](https://www.tweag.io/posts/2018-05-29-hello-asterius.html)
- [Haskell WebAssembly calling JavaScript and back
again](https://www.tweag.io/posts/2018-09-12-asterius-ffi.html)
- [Asterius GHC WebAssembly backend reaches
TodoMVC](https://www.tweag.io/posts/2018-12-20-asterius-todomvc.html)
- [Haskell art in your browser with
Asterius](https://www.tweag.io/posts/2019-12-19-asterius-diagrams.html)
- [Edge computing with Servant on
Cloudflare](https://www.tweag.io/blog/2020-10-09-asterius-cloudflare-worker/)
Also checkout the [HIW 2018 lightning
talk](https://icfp18.sigplan.org/details/hiw-2018-papers/6/Lightning-talk-Asterius-Bringing-Haskell-to-WebAssembly),
and the slides of an introductory talk in 2020
[here](https://docs.google.com/presentation/d/1AZJIf2ykheqONOM23oC6F3LJ9m5W9gbl69pDVdZszHg/edit?usp=sharing).
Note that they may be slightly out-of-date as the project evolves. Whenever you
find something in the docs of blog posts which doesn't reflect the status quo,
it's a bug and don't hesitate to open a ticket :)
## Project status & roadmap
See the [roadmap](https://asterius.netlify.app/roadmap.html) section in the
documentation for details.
## Contributors
[
](https://tweag.io)
[
](https://iohk.io)
Asterius is maintained by [Tweag I/O](https://tweag.io/).
Have questions? Need help? Tweet at [@tweagio](https://twitter.com/tweagio).