update docs for how clojure cli jack in works

[dpsutton]

following the recent changes, update the docs so its clear what cider-jack-in is hoping to accomplish and how the user can customize this.

[dpsutton]

note to self:

• mention jvm options (eg, "-J-Djdk.attach.allowAttachSelf" see comments on [Fix #2941] Use main args in :cider/nrepl alias for clojure cli #2970)
• mention aliases in cider-clojure-cli-global-options (current behavior) and cider-clojure-cli-aliases
• this is a bit of a workaround until clojure cli is updated so that -A doesn't pass main args and is prevalent enough in the wild that this can all just go back to a single cider-clojure-cli-global-options

[practicalli-johnny]

When defining user aliases a : is inserted after the -M and before the user defined alias string.
However, the alias names all start with a :, so the command line assembled by Cider contains -M::user/alias-name:cider/nrepl

This feature does not seem to affect operation of cider-jack-in and aliases seem to be incorporated in the REPL.

Example:
I defined a .dir-locals.el file as follows

((nil . ((cider-clojure-cli-aliases . ":env/test:lib/ring-mock"))))

Running cider-jack-in-clj and CIDER command line is output in the *messages* buffer

[nREPL] Starting server via /usr/local/bin/clojure -Sdeps '{:deps {nrepl/nrepl {:mvn/version "0.8.3"} cider/cider-nrepl {:mvn/version "0.26.0"}} :aliases {:cider/nrepl {:main-opts ["-m" "nrepl.cmdline" "--middleware" "[cider.nrepl/cider-middleware]"]}}}' -M::env/test:lib/ring-mock:cider/nrepl

[vemv]

The docs are probably better by now, however would either of you enjoy having a look again?

(I also will soon)

Cheers - V

[github-actions]

This issue has been automatically marked as stale because it has not had any recent activity. It will be closed soon if no further activity occurs. Thank you for your contribution and understanding!

[github-actions]

This issue been automatically closed due to lack of activity. Feel free to re-open it if you ever come back to it.