nREPL docs
This commit is contained in:
parent
18e4d3639a
commit
1adadb1c3e
5 changed files with 107 additions and 55 deletions
56
README.md
56
README.md
|
|
@ -27,61 +27,7 @@ babashka or Clojure JVM):
|
|||
|
||||
### nREPL
|
||||
|
||||
To connect to a Scittle nREPL server from your editor, follow these steps:
|
||||
|
||||
In babashka or Clojure JVM, use the
|
||||
[sci.nrepl](https://github.com/babashka/sci.nrepl) dependency and run:
|
||||
|
||||
```
|
||||
(require 'sci.nrepl.browser-server :as nrepl)
|
||||
(nrepl/start! {:nrepl-port 1339 :websocket-port 1340})
|
||||
```
|
||||
|
||||
This will run an nREPL server on port 1339 and a websocket server on port 1340.
|
||||
Your editor's nREPL client will connect to port 1339 and your browser, running
|
||||
scittle, will connect to port 1340. The nREPL server forwards messages to the
|
||||
browser via the websocket connection.
|
||||
|
||||
In your scittle website, you will need to include the following, in addition to
|
||||
the normal routine:
|
||||
|
||||
```
|
||||
<script>var SCITTLE_NREPL_WEBSOCKET_PORT = 1340;</script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/scittle@0.2.8/dist/scittle.nrepl.js" type="application/javascript"></script>
|
||||
```
|
||||
|
||||
Also include the CLJS file that you want to evaluate with nREPL:
|
||||
|
||||
```
|
||||
<script src="cljs/script.cljs" type="application/x-scittle"></script>
|
||||
```
|
||||
|
||||
Then visit `cljs/script.cljs` in your editor and connect to the nREPL server,
|
||||
and start evaluating!
|
||||
|
||||
See the `resources/public/nrepl.html` file for an example. When you run `bb dev`
|
||||
in this repository, and then open `http://localhost:1341/nrepl.html` you should
|
||||
be able evaluate expressions in
|
||||
`resources/public/cljs/nrepl_playground.cljs`. See a demo
|
||||
[here](https://twitter.com/borkdude/status/1526285565343281159).
|
||||
|
||||
### CIDER
|
||||
|
||||
Currently when connecting from CIDER, you need to use this snippet:
|
||||
|
||||
```
|
||||
(cider-register-cljs-repl-type 'sci-js "(+ 1 2 3)")
|
||||
|
||||
(defun mm/cider-connected-hook ()
|
||||
(when (eq 'sci-js cider-cljs-repl-type)
|
||||
(setq-local cider-show-error-buffer nil)
|
||||
(cider-set-repl-type 'cljs)))
|
||||
|
||||
(add-hook 'cider-connected-hook #'mm/cider-connected-hook)
|
||||
```
|
||||
|
||||
Then choose `cider-connect-cljs`, select port `1339`, followed by the `sci-js`
|
||||
REPL type.
|
||||
See [doc/nrepl](doc/nrepl).
|
||||
|
||||
## Tasks
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue