status-im
/
re-frame-10x
mirror of https://github.com/status-im/re-frame-10x.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Move preload ns to day8.re-frame.trace.preload

This commit is contained in:
Daniel Compton 2017-04-13 11:19:55 +12:00
parent 16e285892b
commit c7eae79ec3
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -16,7 +16,7 @@ re-frame has instrumentation to collect traces throughout various important poin
There are two requirements to use re-frame-trace:
1. Compile your app with `:closure-defines: "re_frame.trace.trace_enabled_QMARK_" true` and `:preloads [day8.re-frame.preload]`, e.g.
1. Compile your app with `:closure-defines: "re_frame.trace.trace_enabled_QMARK_" true` and `:preloads [day8.re-frame.trace.preload]`, e.g.
```cljs
{:builds
@ -24,12 +24,12 @@ There are two requirements to use re-frame-trace:
:source-paths ["src" "dev"]
:compiler {...
:closure-defines {"re_frame.trace.trace_enabled_QMARK_" true}
:preloads [day8.re-frame.preload]}}]}
:preloads [day8.re-frame.trace.preload]}}]}
```
By default, re-frame tracing is compiled out, so it won't impose a performance cost in production. The trade-off here is that you need to explicitly enable it in development.
The [preloads](https://github.com/clojure/clojurescript/wiki/Compiler-Options#preloads) option (`:preloads [day8.re-frame.preload]`) has to be set in order to automatically monkeypatch Reagent to add appropriate lifecycle hooks. Yes this is gross, and yes we will try and make a PR to reagent to add proper hooks, once we know exactly what we need.
The [preloads](https://github.com/clojure/clojurescript/wiki/Compiler-Options#preloads) option (`:preloads [day8.re-frame.trace.preload]`) has to be set in order to automatically monkeypatch Reagent to add appropriate lifecycle hooks. Yes this is gross, and yes we will try and make a PR to reagent to add proper hooks, once we know exactly what we need.
2. In your app's view code, add in `day8.re-frame.trace/devtools` as a sibling to the root application view. For example, if your app looks like this:
```cljs

4
src/day8/re_frame/preload.cljs → src/day8/re_frame/trace/preload.cljs
View File

@ -1,7 +1,7 @@
(ns day8.re-frame.preload
(ns day8.re-frame.trace.preload
(:require [day8.re-frame.trace :as trace]))
;; Use this namespace with the :preloads compiler option to perform the necessary setup for enabling tracing:
;; {:compiler {:preloads [day8.re-frame.preload] ...}}
;; {:compiler {:preloads [day8.re-frame.trace.preload] ...}}
(trace/init-tracing!)