From 79319d0596ac74c4b271c3b0367a759183893f92 Mon Sep 17 00:00:00 2001 From: Bozhidar Batsov Date: Wed, 9 Jan 2019 10:58:17 +0200 Subject: [PATCH] Regenerate the manual --- docs/nrepl/about/contributing.html | 15 ++--- docs/nrepl/design/middleware.html | 66 ++++++++++++++++++ docs/nrepl/index.html | 92 +++++++++++++++++++------- docs/nrepl/third_party_middleware.html | 17 ++++- docs/sitemap.xml | 90 ++++++++++++------------- 5 files changed, 199 insertions(+), 81 deletions(-) diff --git a/docs/nrepl/about/contributing.html b/docs/nrepl/about/contributing.html index a5abc72..a6d5ef7 100644 --- a/docs/nrepl/about/contributing.html +++ b/docs/nrepl/about/contributing.html @@ -258,7 +258,7 @@

Funding

We welcome both individual and corporate sponsors! We also offer a wide array of funding channels to account -for your preferences (although currently Open Collective is our preferred funding platform).

+for your preferences (although currently Open Collective is our preferred funding platform).

If you’re working in a company that’s making significant use of nREPL we’d appreciate it if you suggest to your company @@ -266,23 +266,20 @@

Funding

You can support the development of nREPL, CIDER, clojure-mode and inf-clojure via -Open Collective, -Salt, +Open Collective, Patreon, -Liberapay and PayPal.

-
-
-

Paypal

+Liberapay and +PayPal.

Open Collective

diff --git a/docs/nrepl/design/middleware.html b/docs/nrepl/design/middleware.html index 685aa46..4fe6b51 100644 --- a/docs/nrepl/design/middleware.html +++ b/docs/nrepl/design/middleware.html @@ -392,6 +392,19 @@

Sessions

Pretty Printing

+
+ + + + + +
+ + +Pretty-printing support was added in nREPL 0.5 and the API is still +considered experimental. +
+

nREPL includes a pr-values middleware to print the results of evaluated forms as strings for returning to the client. By default, this will use either @@ -412,6 +425,59 @@

Pretty :print-options {:print-width 120}}

+
+ + + + + +
+ + +
+

A note for client authors - passing strings will work just fine as +well (using the bencode transport you can’t pass keywords and symbols +as anyways).

+
+
+
+
{"op" "eval"
+ "code" "(+ 1 1)"
+ "printer" "my.custom/print-value"
+ "print-options" {"print-width" 120}}
+
+
+
+

nREPL will take of converting the keys of the print-options map to +keywords, so they’d work as expected with their respective printers.

+
+
+
+
+

The requirement for the printer function are the following:

+
+
+
    +
  • +

    It should take one or two arguments - a value to print, and an optional print options map.

    +
    • +
  • +

    It should return the printed value as a string. This means you can’t use directly +functions like clojure.pprint/pprint, as they output the printed value instead of returning +it as a string.

    +
    • +
  • +

    The printer function should have no side-effects.

    +
    • +
  • +

    In the absence of print options it should ideally respect Clojure’s print dynamic vars - e.g. print-length, print-right-margin, etc.

    +
    • +
+
+
+

Great examples of functions that honour the API contract are +zprint.core/zprint-str and puget.printer/pprint-str.

+
diff --git a/docs/nrepl/index.html b/docs/nrepl/index.html index 6ff98f8..f91ded8 100644 --- a/docs/nrepl/index.html +++ b/docs/nrepl/index.html @@ -182,7 +182,7 @@

nREPL

Overview

-

nREPL is a Clojure network REPL that provides a REPL server and +

nREPL is a Clojure network REPL that provides a REPL server and client, along with some common APIs of use to IDEs and other tools that may need to evaluate Clojure code in remote environments.

@@ -208,13 +208,77 @@

Why nREPL?

implement it, with allowances for hosts that lack the concurrency primitives to support e.g. asynchronous evaluation, interrupts, etc.

-
-

For more information about the motivation, architecture, use cases, and +

