Permalink
93 lines (64 sloc) 4.15 KB

CLJS DevTools Installation

Enable Custom formatters in Chrome

Available in Chrome 47 and higher.

  • Open DevTools
  • Go to Settings ("three dots" icon in the upper right corner of DevTools > Menu > Settings F1 > Preferences > Console)
  • Check-in "Enable custom formatters"
  • Close DevTools
  • Open DevTools

Note: You might need to refresh the page first time you open Console panel with existing logs - custom formatters are applied only to newly printed console messages.

Integrate with your project

Add devtools dependency into your Leiningen's project.clj or boot file.

Clojars Project

Development builds

CLJS devtools is meant to be used only with development builds.

In general you have two options how to integrate CLJS DevTools with your project:

Install it via :preloads

ClojureScript supports :preloads compiler option which allows you to require namespaces prior your :main namespace. This means that you can use this feature to add cljs-devtools support to your project without modification of your code. You simply add devtools.preload into the :preloads list.

Install it manually

You call install! it from devtools.core namespace. A good technique is to use an independent namespace and require it before your core namespace (but after goog/base.js):

(ns your-project.devtools
  (:require [devtools.core :as devtools]))

(devtools/install!)

(.log js/console (range 200))

Your dev index.html could look like this:

<!doctype html>
<html>
<head>
    <script src="compiled/goog/base.js" type="text/javascript"></script>
    <script src="compiled/your_project.js" type="text/javascript"></script>
</head>
<body>
<script>goog.require('your_project.devtools')</script>
<script>goog.require('your_project.core')</script>
...
</body>
</html>

This will ensure that devtools/install! is called before your normal code gets any chance to run. It does not rely on namespace dependencies where you cannot force exact ordering and it will work even if you happen to run side-effecting code during requiring your code or libraries (for example you are logging something to javascript console during namespace require).

Advanced builds

Because :formatters feature of CLJS devtools does not work under :compiler {:optimizations :advanced} you will probably want to completely exclude the library from your production builds.

In general you have three options:

  • Use :preloads. Preloads are not included in advanced builds.
  • Use different :source-paths for development and production builds. Production build should have no reference to devtools namespaces.
  • Do not call (devtools.core/install!), make it obvious to closure optimizer somehow and rely on advanced optimizations dead code elimination to remove whole library as a dead code. You can simply use some macro which won't emit (devtools.core/install!) call under advanced builds. Or more elegantly you can use :closure-defines to define a conditional which will be understood by closure optimizer. This technique was discussed here. You can also look into project.clj and check out the :dead-code-elimination build. RECENT DISCOVERY: This method does not work reliably as we have discovered in issue 37.

Configuration

You can enable/disable desired features and configure other aspects of CLJS DevTools. Please refer to a separate documentation on configuring the library.

Additional notes