Porting and attribution

Jonquil ports the idea of DrClojure to Jolt, lifting its pure code for the text-analysis core: the tokenizer, bracket matching, navigation, smart indent, formatter, and doc and completion lookup. UPSTREAM.md carries the file-by-file provenance table. This page carries the reasoning behind it, plus the Jolt fixes the port needed along the way.

The pin is DrClojure-Neo at commit 7056c61 (2026-09-28), recorded in UPSTREAM_PIN. Most of the lifted code dates from the earlier pin 41c56b8 (2026-09-22); 7056c61 brought its smart-indent fix and its Parinfer engine, which Jonquil wires to the editor through its own jonquil.parinfer-edit (off by default; see UPSTREAM.md).

What was lifted, and what was rebuilt

src/jonquil/syntax.clj is a straight lift of upstream's syntax.clj, and its test, test/jonquil/upstream/syntax_test.clj, ports upstream's own tests over unchanged in spirit. src/jonquil/parinfer.clj is a straight lift too, apart from one Jolt delta, and its test runs Parinfer's 154 official cases. Three files re-express upstream code rather than copy it: jonquil.paint re-expresses highlight-doc!, jonquil.edit re-expresses upstream's UI handlers as pure edit operations, and jonquil.console re-expresses upstream's attr-normal/attr-prompt/ attr-result/attr-error/attr-system as hex colours a GTK theme can use directly. jonquil.eval reworks upstream's eval engine rather than following its shape, since Jonquil's Stop and stdin handling need a different threading model than upstream's own.

Everything else, the GTK front end, the session and settings layers, the themes, and every help feature, is new code with no upstream counterpart.

The code deltas the lift needs

UPSTREAM.md lists every place the lifted files differ from upstream and why; each delta names its exit condition where it has one. The early Character/toLowerCase workaround is gone: Jolt v0.8.23, the documented minimum, carries the method, so those two sites went back to upstream's text on 2026-10-29.

Staying in sync

jolt upstream:diff lists the upstream commits since UPSTREAM_PIN that touch src or test. It fetches main from https://github.com/kimtg/DrClojure-Neo each time, so it needs no setup:

jolt upstream:diff

The first run clones upstream into ~/.cache/jonquil/drclojure-neo (under $XDG_CACHE_HOME when that's an absolute path), and later runs only fetch. To use a clone you already have, set DRCLOJURE_DIR to its folder. To compare against a fork or a mirror, set DRCLOJURE_URL. Over HTTPS the fetch never asks for credentials, so an HTTPS URL has to be public. An SSH URL uses your SSH setup, and GIT_SSH_COMMAND picks the key:

GIT_SSH_COMMAND='ssh -i ~/.ssh/<key> -o IdentitiesOnly=yes' \
  DRCLOJURE_URL=git@github.com:kimtg/DrClojure-Neo.git jolt upstream:diff

Review each commit, port what matters, and bump UPSTREAM_PIN to the new commit SHA in the same commit as the port, so UPSTREAM.md keeps matching the code Jonquil took from upstream.

The Jolt fixes this project needed along the way

Two reader bugs blocked the console's (read) outright: (read) from stdin failed on Jolt through LineNumberingPushbackReader, filed as jolt-lang/jolt#1133 (merged in jolt-lang/jolt#1134) and jolt-lang/jolt#1137 (merged in jolt-lang/jolt#1138, 2026-09-25). Every Jolt from v0.8.15 on carries both; the fixes landed well before that release, back when the getting-started requirement still named an exact main commit rather than a tagged version.

clojure.pprint/pprint used to ignore a bound *out* and write to the process's real stdout, so Jonquil left it out of the program namespace. The cause was that the one-argument pprint and (cl-format true ...) called clojure.core/print while *out* was still pprint's own buffer. That was filed as jolt-lang/jolt#1354 and fixed in jolt-lang/jolt#1355, which shipped in Jolt v0.8.22, and pprint is referred into the prompt's namespace the same way doc is. pp was an empty stub until jolt-lang/jolt#1389 made it expand to (pprint *1), as on the JVM. That shipped in Jolt v0.8.23, which Jonquil now needs, and pp is referred next to pprint.

The clojure-cli.repl lift: the inspector's view code

The inspector panel's own rendering logic is a second lift, this time from clojure-cli.repl, pinned at 775e858. Its terminal inspector keeps the pure half of the work, the functions that turn a value into a path, a type line, and a page of rows or a table, in one file: server/src/clojure_cli/repl/inspect.clj. src/jonquil/inspect/view.clj lifts that file outright, with its three nrepl.* requires dropped along with the nREPL middleware they served.

The one shape change the lift needed: upstream's functions all close over one shared, global (def view (atom nil)), since a single terminal inspector serves every client of one server. Jonquil's window keeps one pane per window instead, so every lifted function now takes the view atom as its first argument, and reads and swaps that one instead of a global; the two places that used to read a session's own bindings (start's *1, def-as's *ns*) take that value straight from their caller in place of the session lookup. Every other line inside the lifted functions is unchanged from upstream. UPSTREAM.md carries the exact delta, function by function; run-op, added at the end of the file, is Jonquil's own: the dispatcher that turns a throw into the current view plus a note, the way upstream's own nREPL middleware did for its wire replies.

clojure-cli.repl ships under EPL-1.0, the same licence DrClojure uses, so the lift needs no separate licensing text of its own: UPSTREAM.md's table already names the one file it covers.

Licence

Jonquil ports and adapts DrClojure by Kim Taegyoon and clojure-cli.repl's inspector, both distributed under the Eclipse Public License 1.0. Jonquil itself is under the Eclipse Public License 2.0 (see LICENSE and NOTICE in the repository root), and it distributes the code it took from both under that version too, which section 7 of EPL-1.0 allows once a new version is published. Code lifted from either keeps its original copyright, and UPSTREAM.md's table says exactly which files that covers.

This page is docs/guide/porting-and-attribution.md in the Jonquil repository.