Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boot-clj/boot-figreload
Boot task providing live-reload using Fighweel client
https://github.com/boot-clj/boot-figreload
boot boot-tasks clojure clojurescript figwheel hot-reload javascript livereload
Last synced: 2 months ago
JSON representation
Boot task providing live-reload using Fighweel client
- Host: GitHub
- URL: https://github.com/boot-clj/boot-figreload
- Owner: boot-clj
- License: epl-1.0
- Created: 2017-01-03T21:12:40.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-06T21:00:17.000Z (almost 7 years ago)
- Last Synced: 2024-10-29T10:44:51.389Z (3 months ago)
- Topics: boot, boot-tasks, clojure, clojurescript, figwheel, hot-reload, javascript, livereload
- Language: Clojure
- Size: 189 KB
- Stars: 49
- Watchers: 12
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# boot-figreload
[](https://clojars.org/powerlaces/boot-figreload)
[Boot][1] task to automatically reload resources in the browser when files in
the project change. Featuring [lein-figwheel][2].
* Provides the `reload` task
* Reload client can show warnings and exceptions from ClojureScript build on **heads-up display**.
* Requires `adzerk/boot-cljs` >= `2.0.0`
## Usage
Add dependency to `build.boot` and `require` the task:
```clj
(set-env! :dependencies '[[adzerk/boot-cljs "LATEST" :scope "test"]
[powerlaces/boot-figreload "LATEST" :scope "test"]
[pandeiro/boot-http "0.7.6" :scope "test"]
[adzerk/boot-cljs-repl "0.3.3" :scope "test"]
[com.cemerick/piggieback "0.2.1" :scope "test"]
[weasel "0.7.0" :scope "test"]
[org.clojure/tools.nrepl "0.2.12" :scope "test"]])
(require '[adzerk.boot-cljs :refer [cljs]]
'[adzerk.boot-cljs-repl :refer [cljs-repl]]
'[powerlaces.boot-figreload :refer [reload]]
'[pandeiro.boot-http :refer [serve]])
```
Add the task to your development pipeline **before `(cljs ...)`**:
```clj
(deftask dev []
(comp (serve)
(watch)
(reload)
(cljs-repl)
(cljs :source-map true
:optimizations :none)))
```
### Dirac
Boot-figreload is compatible with Dirac, enabling REPL evaluation in-browser on top of Figwheel's reloading.
Your `dev` task could therefore become:
```clj
(set-env! :dependencies '[[adzerk/boot-cljs "LATEST" :scope "test"]
[powerlaces/boot-figreload "LATEST" :scope "test"]
[pandeiro/boot-http "0.7.6" :scope "test"]
;; Dirac and cljs-devtoos
[binaryage/dirac "RELEASE" :scope "test"]
[binaryage/devtools "RELEASE" :scope "test"]
[powerlaces/boot-cljs-devtools "0.2.0" :scope "test"]
[adzerk/boot-cljs-repl "0.3.3" :scope "test"]
[com.cemerick/piggieback "0.2.1" :scope "test"]
[weasel "0.7.0" :scope "test"]
;; Has to be `0.2.13`
[org.clojure/tools.nrepl "0.2.13" :scope "test"]])
(require '[adzerk.boot-cljs :refer [cljs]]
'[adzerk.boot-cljs-repl :refer [cljs-repl]]
'[powerlaces.boot-figreload :refer [reload]]
'[powerlaces.boot-cljs-devtools :refer [dirac cljs-devtools]]
'[pandeiro.boot-http :refer [serve]])
...
(deftask dev [D with-dirac bool "Enable Dirac Devtools."]
(comp (serve)
(watch)
(cljs-devtools)
(reload)
(if-not with-dirac
(cljs-repl)
(dirac))
(cljs :source-map true
:optimizations :none
:compiler-options {:external-config
{:devtools/config {:features-to-install [:formatters :hints]
:fn-symbol "λ"
:print-config-overrides true}}})))
```
## Node.js
It should work out of the box. Two things to be aware of:
* you need to have a `main.cljs.edn` like:
```clojure
{:compiler-options {:target :nodejs}
:init-fns [server.core/main]}
```
* you need to launch your built artifact using node:
```shell
$ cd target
$ node main.js
```
## Figwheel Integration Status
Ok this is a super alpha of the figwheel client in `boot-reload`.
At the moment the implemented server to client messages are:
- [x] `:files-changed`
- [x] `:compile-warning`
- [x] `:compile-failed`
- [x] `:css-files-changed`
Whereas the implemented [client to server](https://github.com/arichiardi/lein-figwheel/blob/boot-reload-changes/sidecar/src/figwheel_sidecar/components/figwheel_server.clj#L75) messages are:
- [ ] `"file-selected"`
- [ ] `"callback"`
### Other tasks to complete:
- [x] Inject the Figwheel bootstrap script
- [x] Handle individual `js-onload` per build id (untested but there)
- [x] Figwheel version
- [x] Use Figwheel [init code](https://github.com/bhauman/lein-figwheel/blob/cc2d188ab041fc92551d3c4a8201729c47fe5846/sidecar/src/figwheel_sidecar/build_middleware/injection.clj#L171) (?)
- [ ] Handle `boot-reload`'s `:asset-host` in Figwheel ([link to comments](https://github.com/adzerk-oss/boot-reload/commit/e27e330d9f688875ba19d56e825cd9e81013e58e#commitcomment-20350456))
- [ ] Pass the right `:open-file` option to Figwheel
- [ ] Solve the "first message lost" problem with a message queue (?)
- [x] Assert needed dependencies
- [ ] Repl integration (at the moment supported via [boot-cljs-repl][3])
### To be thorougly tested:
- [x] Node client
- [ ] Web-worker client
- [ ] Trigger of multiple `js-onload`s
## Additional Info
You can see the options available on the command line:
```bash
boot reload --help
```
or in the REPL:
```clj
boot.user=> (doc reload)
```
## Examples
For an up-to-date demo project check [figreload-demo][4].
Legacy examples of how to use `reload` in development can be useful as well. See
[Boot templates and example projects][5] in the ClojureScript wiki.
## License
Copyright © 2014 Adzerk
Copyright © 2015-2016 Juho Teperi
Copyright © 2017 Juho Teperi and Andrea Richiardi
Distributed under the Eclipse Public License either version 1.0 or (at
your option) any later version.
[1]: https://github.com/boot-clj/boot
[2]: https://github.com/bhauman/lein-figwheel
[3]: https://github.com/adzerk-oss/boot-cljs-repl
[4]: https://github.com/arichiardi/figreload-demo
[5]: https://github.com/clojure/clojurescript/wiki#boot