Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to embed an nREPL, specifically for Rebel Readline #285

Merged
merged 7 commits into from
Jan 31, 2021
+50 −0
Merged

Add documentation to embed an nREPL, specifically for Rebel Readline #285

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e00351f
Add documentation to embed an nREPL, specifically for Rebel Readline
Futurile Oct 25, 2020
4361113
Update doc/vim-iced.txt
Futurile Nov 1, 2020
7d5f956
Update doc/vim-iced.txt
Futurile Nov 1, 2020
f224ac8
Update doc/vim-iced.txt
Futurile Nov 1, 2020
40abf77
Update doc/vim-iced.txt
Futurile Jan 31, 2021
5dd280e
Update vim-iced.txt
Futurile Jan 31, 2021
6a02d60
Update vim-iced.txt
Futurile Jan 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions doc/vim-iced.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ CONTENTS *vim-iced-contents*
Leiningen |vim-iced-manual-leiningen|
Boot |vim-iced-manual-boot|
shadow-cljs |vim-iced-manual-shadow-cljs|
Rebel Readline |vim-iced-manual-rebel-readline|
Boost by Python |vim-iced-install-python|
Docker |vim-iced-install-docker|
REPL Connection |vim-iced-repl-connection|
Expand Down Expand Up @@ -217,6 +218,48 @@ SHADOW-CLJS~
<
To start CLJS REPL, see |vim-iced-shadow-cljs|.

*vim-iced-manual-rebel-readline*
REBEL READLINE~

If you use Rebel Readline or want to embed an nREPL in your application,
then one approach is to create a `user.clj` with the following:
>
(ns user (:require [nrepl.server :as nrepl-server]
[clojure.java.io :as io]))

(def nrepl-port 7888)
(defonce nrepl-server (atom nil))

(defn cider-middleware
"Get cider middleware, see
https://github.com/clojure-emacs/cider-nrepl/issues/447"
[]
(require 'cider.nrepl)
(map resolve (var-get (ns-resolve 'cider.nrepl 'cider-middleware))))
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cider-middleware contains all middlewares provided from cider-nrepl.
https://github.com/clojure-emacs/cider-nrepl/blob/v0.25.4/src/cider/nrepl/middleware.clj#L7

Now track-state middleware may lead vim-iced's hang-up. (c.f. #170)
So, to be safe, we should specify the middleware separately, as in Leiningen's example.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Btw, now that clojure-emacs/cider-nrepl#447 is fixed, this resolve step is not necessary.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the information!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@liquidz My poor understanding of Clojure and cider are showing here. I believe you wanted it to specifically load the cider middleware that you have for Leiningen. I have done this - probably in the ugliest way possible.

I removed the resolve step as bbatsov suggested.


(defn dev-middleware []
(mapcat (fn [[ns syms]] (require ns) (map (partial ns-resolve ns) syms))
[['refactor-nrepl.middleware ['wrap-refactor]] ['iced.nrepl ['wrap-iced]]]))

(defn start-nrepl-server! []
(reset!
nrepl-server
(nrepl-server/start-server :port nrepl-port :handler (nrepl-handler))
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you missing the definition of nrepl-handler?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@liquidz you were right, I missed it out somehow. Updated the PR.

)
(println "Cider nREPL server started on port" nrepl-port)
(spit ".nrepl-port" nrepl-port))

(defn stop-nrepl-server! []
(when (not (nil? @nrepl-server))
(nrepl-server/stop-server @nrepl-server)
(println "Cider nREPL server on port" nrepl-port "stopped")
(reset! nrepl-server nil)
(io/delete-file ".nrepl-port" true)
(System/exit 0)))
<
Start the Rebel Readline REPL and from it's prompt start the nREPL server
using `start-nrepl-server!`, then in Vim do `:IcedConnect`.

==============================================================================
BOOST BY PYTHON *vim-iced-install-python*

Expand Down