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.

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

Next release #19

Merged
merged 9 commits into from
Jan 2, 2025
Prev Previous commit
Next Next commit
docs: Add help for available parameters to connect function
liquidz committed Jan 2, 2025
commit dfdcee22d1f8a194d6a7009a6d0751eb38ee529c
12 changes: 11 additions & 1 deletion src/elin/handler/connect.clj
Original file line number Diff line number Diff line change
@@ -50,7 +50,17 @@

(m/=> connect [:=> [:cat e.s.handler/?Elin] any?])
(defn connect
"Connect to nREPL server."
"Connect to nREPL server.

.Available parameters
[%autowidth,cols=\"a,a\"]
|===
| Parameter | Description

| `[]` | the port number and the hostname will be detected by interceptors automatically.
| `[port]` | `localhost` will be used as the hostname.
| `[hostname port]` | the specified hostname and port number will be used for connection.
|==="
[{:as elin :component/keys [host] :keys [message]}]
(let [[{:keys [hostname port]} error] (e.u.param/parse ?ConnectParams (:params message))]
(if error