Skip to content

Commit 91003f3

Browse files
committed
Update site docs
1 parent 5f3677f commit 91003f3

19 files changed

+1206
-1090
lines changed

docs/cider-nrepl/about/history.html

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -239,31 +239,22 @@ <h1 class="page">History</h1>
239239
to build complex features like an interactive debugger. Fortunately, the assumption turned out to be correct.
240240
Today <code>cider-nrepl</code> provides pretty much everything that a Clojure development environment might need (and more).</p>
241241
</div>
242-
<div class="literalblock">
243-
<div class="content">
244-
<pre> We quickly
245-
realized that there was nothing CIDER specific in those middleware and we've
246-
started to encourage more tool authors to leverage them. Today `cider-nrepl` is
247-
developed and released independently from CIDER and is used by most of the
248-
nREPL-based editors and IDEs out there, which is a great example of team work.
249-
Eventually `cider-nrepl` served as the inspiration for more similar
250-
middleware libraries - e.g. `refactor-nrepl`, `iced-nrepl` and `sayid`.</pre>
251-
</div>
242+
<div class="paragraph">
243+
<p>We quickly realized that there was nothing CIDER specific in those middleware
244+
and we&#8217;ve started to encourage more tool authors to leverage them. Today
245+
<code>cider-nrepl</code> is developed and released independently from CIDER and is used by
246+
most of the nREPL-based editors and IDEs out there, which is a great example of
247+
team work. Eventually <code>cider-nrepl</code> served as the inspiration for more similar
248+
middleware libraries - e.g. <code>refactor-nrepl</code>, <code>iced-nrepl</code> and <code>sayid</code>.</p>
252249
</div>
253250
<div class="paragraph">
254-
<p>More recently we&#8217;ve been working to extract the core functionality out of <code>cider-nrepl</code>
255-
into a <a href="https://github.com/clojure-emacs/orchard">REPL-agnostic library</a>.<sup class="footnote">[<a id="_footnoteref_1" class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup></p>
251+
<p>In 2019, the core functionality has been extracted out of <code>cider-nrepl</code> into
252+
<a href="https://github.com/clojure-emacs/orchard">Orchard</a>, a REPL-agnostic library.</p>
256253
</div>
257254
<div class="paragraph">
258255
<p>You can check out <a href="https://www.youtube.com/watch?v=4X-1fJm25Ww">this talk</a>, which explores the birth of
259256
<code>cider-nrepl</code>.</p>
260257
</div>
261-
<div id="footnotes">
262-
<hr>
263-
<div class="footnote" id="_footnotedef_1">
264-
<a href="#_footnoteref_1">1</a>. This process started in 2019.
265-
</div>
266-
</div>
267258
<nav class="pagination">
268259
<span class="prev"><a href="../faq.html">FAQ</a></span>
269260
<span class="next"><a href="changelog.html">Changelog</a></span>

docs/cider-nrepl/compatibility.html

Lines changed: 21 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -233,10 +233,9 @@ <h1 class="page">Compatibility</h1>
233233
<h2 id="java"><a class="anchor" href="#java"></a>Java</h2>
234234
<div class="sectionbody">
235235
<div class="paragraph">
236-
<p><code>cider-nrepl</code> officially targets Java 8, Java 11 and the most recent rapid
237-
release version (e.g. Java 13). More generally speaking - we aim
238-
to support all Java releases that are currently officially supported
239-
by Oracle.</p>
236+
<p><code>cider-nrepl</code> officially targets Java 8, 11, 17, 21, and the most recent rapid
237+
release version (e.g. Java 22). More generally speaking - we aim to support all
238+
Java releases that are currently officially supported by Oracle.</p>
240239
</div>
241240
</div>
242241
</div>
@@ -293,8 +292,8 @@ <h2 id="nrepl"><a class="anchor" href="#nrepl"></a>nREPL</h2>
293292
<i class="fa icon-note" title="Note"></i>
294293
</td>
295294
<td class="content">
296-
We pay special attention to supporting whatever nREPL is bundled with the current stable Leiningen
297-
and Boot releases.
295+
We pay special attention to supporting whatever nREPL is bundled with the
296+
current stable Leiningen release.
298297
</td>
299298
</tr>
300299
</table>
@@ -305,9 +304,20 @@ <h2 id="nrepl"><a class="anchor" href="#nrepl"></a>nREPL</h2>
305304
<h2 id="compatibility-matrix"><a class="anchor" href="#compatibility-matrix"></a>Compatibility Matrix</h2>
306305
<div class="sectionbody">
307306
<div class="paragraph">
308-
<p>Below you can find the official compatibility matrix for <code>cider-nrepl</code>. For a
309-
very long time the project targeted nREPL 0.2.x, but the
310-
requirements were bumped to nREPL 0.6 in recent versions.</p>
307+
<p>Below you can find the official compatibility matrix for <code>cider-nrepl</code>.</p>
308+
</div>
309+
<div class="admonitionblock note">
310+
<table>
311+
<tr>
312+
<td class="icon">
313+
<i class="fa icon-note" title="Note"></i>
314+
</td>
315+
<td class="content">
316+
The matrix lists only the last versions of <code>cider-nrepl</code> that supports the
317+
given compatibility tuple.
318+
</td>
319+
</tr>
320+
</table>
311321
</div>
312322
<table class="tableblock frame-all grid-all stretch">
313323
<caption class="title">Table 1. Compatibility Matrix</caption>
@@ -339,30 +349,6 @@ <h2 id="compatibility-matrix"><a class="anchor" href="#compatibility-matrix"></a
339349
<td class="tableblock halign-left valign-top"><p class="tableblock">0.4.x</p></td>
340350
</tr>
341351
<tr>
342-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.21</p></td>
343-
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
344-
<td class="tableblock halign-left valign-top"><p class="tableblock">1.8</p></td>
345-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.6</p></td>
346-
</tr>
347-
<tr>
348-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.22</p></td>
349-
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
350-
<td class="tableblock halign-left valign-top"><p class="tableblock">1.8</p></td>
351-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.6</p></td>
352-
</tr>
353-
<tr>
354-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.23</p></td>
355-
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
356-
<td class="tableblock halign-left valign-top"><p class="tableblock">1.8</p></td>
357-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.6</p></td>
358-
</tr>
359-
<tr>
360-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.24</p></td>
361-
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
362-
<td class="tableblock halign-left valign-top"><p class="tableblock">1.8</p></td>
363-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.6</p></td>
364-
</tr>
365-
<tr>
366352
<td class="tableblock halign-left valign-top"><p class="tableblock">0.25</p></td>
367353
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
368354
<td class="tableblock halign-left valign-top"><p class="tableblock">1.8</p></td>
@@ -375,13 +361,13 @@ <h2 id="compatibility-matrix"><a class="anchor" href="#compatibility-matrix"></a
375361
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
376362
</tr>
377363
<tr>
378-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.48.0</p></td>
364+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.47.0</p></td>
379365
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
380366
<td class="tableblock halign-left valign-top"><p class="tableblock">1.9</p></td>
381367
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>
382368
</tr>
383369
<tr>
384-
<td class="tableblock halign-left valign-top"><p class="tableblock">0.48.0</p></td>
370+
<td class="tableblock halign-left valign-top"><p class="tableblock">0.49.0</p></td>
385371
<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
386372
<td class="tableblock halign-left valign-top"><p class="tableblock">1.10</p></td>
387373
<td class="tableblock halign-left valign-top"><p class="tableblock">1.0.0</p></td>

docs/cider-nrepl/index.html

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -342,15 +342,29 @@ <h3 id="clojurescript-support"><a class="anchor" href="#clojurescript-support"><
342342
<div class="sect2">
343343
<h3 id="isolated-runtime-dependencies"><a class="anchor" href="#isolated-runtime-dependencies"></a>Isolated Runtime Dependencies</h3>
344344
<div class="paragraph">
345-
<p>All of cider-nrepl&#8217;s dependencies are processed with
345+
<p>Most of cider-nrepl&#8217;s dependencies are processed with
346346
<a href="https://github.com/benedekfazekas/mranderson">mranderson</a>, so that
347347
they won&#8217;t collide with the dependencies of your own projects. This
348-
basically means that cider-nrepl doesn&#8217;t have any runtime dependencies in
348+
basically means that cider-nrepl has almost no runtime dependencies in
349349
the production artifact - just copies of the deps inlined with changed
350350
namespaces/packages. It&#8217;s a bit ugly and painful, but it gets the job
351351
done.</p>
352352
</div>
353353
<div class="paragraph">
354+
<p>The exclusion to this rule are the artifacts that are themselves part of the
355+
CIDER ecosystem and have to runtime dependencies of their own:</p>
356+
</div>
357+
<div class="ulist">
358+
<ul>
359+
<li>
360+
<p><a href="https://github.com/clojure-emacs/orchard">Orchard</a></p>
361+
</li>
362+
<li>
363+
<p><a href="https://github.com/clojure-emacs/logjam">Logjam</a></p>
364+
</li>
365+
</ul>
366+
</div>
367+
<div class="paragraph">
354368
<p>If someone has better ideas how to isolate our runtime dependencies -
355369
we&#8217;re all ears!</p>
356370
</div>

docs/cider-nrepl/internals.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ <h1 class="page">CIDER nREPL Internals</h1>
233233
<h2 id="lazy-middleware-loading"><a class="anchor" href="#lazy-middleware-loading"></a>Lazy middleware loading</h2>
234234
<div class="sectionbody">
235235
<div class="paragraph">
236-
<p>Eager loading of all of `cider-nrepl&#8217;s middleware resulted in a significant impact to the
236+
<p>Eager loading of all of cider-nrepl&#8217;s middleware resulted in a significant impact to the
237237
startup time of the nREPL server. To mitigate this we&#8217;ve devised a strategy to postpone
238238
the actual initialization of some middleware until the first time it&#8217;s actually used
239239
by a client.</p>
@@ -292,11 +292,11 @@ <h2 id="clojurescript-support"><a class="anchor" href="#clojurescript-support"><
292292
<h2 id="dependency-obfuscation"><a class="anchor" href="#dependency-obfuscation"></a>Dependency obfuscation</h2>
293293
<div class="sectionbody">
294294
<div class="paragraph">
295-
<p>`cider-nrepl&#8217;s dependency would conflict with the dependencies of the application using it,
295+
<p>cider-nrepl&#8217;s dependency would conflict with the dependencies of the application using it,
296296
so we have to take some care to avoid such situation.</p>
297297
</div>
298298
<div class="paragraph">
299-
<p>All of cider-nrepl&#8217;s dependencies are processed with
299+
<p>Most of cider-nrepl&#8217;s dependencies are processed with
300300
<a href="https://github.com/benedekfazekas/mranderson">mranderson</a>, so that
301301
they won&#8217;t collide with the dependencies of your own projects. This
302302
basically means that cider-nrepl doesn&#8217;t have any runtime dependencies in
@@ -305,7 +305,7 @@ <h2 id="dependency-obfuscation"><a class="anchor" href="#dependency-obfuscation"
305305
</div>
306306
<div class="paragraph">
307307
<p>This means that <code>cider-nrepl</code> has to also take some steps to hide the inlined namespaces,
308-
so they won&#8217;t pollute the results users would be interested in. Pretty much all of `cider-nrepl&#8217;s
308+
so they won&#8217;t pollute the results users would be interested in. Pretty much all of cider-nrepl&#8217;s
309309
ops would filter out the inlined namespaces.</p>
310310
</div>
311311
</div>

docs/cider-nrepl/nrepl-api/ops.html

Lines changed: 75 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1679,7 +1679,7 @@ <h3 id="inspect-push"><a class="anchor" href="#inspect-push"></a><code>inspect-p
16791679
<div class="sect2">
16801680
<h3 id="inspect-refresh"><a class="anchor" href="#inspect-refresh"></a><code>inspect-refresh</code></h3>
16811681
<div class="paragraph">
1682-
<p>Re-renders the currently inspected value.</p>
1682+
<p>Updates inspector with the provided config and re-renders the current value.</p>
16831683
</div>
16841684
<div class="dlist">
16851685
<dl>
@@ -1695,7 +1695,25 @@ <h3 id="inspect-refresh"><a class="anchor" href="#inspect-refresh"></a><code>ins
16951695
</dd>
16961696
<dt class="hdlist1">Optional parameters</dt>
16971697
<dd>
1698-
<p></p>
1698+
<div class="ulist">
1699+
<ul>
1700+
<li>
1701+
<p><code>:max-atom-length</code> New max length of single rendered value</p>
1702+
</li>
1703+
<li>
1704+
<p><code>:max-coll-size</code> New max size of rendered collection</p>
1705+
</li>
1706+
<li>
1707+
<p><code>:max-nested-depth</code> New max nested depth of rendered collection</p>
1708+
</li>
1709+
<li>
1710+
<p><code>:page-size</code> New page size</p>
1711+
</li>
1712+
<li>
1713+
<p><code>:view-mode</code> Mode of viewing the value - either <code>:normal</code> or <code>:object</code></p>
1714+
</li>
1715+
</ul>
1716+
</div>
16991717
</dd>
17001718
<dt class="hdlist1">Returns</dt>
17011719
<dd>
@@ -1728,7 +1746,7 @@ <h3 id="inspect-refresh"><a class="anchor" href="#inspect-refresh"></a><code>ins
17281746
<div class="sect2">
17291747
<h3 id="inspect-set-max-atom-length"><a class="anchor" href="#inspect-set-max-atom-length"></a><code>inspect-set-max-atom-length</code></h3>
17301748
<div class="paragraph">
1731-
<p>Set the max length of nested atoms to specified value.</p>
1749+
<p>[DEPRECATED - use <code>inspect-refresh</code> instead] Set the max length of nested atoms to specified value.</p>
17321750
</div>
17331751
<div class="dlist">
17341752
<dl>
@@ -1780,7 +1798,7 @@ <h3 id="inspect-set-max-atom-length"><a class="anchor" href="#inspect-set-max-at
17801798
<div class="sect2">
17811799
<h3 id="inspect-set-max-coll-size"><a class="anchor" href="#inspect-set-max-coll-size"></a><code>inspect-set-max-coll-size</code></h3>
17821800
<div class="paragraph">
1783-
<p>Set the number of nested collection members to display before truncating.</p>
1801+
<p>[DEPRECATED - use <code>inspect-refresh</code> instead] Set the number of nested collection members to display before truncating.</p>
17841802
</div>
17851803
<div class="dlist">
17861804
<dl>
@@ -1832,7 +1850,7 @@ <h3 id="inspect-set-max-coll-size"><a class="anchor" href="#inspect-set-max-coll
18321850
<div class="sect2">
18331851
<h3 id="inspect-set-max-nested-depth"><a class="anchor" href="#inspect-set-max-nested-depth"></a><code>inspect-set-max-nested-depth</code></h3>
18341852
<div class="paragraph">
1835-
<p>Set the maximum nested levels to display before truncating.</p>
1853+
<p>[DEPRECATED - use <code>inspect-refresh</code> instead] Set the maximum nested levels to display before truncating.</p>
18361854
</div>
18371855
<div class="dlist">
18381856
<dl>
@@ -1884,7 +1902,7 @@ <h3 id="inspect-set-max-nested-depth"><a class="anchor" href="#inspect-set-max-n
18841902
<div class="sect2">
18851903
<h3 id="inspect-set-page-size"><a class="anchor" href="#inspect-set-page-size"></a><code>inspect-set-page-size</code></h3>
18861904
<div class="paragraph">
1887-
<p>Sets the page size in paginated view to specified value.</p>
1905+
<p>[DEPRECATED - use <code>inspect-refresh</code> instead] Sets the page size in paginated view to specified value.</p>
18881906
</div>
18891907
<div class="dlist">
18901908
<dl>
@@ -2035,6 +2053,55 @@ <h3 id="inspect-tap-indexed"><a class="anchor" href="#inspect-tap-indexed"></a><
20352053
</div>
20362054
</div>
20372055
<div class="sect2">
2056+
<h3 id="inspect-toggle-view-mode"><a class="anchor" href="#inspect-toggle-view-mode"></a><code>inspect-toggle-view-mode</code></h3>
2057+
<div class="paragraph">
2058+
<p>Toggles the viewing mode of the inspector. This influences the way how inspector is rendering the current value. <code>:normal</code> is the default. When view mode is <code>:object</code>, any value will be rendered as a Java object (fields shown as is). View mode is automatically reset back to normal when navigating to child values.</p>
2059+
</div>
2060+
<div class="dlist">
2061+
<dl>
2062+
<dt class="hdlist1">Required parameters</dt>
2063+
<dd>
2064+
<div class="ulist">
2065+
<ul>
2066+
<li>
2067+
<p><code>:session</code> The current session</p>
2068+
</li>
2069+
</ul>
2070+
</div>
2071+
</dd>
2072+
<dt class="hdlist1">Optional parameters</dt>
2073+
<dd>
2074+
<p></p>
2075+
</dd>
2076+
<dt class="hdlist1">Returns</dt>
2077+
<dd>
2078+
<div class="ulist">
2079+
<ul>
2080+
<li>
2081+
<p><code>:doc-block-tags-fragments</code> May be absent. Represent the 'param', 'returns' and 'throws' sections a Java doc comment. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
2082+
</li>
2083+
<li>
2084+
<p><code>:doc-first-sentence-fragments</code> May be absent. Represents the first sentence of a Java doc comment. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
2085+
</li>
2086+
<li>
2087+
<p><code>:doc-fragments</code> May be absent. Represents the body of a Java doc comment, including the first sentence and excluding any block tags. It&#8217;s a vector of fragments, where fragment is a map with <code>:type</code> ('text' or 'html') and <code>:content</code> plain text or html markup, respectively</p>
2088+
</li>
2089+
<li>
2090+
<p><code>:path</code> Printed representation of current inspector path.</p>
2091+
</li>
2092+
<li>
2093+
<p><code>:status</code> "done"</p>
2094+
</li>
2095+
<li>
2096+
<p><code>:value</code> The inspector result. Contains a specially-formatted string that can be <code>read</code> and then rendered client-side.</p>
2097+
</li>
2098+
</ul>
2099+
</div>
2100+
</dd>
2101+
</dl>
2102+
</div>
2103+
</div>
2104+
<div class="sect2">
20382105
<h3 id="is-var-profiled"><a class="anchor" href="#is-var-profiled"></a><code>is-var-profiled</code></h3>
20392106
<div class="paragraph">
20402107
<p>Reports whether symbol is currently profiled.</p>
@@ -2727,7 +2794,7 @@ <h3 id="resources-list"><a class="anchor" href="#resources-list"></a><code>resou
27272794
<div class="sect2">
27282795
<h3 id="retest"><a class="anchor" href="#retest"></a><code>retest</code></h3>
27292796
<div class="paragraph">
2730-
<p>[DEPRECATED - <code>use test-var-query</code> instead] Run all tests in the project. If <code>load?</code> is truthy, all project namespaces are loaded; otherwise, only tests in presently loaded namespaces are run. Results are cached for exception retrieval and to enable re-running of failed/erring tests.</p>
2797+
<p>[DEPRECATED - use <code>test-var-query</code> instead] Run all tests in the project. If <code>load?</code> is truthy, all project namespaces are loaded; otherwise, only tests in presently loaded namespaces are run. Results are cached for exception retrieval and to enable re-running of failed/erring tests.</p>
27312798
</div>
27322799
<div class="dlist">
27332800
<dl>
@@ -3024,7 +3091,7 @@ <h3 id="stacktrace"><a class="anchor" href="#stacktrace"></a><code>stacktrace</c
30243091
<div class="sect2">
30253092
<h3 id="test"><a class="anchor" href="#test"></a><code>test</code></h3>
30263093
<div class="paragraph">
3027-
<p>[DEPRECATED - <code>use test-var-query</code> instead] Run tests in the specified namespace and return results. This accepts a set of <code>tests</code> to be run; if nil, runs all tests. Results are cached for exception retrieval and to enable re-running of failed/erring tests.</p>
3094+
<p>[DEPRECATED - use <code>test-var-query</code> instead] Run tests in the specified namespace and return results. This accepts a set of <code>tests</code> to be run; if nil, runs all tests. Results are cached for exception retrieval and to enable re-running of failed/erring tests.</p>
30283095
</div>
30293096
<div class="dlist">
30303097
<dl>

0 commit comments

Comments
 (0)