re-frame-10x/README.md

61 lines
3.1 KiB
Markdown
Raw Normal View History

2016-11-04 06:16:37 +00:00
# re-frame-trace
2017-03-28 03:08:01 +00:00
2016-11-04 06:16:37 +00:00
A trace window for re-frame
2017-03-28 03:08:01 +00:00
## Motivation
re-frame provides a data driven architecture, but we need to be able to inspect it. re-frame-trace takes inspiration from [redux-devtools](https://github.com/gaearon/redux-devtools), and provides several ways to visualise the structure and state of your re-frame application.
2017-03-28 07:39:19 +00:00
<img src="docs/images/trace-window.png" height="400px">
2017-03-28 07:37:57 +00:00
2017-03-28 03:08:01 +00:00
## How does it work?
2017-07-17 21:51:49 +00:00
re-frame has instrumentation to collect traces throughout various important points in the lifecycle of a re-frame app. re-frame-trace is a consumer of these traces, and provides visualisations of the traces. These traces have a well-defined structure, and will eventually be standardised, allowing other developers to create their own tooling to work against the traces. Currently, re-frame's tracing and re-frame-trace are in alpha and are subject to change at any time.
2017-03-28 03:08:01 +00:00
## Getting started
2017-07-17 15:57:55 +00:00
Compile your app with `:closure-defines: "re_frame.trace.trace_enabled_QMARK_" true` and `:preloads [day8.re-frame.trace.preload]`.
So when using leiningen, add the following to `project.clj`:
- `[day8.re-frame/trace "0.1.0"]` in `:profiles :dev :dependencies`
2017-07-17 15:57:55 +00:00
```cljs
{:profiles
{:dev
{:dependencies [day8.re-frame/trace "0.1.0"] }}
2017-07-17 15:57:55 +00:00
```
- `:closure-defines: "re_frame.trace.trace_enabled_QMARK_" true` and `:preloads [day8.re-frame.trace.preload]` in `:compiler`
```cljs
{:builds
[{:id "dev"
:source-paths ["src" "dev"]
:compiler {...
:closure-defines {"re_frame.trace.trace_enabled_QMARK_" true}
:preloads [day8.re-frame.trace.preload]}}]}
```
2017-03-28 03:08:01 +00:00
2017-04-13 18:15:49 +00:00
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.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. The preload namespace also injects a div containing the devtools panel into the DOM.
2017-03-28 03:08:01 +00:00
Now you can start up your application. Once it is loaded, press Ctrl+H to slide open the trace panel and enable tracing. When the panel is closed, tracing is disabled.
## development
### setting up re-frame-trace for development
- Clone `re-frame-trace` to your machine.
- Go into the root directory of a project you'd like to use as a host to test re-frame-trace with. For example, you can use the [todo-mvc](https://github.com/Day8/re-frame/tree/master/examples/todomvc) project.
- Add re-frame-trace into this project using the [instructions](#getting-started) above.
- Create a folder called `checkouts:`
```
mkdir checkouts
```
- Create a symlink from your local re-frame-trace project in the checkouts folder:
```
ln -s path/to/your/local/re-frame-trace checkouts/re-frame-trace
```