+ + + + + +
+ + +For more information about the motivation, architecture, use cases, and discussion related to nREPL, see the original design notes, available here, and the notes and discussion -around its recent redesign.[1]

+around its recent redesign.[1] +
+
+
+ +
+

Beyond Clojure

+
+
+

While this site is mostly about nREPL’s reference (canonical) Clojure implementation, +it’s important to point out that the nREPL protocol is language-agnostic and can be +leveraged for many languages that have the ability to evaluate code +at runtime.

+
+
+

One way to describe nREPL would be as something similar in +nature to the Language Server Protocol. nREPL is not nearly as +ambitious as LSP, but on the other hand it’s also much simpler and it’s trivial to +create nREPL clients in any language.

+
+
+ + + + + +
+ + +You can find some alternative nREPL implementations and more on the subject here. +
+
+
+
+
+

Community-Driven

+
+
+

One of the defining attributes of nREPL is that it’s a project built by +the Clojure community for the Clojure community. Making it easy for everyone +interested to participate in the development of nREPL was one of the biggest +reasons why we decided to leave the "Clojure Contrib" umbrella.

+
+
+

Everyone’s welcome to get involved in the project, so we can take it to the next level!

+
+
+ + + + + +
+ + +Check out the how you can help nREPL here. +
@@ -248,26 +312,6 @@

Status

-
-

Beyond Clojure

-
-
-

While this site is mostly about nREPL’s reference (canonical) Clojure implementation, -it’s important to point out that the nREPL protocol is language-agnostic and can be -leveraged for many languages that have the ability to evaluate code -at runtime.

-
-
-

One way to describe nREPL would be as something similar in -nature to the Language Server Protocol. nREPL is not nearly as -ambitious as LSP, but on the other hand it’s also much simpler and it’s trivial to -create nREPL clients in any language.

-
-
-

You can find some alternative nREPL implementations and more on subject here.

-
-
-
diff --git a/docs/nrepl/third_party_middleware.html b/docs/nrepl/third_party_middleware.html index c77b33e..b8d4d23 100644 --- a/docs/nrepl/third_party_middleware.html +++ b/docs/nrepl/third_party_middleware.html @@ -203,11 +203,22 @@

refactor-nrepl: A collection of functionality designed to support editor refactoring features.

  • -

    sayid: A powerful tracing/debugging tool. It is a great alternative of CIDER-nREPL’s -basic tracing functionality.

    +

    iced-nrepl: nREPL middleware to support vim-iced.

    +
    • + +

    +
    + +
    +

    Debugging

    +
    +
    +
      +
    • +

      sayid: A powerful tracing/debugging tool. It is a great alternative of CIDER-nREPL’s basic tracing functionality.

    • -

      iced-nrepl: nREPL middleware to support vim-iced.

      +

      scope-capture-nrepl: A companion library to scope-capture, providing an nREPL middleware that lets you put your REPL in the context of an Execution Point.

    diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 5f59775..ceaedb1 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -2,182 +2,182 @@ https://nrepl.org/nrepl/about/changelog.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/usage/server.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/usage/misc.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/usage/clients.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/troubleshooting.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/third_party_middleware.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/ops.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/installation.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/index.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/hacking_on_nrepl.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/faq.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/design/transports.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/design/overview.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/design/middleware.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/design/handlers.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/beyond_clojure.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/additional_resources.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/about/team.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/about/support.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/about/release_policy.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/about/license.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/about/history.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/about/contributing.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/design/transports.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/about/contributing.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/usage/misc.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/usage/clients.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/troubleshooting.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/third_party_middleware.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/ops.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/installation.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/index.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/hacking_on_nrepl.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/faq.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/usage/server.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/design/overview.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/design/middleware.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/design/handlers.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/additional_resources.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/about/team.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/about/support.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/about/release_policy.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/about/license.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/about/history.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z https://nrepl.org/nrepl/0.5.3/about/changelog.html -2019-01-04T08:51:59.206Z +2019-01-09T08:57:44.754Z \ No newline at end of file