ghci-websockets: A websocket server that survives GHCi reloads

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

A websocket server that survives GHCi reloads - use your browser to visualise results from the REPL.

[Skip to Readme]

Properties

Versions	0.0.1, 0.0.1, 0.0.2
Change log	CHANGELOG.md
Dependencies	aeson, base (<=5), containers, foreign-store, text, websockets [details]
License	BSD-3-Clause
Copyright	Copyright (C) 2019 Jann Mueller
Author	Jann Müller
Maintainer	Jann Müller (j.mueller.11@alumni.ucl.ac.uk)
Category	Language
Home page	https://github.com/j-mueller/ghci-websockets
Bug tracker	https://github.com/j-mueller/ghci-websockets/issues
Source repo	head: git clone https://github.com/j-mueller/ghci-websockets
Uploaded	by jfmueller at 2019-07-14T21:52:10Z

Modules

[Index] [Quick Jump]

Ghci
- Ghci.Websockets
  - Ghci.Websockets.Simple

Downloads

ghci-websockets-0.0.1.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

jfmueller

For package maintainers and hackage trustees

edit package information

Readme for ghci-websockets-0.0.1

[back to package description]

ghci-websockets

With ghci-websockets you can send data from GHCi straight to the browser, using a websocket connection that survives GHCi reloads.

The Ghci.Websockets module implements the actual websocket server, broadcasting JSON objects to all clients. Ghci.Websockets.Simple adds a custom message type for text, HTML, and plots on top of that.

Quickstart

Add ghci-websockets to the build-depends field of your .cabal file
Run cabal new-repl
Run Ghci.Websockets.Simple.initialiseDef
Open html/index.html in a browser
In GHCi, run Ghci.Websockets.Simple.broadcastText "hello" (see also broadcastHtml and broadcastPlot from the same module). You may need :set -XOverloadedStrings.

Warning

This packages uses the foreign-store package internally, which is highly unstable. I wouldn't use ghci-websockets for anything other than GHCi.

License

BSD-3-Clause, see LICENSE

Contributions

Bug reports, pull requests etc. are welcome!