Liking cljdoc? Tell your friends :D

NREPL Middleware GitHub Actions status |pink-gorilla/gorilla-middlewareCodecov ProjectClojars Project

features

  • nrepl websocket relay (browsers can not connect to normal tcp ports)
  • nrepl middleware that renders evalued results from notebook session
  • nepl middlewre that sniffs evals on other nrepl session
  • nrepl client (clj and cljs)on core.async

Middleware cli demo

To test picasso and sniffer middleware run 3 different terminal windows and execute this 3 commands in this order

clojure -M:relay  ; this runs jetty http server with websocket relay (port 9000)
clojure -M:client -m sink   ; will listen to sniffed evals
clojure -M:client -m ide -i ./snippets/sniffer.edn 
clojure -M:client -m ide -i ./snippets/sniffer-min.edn

 ; will do a few evals that wil show up on listen

WebRelay websocket demo

To see a simple websocket frontend, run in 2 terminal windows:

clojure -M:relay  ; this runs jetty http server with websocket relay (port 9000)
clojure -M:demo         ; browser app served with shadow-cljs dev server port 8000

Design of websocket relay

Server

  • Browser can only do websocket and not normal sockets.
  • Server Relay runs as ring request-handler, and returns new websocket handler
  • the websocket handler creates a new nrel client connection, and then forwards requests in both ways.
  • currently we create nrepl server to connect to.

Browser:

  • The code is spit into several stateful components.
  • layer1 is websocket connection. Provides two core async channels. Manages connection / reconnection.
  • layer2: request router. Manages pending requests, returns for each nrepl-op a dedicated return channel, which is sent fragment by fragment. The request channel will be closed after the last fragment is received.
  • layer3:

Logging:

  • Lots of logging with timbre at DEBUG level
  • If you dot want lots of output, set loglevel to INFO

Test if javadoc is installed:

clj -Srepro -e "(import '(jdk.javadoc.doclet Doclet))"

Can you improve this documentation? These fine people already did:
awb99 & Andreas Steffan
Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close