boot-clj/boot-figreload

Name: boot-figreload

Owner: boot-clj

Description: Boot task providing live-reload using Fighweel client

Created: 2017-01-03 21:12:40.0

Updated: 2018-04-12 11:20:57.0

Pushed: 2018-03-06 21:00:17.0

Homepage: null

Size: 194

Language: Clojure

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

boot-figreload

Boot task to automatically reload resources in the browser when files in the project change. Featuring lein-figwheel.

• 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:

-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"]])

uire '[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 ...):

task dev []
omp (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:

-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"]])

uire '[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]])



task dev [D with-dirac bool "Enable Dirac Devtools."]
omp (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:

  mpiler-options {:target :nodejs}
  t-fns [server.core/main]}
  

• you need to launch your built artifact using node:

   target
  de 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 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 (?)
• [ ] Handle boot-reload's :asset-host in Figwheel (link to comments)
• [ ] 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)

To be thorougly tested:

• [x] Node client
• [ ] Web-worker client
• [ ] Trigger of multiple js-onloads

Additional Info

You can see the options available on the command line:

 reload --help

or in the REPL:

.user=> (doc reload)

Examples

For an up-to-date demo project check figreload-demo.

Legacy examples of how to use reload in development can be useful as well. See Boot templates and example projects 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.