-
-
Notifications
You must be signed in to change notification settings - Fork 180
Cider REPL
When using CIDER you want your REPL to use CIDER's middlewares, you'll have access to CIDER's advanced functionality like interactive debugging, doc/code lookup, etc. Here's how to do this:
-
Make sure your version of boot is recent by running
boot -u
.** -
Make your
$BOOT_HOME/profile.boot
orbuild.boot
look like the following.$BOOT_HOME/profile.boot
is preferred so that you don't force other people to default to Cider, even though they really should.(require 'boot.repl) (swap! boot.repl/*default-dependencies* concat '[[cider/cider-nrepl "0.10.0"] [refactor-nrepl "2.0.0-SNAPSHOT"]]) (swap! boot.repl/*default-middleware* conj 'cider.nrepl/cider-middleware)
NOTE: Make sure to have an
'
(apostrophe) before[[cider/cider-nrepl "0.10.0"]]
. (If it's not shown here that means Github's syntax highlighting is still broken.) -
Run REPL as usual with
boot repl
.
Adding clj-refactor
works the same way, just add [refactor-nrepl "VERSION-HERE"]
and refactor-nrepl.middleware/wrap-refactor
respectively.
Following the above instructions will make your Boot work with CIDER, but will be slightly inconvenient if you still launch boot repl
from the terminal sometimes. REPL load time is greatly influenced by cider-nrepl and refactor-nrepl dependencies. To separate regular REPL from CIDER REPL you can do this:
-
Put this code into
~/.boot/profile.boot
:(deftask cider "CIDER profile" [] (require 'boot.repl) (swap! @(resolve 'boot.repl/*default-dependencies*) concat '[[org.clojure/tools.nrepl "0.2.12"] [cider/cider-nrepl "0.10.0"] [refactor-nrepl "2.0.0-SNAPSHOT"]]) (swap! @(resolve 'boot.repl/*default-middleware*) concat '[cider.nrepl/cider-middleware refactor-nrepl.middleware/wrap-refactor]) identity)
-
In Emacs do
M-x customize-variable cider-boot-parameters
and set it tocider repl -s wait
. For project specific settings you can create a.dir-locals.el
file with the following content:((nil . ((cider-boot-parameters . "cider repl -s ...others... wait"))))
-
That's all! Your regular REPL should no longer be so slow to load:
$ time boot cider repl -s ... boot cider repl -s 32.92s user 1.20s system 210% cpu 16.182 total
$ time boot repl -s ... boot repl -s 12.71s user 0.37s system 242% cpu 5.385 total
You can find more documentation in commit [1a765793](https://github.com/boot-clj/boot/commit/1a76579304e816d3407a00c114b0bd4a8b82a549):
Expose repl task dependencies
The repl task is special because it can't run in a pod. It needs to run in the project context and have access to the environment of the build.boot script.
In order to keep the project classpath pristine when the REPL is not in use, the nREPL dependencies are not loaded until the repl task actually needs to run. This presents difficulties with middleware, since most of these are in namespaces that assume tools.nrepl is available.
To support middlware in this environment we expose two atoms:
-
boot.repl/default-dependencies atom containing a vector of maven coordinates in the (set-env! :dependencies '[...]) format. These dependencies will be added only when the repl task is run, and only if the project does not already have explicit dependencies for the deps it would otherwise load.
-
boot.repl/default-middleware atom containing a vector of namespace qualified symbols corresponding to desired middleware. The repl task will resolve them at runtime as necessary, so they don't need to be resolvable from the build.boot.
Modify these to change dependencies or middleware loaded by default by the repl task. The middleware option to the repl task adds middleware in addition to these defaults. The handler option will override these.
You can find other developers and users in the #hoplon
channel on freenode IRC or the boot slack channel.
If you have questions or need help, please visit the Discourse site.
- Environments
- Boot environment
- Java environment
- Tasks
- Built-ins
- Third-party
- Tasks Options
- Filesets
- Target Directory
- Pods
- Boot Exceptions
- Configuring Boot
- Updating Boot
- Setting Clojure version
- JVM Options
- S3 Repositories
- Scripts
- Task Writer's Guide
- Require inside Tasks
- Boot for Leiningen Users
- Boot in Leiningen Projects
- Repl reloading
- Repository Credentials and Deploying
- Snippets
- Troubleshooting
- FAQ
- API docs
- Core
- Pod
- Util