Allow user provided commands for cider-jack-in (#3286)

Author: benjamin-asdf

cider.el

@@ -510,6 +510,19 @@ specifying the artifact ID, and the second element the version number."
                        (string :tag "Artifact ID")
                        (string :tag "Version"))))
 
+(defvar-local cider-jack-in-cmd nil
+  "The custom command used to start a nrepl server.
+This is used by `cider-jack-in`.
+
+If this variable is set, its value will be
+used as the command to start the nrepl server
+instead of the default command inferred from
+the project type.
+
+This allows for fine-grained control over the jack-in process.
+The value should be a string representing the command to start
+the nrepl server, such as \"nbb nrepl-server\".")
+
 (defvar cider-jack-in-lein-plugins nil
   "List of Leiningen plugins to be injected at jack-in.
 Each element is a list of artifact name and version, followed optionally by
@@ -1494,43 +1507,46 @@ PARAMS is a plist with the following keys (non-exhaustive list)
 
 :project-type optional, the project type to create the command for; see
 `cider-jack-in-command' for the list of valid types)."
-  (let* ((params (cider--update-do-prompt params))
-         (project-dir (plist-get params :project-dir))
-         (params-project-type (plist-get params :project-type))
-         (project-type (or params-project-type
-                           (cider-project-type project-dir)))
-         (command (cider-jack-in-command project-type))
-         (command-resolved (cider-jack-in-resolve-command project-type))
-         (command-global-opts (cider-jack-in-global-options project-type))
-         (command-params (cider-jack-in-params project-type)))
-    (if command-resolved
-        (with-current-buffer (or (plist-get params :--context-buffer)
-                                 (current-buffer))
-          (let* ((command-params (if (plist-get params :do-prompt)
-                                     (read-string "nREPL server command: "
-                                                  command-params
-                                                  'cider--jack-in-nrepl-params-history)
-                                   command-params))
-                 (cmd-params (if cider-inject-dependencies-at-jack-in
-                                 (cider-inject-jack-in-dependencies command-global-opts command-params project-type)
-                               command-params)))
-            (if (or project-dir cider-allow-jack-in-without-project)
-                (when (or project-dir
-                          (eq cider-allow-jack-in-without-project t)
-                          (and (null project-dir)
-                               (eq cider-allow-jack-in-without-project 'warn)
-                               (or params-project-type
-                                   (y-or-n-p "Are you sure you want to run `cider-jack-in' without a Clojure project? "))))
-                  (let ((cmd (format "%s %s" command-resolved (if (or (string-equal command "powershell")
-                                                                      (string-equal command "pwsh"))
-                                                                  (cider--powershell-encode-command cmd-params)
-                                                                cmd-params))))
-                    (plist-put params :jack-in-cmd (if (or cider-edit-jack-in-command
-                                                           (plist-get params :edit-jack-in-command))
-                                                       (read-string "jack-in command: " cmd 'cider--jack-in-cmd-history)
-                                                     cmd))))
-              (user-error "`cider-jack-in' is not allowed without a Clojure project"))))
-      (user-error "The %s executable isn't on your `exec-path'" command))))
+  (cond
+   ((plist-get params :jack-in-cmd) params)
+   (cider-jack-in-cmd (plist-put params :jack-in-cmd cider-jack-in-cmd))
+   (t (let* ((params (cider--update-do-prompt params))
+           (project-dir (plist-get params :project-dir))
+           (params-project-type (plist-get params :project-type))
+           (project-type (or params-project-type
+                             (cider-project-type project-dir)))
+           (command (cider-jack-in-command project-type))
+           (command-resolved (cider-jack-in-resolve-command project-type))
+           (command-global-opts (cider-jack-in-global-options project-type))
+           (command-params (cider-jack-in-params project-type)))
+      (if command-resolved
+          (with-current-buffer (or (plist-get params :--context-buffer)
+                                   (current-buffer))
+            (let* ((command-params (if (plist-get params :do-prompt)
+                                       (read-string "nREPL server command: "
+                                                    command-params
+                                                    'cider--jack-in-nrepl-params-history)
+                                     command-params))
+                   (cmd-params (if cider-inject-dependencies-at-jack-in
+                                   (cider-inject-jack-in-dependencies command-global-opts command-params project-type)
+                                 command-params)))
+              (if (or project-dir cider-allow-jack-in-without-project)
+                  (when (or project-dir
+                            (eq cider-allow-jack-in-without-project t)
+                            (and (null project-dir)
+                                 (eq cider-allow-jack-in-without-project 'warn)
+                                 (or params-project-type
+                                     (y-or-n-p "Are you sure you want to run `cider-jack-in' without a Clojure project? "))))
+                    (let ((cmd (format "%s %s" command-resolved (if (or (string-equal command "powershell")
+                                                                        (string-equal command "pwsh"))
+                                                                    (cider--powershell-encode-command cmd-params)
+                                                                  cmd-params))))
+                      (plist-put params :jack-in-cmd (if (or cider-edit-jack-in-command
+                                                             (plist-get params :edit-jack-in-command))
+                                                         (read-string "jack-in command: " cmd 'cider--jack-in-cmd-history)
+                                                       cmd))))
+                (user-error "`cider-jack-in' is not allowed without a Clojure project"))))
+        (user-error "The %s executable isn't on your `exec-path'" command))))))
 
 (defun cider--update-host-port (params)
   "Update :host and :port; or :socket-file in PARAMS."

doc/modules/ROOT/pages/basics/up_and_running.adoc

@@ -241,6 +241,40 @@ wait`)
 * `cider-shadow-cljs-parameters` - the task to start a REPL server (`server` by default)
 * `cider-shadow-cljs-global-options`
 
+=== Override the Jack-In Command
+
+Which Jack-In Command is used is based on the project type. You can override the Jack-In Command either project-wide or as an argument in Lisp.
+This allows for fine-grained control over how cider starts the nrepl-server.
+
+The precedence order for determining the Jack-In Command is:
+1) :jack-in-cmd if provided as a parameter,
+2) `cider-jack-in-command` if set as a directory local variable, and
+3) inferred from the project type (the default).
+
+==== Setting a project-wide command
+
+You can set a local variable `cider-jack-in-command` to override the jack-in command.
+
+[source,emacs-lisp]
+----
+((nil
+  (cider-jack-in-cmd . "nbb nrepl-server")))
+----
+
+==== Passing the Command Programmatically as a Parameter
+
+You can provide an override Jack-In command as an argument to `cider-jack-in`.
+Here is an example Nbb Jack-In command, providing a custom `:jack-in-cmd`.
+
+[source,emacs-lisp]
+----
+(defun cider-jack-in-nbb-2 ()
+  "Start a Cider nREPL server with the 'nbb nrepl-server' command."
+  (interactive)
+  (cider-jack-in-clj '(:jack-in-cmd "nbb nrepl-server")))
+----
+
+
 == Connect to a Running nREPL Server
 
 If you have an nREPL server already running, CIDER can connect to

test/cider-tests.el

@@ -523,7 +523,22 @@
         (spy-on 'cider-project-type :and-return-value 'clojure-cli)
         (spy-on 'cider-jack-in-resolve-command :and-return-value "clojure")
         (expect (plist-get (cider--update-jack-in-cmd nil) :jack-in-cmd)
-                :to-equal expected)))))
+                :to-equal expected))))
+  (describe "Override jack-in command"
+   (it "Uses the param, if provided"
+    (let* ((params '(:jack-in-cmd "Snowcrash"))
+           (params (cider--update-jack-in-cmd params)))
+      (expect params :to-equal '(:jack-in-cmd "Snowcrash"))))
+   (it "Uses the `cider-jack-in-cmd', if provided"
+    (let* ((params '())
+           (cider-jack-in-cmd "Seveneves")
+           (params (cider--update-jack-in-cmd params)))
+      (expect params :to-equal '(:jack-in-cmd "Seveneves"))))
+   (it "Uses params over `cider-jack-in-cmd', if provided"
+    (let* ((params '(:jack-in-cmd "Snowcrash"))
+           (cider-jack-in-cmd "Seveneves")
+           (params (cider--update-jack-in-cmd params)))
+      (expect params :to-equal '(:jack-in-cmd "Snowcrash"))))))
 
 (defmacro with-temp-shadow-config (contents &rest body)
   "Run BODY with a mocked shadow-cljs.edn project file with the CONTENTS."