emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/cider 8146bb55c2: [Docs] Improve the docs about self-hoste


From: ELPA Syncer
Subject: [nongnu] elpa/cider 8146bb55c2: [Docs] Improve the docs about self-hosted ClojureScript REPLs
Date: Wed, 21 Dec 2022 03:58:35 -0500 (EST)

branch: elpa/cider
commit 8146bb55c29467725993088adc8cc82ac48c4bb3
Author: Bozhidar Batsov <bozhidar@batsov.dev>
Commit: Bozhidar Batsov <bozhidar@batsov.dev>

    [Docs] Improve the docs about self-hosted ClojureScript REPLs
---
 doc/modules/ROOT/nav.adoc                            |  2 +-
 doc/modules/ROOT/pages/cljs/other_repls.adoc         | 20 ++++++++++++++++++++
 doc/modules/ROOT/pages/platforms/babashka.adoc       |  8 +++++++-
 doc/modules/ROOT/pages/platforms/nbb.adoc            |  8 +++++++-
 ...scittle_and_friends.adoc => other_platforms.adoc} | 19 +++++++++++--------
 5 files changed, 46 insertions(+), 11 deletions(-)

diff --git a/doc/modules/ROOT/nav.adoc b/doc/modules/ROOT/nav.adoc
index 63802644db..d22f943b60 100644
--- a/doc/modules/ROOT/nav.adoc
+++ b/doc/modules/ROOT/nav.adoc
@@ -14,7 +14,7 @@
 ** xref:platforms/overview.adoc[Overview]
 ** xref:platforms/babashka.adoc[Babashka]
 ** xref:platforms/nbb.adoc[Nbb]
-** xref:platforms/scittle_and_friends.adoc[Scittle and Friends]
+** xref:platforms/other_platforms.adoc[Other Platforms]
 * Using CIDER
 ** xref:usage/interactive_programming.adoc[Interactive Programming]
 ** xref:usage/cider_mode.adoc[Using cider-mode]
diff --git a/doc/modules/ROOT/pages/cljs/other_repls.adoc 
b/doc/modules/ROOT/pages/cljs/other_repls.adoc
index 00d291dc69..43ae210312 100644
--- a/doc/modules/ROOT/pages/cljs/other_repls.adoc
+++ b/doc/modules/ROOT/pages/cljs/other_repls.adoc
@@ -86,3 +86,23 @@ and insert `dev`.
 . Connect to the running server with your browser. The address is printed on 
the terminal, but it's probably `+http://localhost:3000+`.
 
 For more information visit 
https://github.com/adzerk-oss/boot-cljs-repl[boot-cljs-repl].
+
+== nbb (node.js babashka)
+
+CIDER has built-in support for `nbb`. You can either jack in to an nbb project 
with `M-x clojure-jack-in-cljs`.
+
+or start its bundled nREPL server:
+
+  $ nbb nrepl-server
+
+and connect to it afterwards using `M-x cider-connect-cljs`.
+
+See the xref:platforms/nbb.adoc[dedicated page] for more details.
+
+== Other Self-hosted REPLs
+
+For all other self-hosted REPLs you can follow the instructions 
xref:platforms/other_platforms.adoc[here]. This will work fine with any 
well-behaved nREPL implementation, like those of:
+
+* https://github.com/babashka/nbb[nbb]
+* https://github.com/babashka/scittle[scittle]
+* https://github.com/BetterThanTomorrow/joyride[joyride]
diff --git a/doc/modules/ROOT/pages/platforms/babashka.adoc 
b/doc/modules/ROOT/pages/platforms/babashka.adoc
index 6af4785ae8..c576fdeba1 100644
--- a/doc/modules/ROOT/pages/platforms/babashka.adoc
+++ b/doc/modules/ROOT/pages/platforms/babashka.adoc
@@ -1,6 +1,12 @@
 = Babashka
 
