integrate rebel-as-nrepl-client

Signed-off-by: Sean Corfield <[email protected]>

Author: seancorfield

README.md

@@ -27,8 +27,8 @@ TL;DR: add the following dependency and then start a REPL with `clj -M:dev/repl`
 ```
 There is also a `bin/repl` bash script that runs `clojure -M:1.12:portal:test:cider-nrepl:rebel:dev/repl`
 to start an nREPL server with CIDER middleware, and then a Rebel Readline
-interactive REPL, with Portal available (and `clojure.tools.logging`, if
-present, patched to `tap>` all log messages for Portal).
+interactive REPL, as a client to that nREPL server, with Portal available (and `clojure.tools.logging`, if
+present, patched to `tap>` all log messages for Portal, also `logging4j2` -- my log4j2 wrapper).
 
 I recently added the `:allow-attach-self` alias which sets the JVM property
 `-Djdk.attach.allowAttachSelf` for JDK 21+ so that
@@ -89,15 +89,15 @@ There are aliases to pull in and start various REPL-related tools:
     * `clojure -M:nrepl:portal:dev/repl` -- ...with Portal (& middleware) or
     * `clojure -M:cider-nrepl:dev/repl` -- CIDER nREPL server or
     * `clojure -M:cider-nrepl:portal:dev/repl` -- ...with Portal (& middleware) or
-    * `clojure -M:rebel:nrepl:dev/repl` -- Rebel Readline REPL + basic nREPL server or
+    * `clojure -M:rebel:nrepl:dev/repl` -- Rebel Readline nREPL client + basic nREPL server or
     * `clojure -M:rebel:nrepl:portal:dev/repl` -- ...with Portal (& middleware) or
-    * `clojure -M:rebel:cider-nrepl:dev/repl` -- Rebel Readline REPL + CIDER nREPL server or
+    * `clojure -M:rebel:cider-nrepl:dev/repl` -- Rebel Readline nREPL client + CIDER nREPL server or
     * `clojure -M:rebel:cider-nrepl:portal:dev/repl` -- ...with Portal (& middleware) or
   * Also works with Figwheel Main (now that I've started doing ClojureScript!):
     * `clojure -M:portal:fig:build:dev/repl` or
 * `:classes` -- adds the `classes` folder to your classpath to pick up compiled code (e.g., see https://clojure.org/guides/dev_startup_time)
 * `:socket` -- starts a Socket REPL on port 50505; can be combined with other aliases since this is just a JVM option
-* `:rebel` -- starts a [Rebel Readline](https://github.com/bhauman/rebel-readline) REPL
+* `:rebel` -- starts a [Rebel Readline](https://github.com/bhauman/rebel-readline) REPL; note that this also loads the Rebel Readline nREPL client library
 * `:nrepl` -- starts a (headless) [nREPL server](https://nrepl.org/) on a random available port; `clojure -M:nrepl`
 * `:cider-nrepl` -- starts a (headless) CIDER-enhanced [nREPL server](https://nrepl.org/) on a random available port; `clojure -M:cider-nrepl`
 

deps.edn

@@ -84,7 +84,9 @@
   :socket {:jvm-opts ["-Dclojure.server.repl={:address,\"0.0.0.0\",:port,50505,:accept,clojure.core.server/repl}"]}
   ;; - see https://github.com/bhauman/rebel-readline
   ;; - start a Rebel Readline REPL:
-  :rebel {:extra-deps {com.bhauman/rebel-readline {:mvn/version "0.1.5"}}
+  :rebel {:extra-deps {com.bhauman/rebel-readline {:mvn/version "0.1.5"}
+                       ;; in case we want to use Rebel as an nREPL client:
+                       com.bhauman/rebel-readline-nrepl {:mvn/version "0.1.6"}}
           ;; see https://github.com/fusesource/jansi/issues/301
           :jvm-opts ["--enable-native-access=ALL-UNNAMED"]
           :main-opts ["-m" "rebel-readline.main"]}

src/org/corfield/dev/repl.clj

@@ -73,6 +73,15 @@
           (catch Throwable _))
         (apply log*-fn logger level more)))))
 
+#_{:clj-kondo/ignore [:unused-private-var]}
+(defn- connect-to-nrepl
+  "Credit to https://github.com/alexander-yakushev for this approach."
+  [_host port _config]
+  (let [start-repl (resolve 'rebel-readline.nrepl.main/start-repl)]
+    (println "Connecting Rebel Readline to nREPL server on port"
+             (str port "..."))
+    (start-repl {:port port})))
+
 (defn -main
   "If Jedi Time is on the classpath, require it (so that Java Time
   objects will support datafy/nav).
@@ -92,7 +101,7 @@
   * if Figwheel Main is on the classpath then start that, else
   * if Rebel Readline is on the classpath then start that, else
   * start a plain ol' Clojure REPL."
-  [& args]
+  [& _]
   ;; jedi-time?
   (try
     (require 'jedi-time.core)
@@ -167,11 +176,16 @@
                 ["Figwheel Main" #(figgy "-b" "dev" "-r")])
               (catch Throwable _))
             (try ; Rebel Readline?
-              (let [rebel-main (requiring-resolve 'rebel-readline.main/-main)]
+              (let [rebel-main (requiring-resolve 'rebel-readline.main/-main)
+                    rebel-nrepl (try (require 'rebel-readline.nrepl.main)
+                                     true
+                                     (catch Throwable _))]
                 (try
                   (require 'nrepl.cmdline)
                   ;; both Rebel Readline and nREPL are on the classpath!
-                  [(str "Rebel Readline + nREPL Server"
+                  [(str "Rebel Readline "
+                        (when rebel-nrepl "Client ")
+                        "+ nREPL Server"
                         (when (seq middleware)
                           (str " with " (str/join ", " (map first middleware)))))
                    (fn []
@@ -181,7 +195,9 @@
                             "-m" "nrepl.cmdline"
                             (into (or mw-args [])
                                   ["--interactive"
-                                   "-f" "rebel-readline.main/-main"])))]
+                                   "-f" (if rebel-nrepl
+                                          "org.corfield.dev.repl/connect-to-nrepl"
+                                          "rebel-readline.main/-main")])))]
                   (catch Throwable _
                     ;; only Rebel Readline is on the classpath:
                     ["Rebel Readline" rebel-main])))
@@ -202,7 +218,9 @@
     (System/exit 0)))
 
 (in-ns 'user)
-(defn uptime []
+(require 'clojure.string) ; to satisfy clj-kondo :)
+#_{:clj-kondo/ignore [:unused-private-var]}
+(defn- uptime []
   (-> (java.lang.management.ManagementFactory/getRuntimeMXBean)
       (.getUptime)
       (java.time.Duration/ofMillis)