re-frame-10x/README.md

74 lines
3.4 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
2017-07-25 13:44:35 +00:00
A trace panel for re-frame.
2017-03-28 03:08:01 +00:00
2017-08-24 23:17:55 +00:00
[![Clojars Project](https://img.shields.io/clojars/v/day8.re-frame/trace.svg)](https://clojars.org/day8.re-frame/trace)
2017-08-24 23:15:29 +00:00
**Status:** Alpha.
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.
<img src="docs/images/trace-window.gif" height="400px">
2017-03-28 07:37:57 +00:00
2017-07-25 13:44:35 +00:00
## Installation
2017-03-28 03:08:01 +00:00
2017-07-25 13:44:35 +00:00
If you are using leiningen, modify `project.clj` in the following ways. When puzzling over the various possible leiningen configurations, it's often helpful to look at a sample [project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj).
2017-03-28 03:08:01 +00:00
2017-08-24 23:17:55 +00:00
[![Clojars Project](https://img.shields.io/clojars/v/day8.re-frame/trace.svg)](https://clojars.org/day8.re-frame/trace)
- Add re-frame-trace as a dev dependency by placing `[day8.re-frame/trace "VERSION"]` within `:profiles :dev :dependencies`. For example:
2017-03-28 03:08:01 +00:00
2017-07-25 13:44:35 +00:00
```cljs
:profiles
{:dev
{:dependencies [[some-other-package "0.0.0"]
2017-10-21 01:15:55 +00:00
[day8.re-frame/trace "0.1.7"]] }}
2017-07-25 13:44:35 +00:00
```
2017-07-17 15:57:55 +00:00
2017-07-25 13:44:35 +00:00
- Locate the `:compiler` map under `:dev` and add:
2017-07-17 15:57:55 +00:00
2017-07-25 13:44:35 +00:00
- `:closure-defines {"re_frame.trace.trace_enabled_QMARK_" true}`
- `:preloads [day8.re-frame.trace.preload]`
2017-07-17 15:57:55 +00:00
2017-07-25 13:44:35 +00:00
For example:
2017-07-17 15:57:55 +00:00
2017-07-25 13:44:35 +00:00
```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
[cljs-devtools](https://github.com/binaryage/cljs-devtools) is not required to use re-frame-trace, but it is highly recommended.
2017-07-25 13:44:35 +00:00
## Usage
- **Make sure you have followed all of the installation instructions above.**
2017-07-25 13:44:35 +00:00
- Start up your application.
- Once it is loaded, focus the document window and press `ctrl-h` to slide open the trace panel and enable tracing.
2017-03-28 03:08:01 +00:00
2017-07-25 13:44:35 +00:00
- When the panel is closed, tracing is disabled.
## Troubleshooting
* Try a `lein clean`
* Make sure you have followed all the installation steps.
2017-07-25 13:44:35 +00:00
## How does it work?
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.
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.
## Developing/Contributing
2017-08-31 13:51:34 +00:00
If you want to work on re-frame-trace, see [DEVELOPERS.md](DEVELOPERS.md).