Skip to content

Commit 1b4c2ea

Browse files
committed
[Docs] Add a page about ClojureCLR
1 parent d7a5200 commit 1b4c2ea

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
= ClojureCLR
2+
3+
== Current Status
4+
5+
ClojureCLR on CIDER is not great due to the lack of a fully-functional nREPL
6+
server for ClojureCLR. There are currently two options:
7+
8+
- https://github.com/clojure/clr.tools.nrepl[clr.tools.nrepl]: A direct (but incomplete) port of the reference Clojure nREPL server.
9+
- https://github.com/arcadia-unity/Arcadia/blob/master/Editor/NRepl.cs[Arcadia's nREPL]: A basic, but working nREPL implementation in C#.
10+
11+
If you need to use CIDER with ClojureCLR today Arcadia's nREPL is your only usable option. That being said - `clr.tools.nrepl` is a much
12+
more sophisticated project and ideally we should get it over to the finish line.
13+
14+
== Usage
15+
16+
NOTE: Contributions welcome!
17+
18+
As `cider-jack-in` doesn't support ClojureCLR projects out-of-the-box currently, you'll need to start an nREPL server externally and
19+
connect to it with `cider-connect`.
20+
21+
== Plans
22+
23+
In an ideal world we'll achieve the following objectives:
24+
25+
- out-of-the-box ClojureCLR support with `cider-jack-in`
26+
- feature parity between Clojure's nREPL implementation and `clr.tools.nrepl` (the project can use some help)
27+
- adapting `cider-nrepl` for ClojureCLR (some of its codebase is JVM-specific)
28+
29+
Given that Bozhidar's knowledge of CLR and time are limited, it'd be great if we manage to find some volunteers to help with the
30+
work that's needed in this direction. In particular it'd be amazing to complete `clr.tools.nrepl`, as the project needs relatively
31+
little work to be fully usable.

doc/modules/ROOT/pages/platforms/overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Right now CIDER the supports to some extent the following:
2727

2828
* xref:platforms/babashka.adoc[Babashka]
2929
* xref:platforms/nbb.adoc[nbb]
30-
* ClojureCLR (via Arcadia's nREPL server)
30+
* xref:platforms/clojureclr.adoc[ClojureCLR]
3131
* Lumo (via https://github.com/djblue/nrepl-cljs)
3232
* xref:platforms/other_platforms.adoc[scittle, joyride & friends]
3333

0 commit comments

Comments
 (0)