-Babashka is highly compatible with Clojure, so it works with CIDER out of the 
box. All you need to do
+== Overview
+
+Babashka is highly compatible with Clojure, so it works with CIDER out of the 
box.
+
+== Usage
+
+All you need to do
 is start its bundled nREPL server:
 
   $ bb --nrepl-server
diff --git a/doc/modules/ROOT/pages/platforms/nbb.adoc 
b/doc/modules/ROOT/pages/platforms/nbb.adoc
index 4a21fd26ee..64cf59b633 100644
--- a/doc/modules/ROOT/pages/platforms/nbb.adoc
+++ b/doc/modules/ROOT/pages/platforms/nbb.adoc
@@ -1,9 +1,13 @@
 = https://github.com/babashka/nbb[nbb]
 
-Nbb's main goal is to make it easy to get started with ad hoc CLJS scripting 
on Node.js.
+== Overview
+
+Nbb's main goal is to make it easy to get started with ad hoc ClojureScript 
scripting on Node.js.
 
 It is highly compatible with ClojureScript, so it works with CIDER out of the 
box.
 
+== Usage
+
 You can either jack in to an nbb project with `M-x clojure-jack-in-cljs`.
 
 or start its bundled nREPL server:
@@ -11,3 +15,5 @@ or start its bundled nREPL server:
   $ nbb nrepl-server
 
 and connect to it afterwards using `M-x cider-connect-cljs`.
+
+NOTE: `cider-jack-in-cljs` works with nbb projects that are using `nbb.edn`.
diff --git a/doc/modules/ROOT/pages/platforms/scittle_and_friends.adoc 
b/doc/modules/ROOT/pages/platforms/other_platforms.adoc
similarity index 66%
rename from doc/modules/ROOT/pages/platforms/scittle_and_friends.adoc
rename to doc/modules/ROOT/pages/platforms/other_platforms.adoc
index 91ba6a9a4d..d5f617b740 100644
--- a/doc/modules/ROOT/pages/platforms/scittle_and_friends.adoc
+++ b/doc/modules/ROOT/pages/platforms/other_platforms.adoc
@@ -1,4 +1,4 @@
-= Scittle, Nbb, Joyride, and future (n)REPLs
+= Other Platforms
 
 == The Problem
 
@@ -18,12 +18,14 @@ make CIDER more runtime-agnostic.
 == The Solution
 
 As of CIDER 1.6, the default CIDER connection command `cider-connect-clj` is
-capable of connecting to any nREPL server that provides minimal required
-functionality.
+capable of connecting to any nREPL server that implements the core nREPL
+protocol interface.
 
 As such, all of these work:
-https://github.com/babashka/nbb[nbb],
-https://github.com/babashka/scittle[scittle], 
https://github.com/BetterThanTomorrow/joyride[joyride]
+
+* https://github.com/babashka/nbb[nbb]
+* https://github.com/babashka/scittle[scittle]
+* https://github.com/BetterThanTomorrow/joyride[joyride]
 
 First start an nREPL server (the project's Readme usually has a section
 on starting a nREPL server).
@@ -37,9 +39,10 @@ to connect to any Clojure(Script) nREPL server.
 Features:
 
 * Eval, load file etc.
-* Errors as overlays. (The default cider error buffer is not implemented 
currently).
+* Code completion.
+* Errors as overlays. (The default CIDER error buffer is not implemented 
currently).
 * Other nREPL features the server provides; This might be rather minimal.
 
-Nbb, Scittle and Joyride all have quite cool completions already.
+Basically you'll get every feature that's implemented by the nREPL server 
you're using.
 
-NOTE: For nbb you can alternatively connect via cljs, see 
xref:platform/nbb.adoc[Nbb]
+NOTE: For nbb you can alternatively connect via `cider-connect-cljs`, see 
xref:platform/nbb.adoc[nbb].



reply via email to

[Prev in Thread] Current Thread [Next in Thread]