Merge pull request #141 from clj-commons/hls/20250630-vars

Add `clj-commons.pretty.nrepl/wrap-pretty` nREPL middleware

Author: hlship

CHANGES.md

@@ -1,3 +1,9 @@
+## 3.5.0 -- UNRELEASED
+
+- Default style for `print-table` can be overridden via a dynamic var
+- Use a vertical bar (│) not a pipe character (|) as column separator in binary output
+- New `clj-commons.pretty.nrepl` namespace to set up pretty inside nREPL
+
 ## 3.4.1 -- 23 Jun 2025
 
 - Removed some reflection warnings

README.md

@@ -28,6 +28,19 @@ Or, same thing, but with Pretty enabled:
 
 The point is, you can scan down to see things in chronological order; the important parts are highlighted, the names are the same (or closer) to your source code, unnecessary details are omitted, and it's much easier to pick out the most important parts, such as file names and line numbers.
 
+## Pretty and nREPL
+
+[nREPL](https://nrepl.org) is the framework that allows an IDE such as [Emacs](https://cider.mx/) 
+or [Cursive](https://cursive-ide.com/), or even a CLI such as
+[Leiningen](https://leiningen.org/), to interoperate with a running REPL in a subprocess.
+
+Pretty includes an nREPL middleware function, `clj-commons.pretty.nrepl/wrap-pretty`, that will install pretty exception reporting into the REPL.  
+
+The nREPL documentation describes how to enable such middleware
+inside [project.clj or deps.edn](https://nrepl.org/nrepl/usage/server.html#starting-a-server) or
+in [.nrepl/nrepl.edn](https://nrepl.org/nrepl/usage/server.html#server-configuration) (for instance, when developing
+with [Cursive](https://cursive-ide.com/userguide/repl.html#configuring-middleware-for-nrepl-repls))
+
 ## Beyond Exceptions
 
 Pretty can print out a sequence of bytes; it includes color-coding inspired by
@@ -43,19 +56,22 @@ to indicate where the two sequences differ.
 Pretty can output pretty tabular data:
 
 ```
+(def routes
+  [{:method     :get
+    :path       "/"
+    :route-name :root-page}
+   {:method     :post
+    :path       "/reset"
+    :route-name :reset}
+   {:method     :get
+    :path       "/status"
+    :route-name :status}])
+=> #'table-demo/routes
 (print-table
-    [:method
-     :path
-     {:key :route-name :title "Name"}]
-    [{:method     :get
-      :path       "/"
-      :route-name :root-page}
-     {:method     :post
-      :path       "/reset"
-      :route-name :reset}
-     {:method     :get
-      :path       "/status"
-      :route-name :status}])
+  [:method
+   :path
+   {:key :route-name :title "Name" :title-align :left}]
+  routes)
 ┌────────┬─────────┬────────────┐
 │ Method │   Path  │ Name       │
 ├────────┼─────────┼────────────┤
@@ -66,7 +82,22 @@ Pretty can output pretty tabular data:
 => nil
 ```
 
-The `print-table` function has many options to easily adjust the output to your needs, including fonts, text alignment, and the table border.
+The `print-table` function has many options to easily adjust the output to your needs, including fonts, text alignment, and line annotations. It also supplies several different table styles:
+
+```
+(print-table
+    {:columns [:method
+               :path
+               {:key :route-name :title "Name" :title-align :left}]
+     :style   table/skinny-style}
+    routes)
+Method |   Path  | Name      
+-------+---------+-----------
+  :get |       / | :root-page
+ :post |  /reset | :reset    
+  :get | /status | :status   
+=> nil
+```
 
 
 ## Compatibility

build.clj

@@ -1,8 +1,10 @@
 ;; clj -T:build <var>
 
 (ns build
-  (:require [clojure.tools.build.api :as build]
+  (:require [clojure.set :as set]
+            [clojure.tools.build.api :as build]
             [net.lewisship.build :as b]
+            [clojure.set :as set]
             [clojure.string :as str]))
 
 (def lib 'org.clj-commons/pretty)
@@ -19,6 +21,12 @@
   [_params]
   (b/create-jar jar-params))
 
+(defn install
+  [_params]
+  (build/install (-> (jar nil)
+                     (assoc :lib lib)
+                     (set/rename-keys {:jar-path :jar-file}))))
+
 (defn deploy
   [_params]
   (clean nil)

deps.edn

@@ -5,19 +5,20 @@
  {:test
   ;; clj -X:test
   {:extra-paths ["test"]
-   :extra-deps {criterium/criterium {:mvn/version "0.4.6"}
-                org.clojure/core.async {:mvn/version "1.8.741"}
-                nubank/matcher-combinators {:mvn/version "3.9.1"}
-                io.github.tonsky/clj-reload {:mvn/version "0.9.7"}
+   :extra-deps {criterium/criterium                  {:mvn/version "0.4.6"}
+                nrepl/nrepl                          {:mvn/version "1.3.1"}
+                org.clojure/core.async               {:mvn/version "1.8.741"}
+                nubank/matcher-combinators           {:mvn/version "3.9.1"}
+                io.github.tonsky/clj-reload          {:mvn/version "0.9.7"}
                 io.github.cognitect-labs/test-runner {:git/tag "v0.5.1"
                                                       :git/sha "dfb30dd"}}
-   :jvm-opts ["-Dclj-commons.ansi.enabled=true"]
-   :exec-fn cognitect.test-runner.api/test}
+   :jvm-opts    ["-Dclj-commons.ansi.enabled=true"]
+   :exec-fn     cognitect.test-runner.api/test}
 
   ;; clj -T:build <command>
   :build
-  {:deps {io.github.hlship/build-tools
-          {:git/tag "0.11.0" :git/sha "8c67d11"}}
+  {:deps       {io.github.hlship/build-tools
+                {:git/tag "0.11.0" :git/sha "8c67d11"}}
    :ns-default build}
 
   :1.11
@@ -36,20 +37,20 @@
   ;; clj -M:lint
 
   :lint
-  {:deps {clj-kondo/clj-kondo {:mvn/version "2025.06.05"}}
+  {:deps      {clj-kondo/clj-kondo {:mvn/version "2025.06.05"}}
    :main-opts ["-m" "clj-kondo.main" "--lint" "src"]}
 
   :nrepl
   {:extra-deps {nrepl/nrepl {:mvn/version "1.3.1"}}
-   :main-opts ["-m" "nrepl.cmdline"]}
+   :main-opts  ["-m" "nrepl.cmdline"]}
 
   :repl
   {:main-opts ["-m" "clj-commons.pretty.repl"]}}
 
  :net.lewisship.build/scm
- {:url "https://github.com/clj-commons/pretty"
+ {:url     "https://github.com/clj-commons/pretty"
   :license :asl}
 
  :codox/config
  {:description "Clojure library to help print things, prettily"
-  :source-uri "https://github.com/clj-commons/pretty/blob/master/{filepath}#L{line}"}}
+  :source-uri  "https://github.com/clj-commons/pretty/blob/master/{filepath}#L{line}"}}

src/clj_commons/format/binary.clj

@@ -124,10 +124,10 @@
       (when write-ascii?
         (list
           (padding (* 3 (- per-line line-count)))
-          " |"
+          " │"
           (map to-ascii line-bytes)
           (padding (- per-line line-count))
-          "|")))))
+          "│")))))
 
 (defn print-binary
   "Formats a BinaryData into a hex-dump string, consisting of multiple lines; each line formatted as:
@@ -147,10 +147,10 @@
 
   In ASCII mode, the output is 16 bytes per line, but each line includes the ASCII printable characters:
 
-      0000: 43 68 6F 6F 73 65 20 69 6D 6D 75 74 61 62 69 6C |Choose immutabil|
-      0010: 69 74 79 2C 20 61 6E 64 20 73 65 65 20 77 68 65 |ity, and see whe|
-      0020: 72 65 20 74 68 61 74 20 74 61 6B 65 73 20 79 6F |re that takes yo|
-      0030: 75 2E                                           |u.              |
+      0000: 43 68 6F 6F 73 65 20 69 6D 6D 75 74 61 62 69 6C │Choose immutabil│
+      0010: 69 74 79 2C 20 61 6E 64 20 73 65 65 20 77 68 65 │ity, and see whe│
+      0020: 72 65 20 74 68 61 74 20 74 61 6B 65 73 20 79 6F │re that takes yo│
+      0030: 75 2E                                           │u.              │
 
   When ANSI is enabled, the individual bytes and characters are color-coded as per the [[*fonts*]]."
   ([data]
@@ -210,7 +210,7 @@
     [{:align :left
       :width (* 3 bytes-per-diff-line)}
      (compose-deltas :bright-green-bg offset expected-length expected actual-length actual)]
-    " |"
+    " │"
     (compose-deltas :bright-red-bg offset actual-length actual expected-length expected)))
 
 (defn print-binary-delta

src/clj_commons/format/table.clj

@@ -107,6 +107,12 @@
    :row-right     nil
    :footer?       false})
 
+(def ^{:added   "3.5.0"
+       :dynamic true}
+  *default-style*
+  "Default style used for table output.  Defaults to [[default-style]]."
+  default-style)
+
 (defn print-table
   "Similar to clojure.pprint/print-table, but with fancier graphics and more control
   over column titles.
@@ -172,7 +178,7 @@
                 {:columns opts}
                 opts)
         {:keys [columns style default-decorator row-annotator]
-         :or   {style default-style}} opts'
+         :or   {style *default-style*}} opts'
         {:keys [header?
                 footer?
                 header-left

src/clj_commons/pretty/nrepl.clj

@@ -0,0 +1,25 @@
+(ns clj-commons.pretty.nrepl
+  "Middleware to setup pretty exception reporting in nREPL."
+  {:added "3.5.0"}
+  (:require [clj-commons.pretty.repl :as repl]
+            [nrepl.middleware :as middleware]
+            [nrepl.middleware.caught :as caught]))
+
+(defn wrap-pretty
+  "Ensures that exceptions are printed using pretty, including uncaught REPL exceptions.
+
+  This sets the message key :nrepl.middleware.caught/caught, if not previously set."
+  [handler]
+  (repl/install-pretty-exceptions)
+  (fn with-pretty
+    [msg]
+    (let [msg' (if (contains? msg ::caught/caught)
+                 msg
+                 (assoc msg ::caught/caught `repl/pretty-repl-caught))]
+      (handler msg'))))
+
+(middleware/set-descriptor! #'wrap-pretty
+                            {:doc      (-> #'wrap-pretty meta :doc)
+                             :handles  {}
+                             :requires #{}
+                             :expects  #{#'caught/wrap-caught}})

src/clj_commons/pretty/repl.clj

@@ -70,7 +70,7 @@
 
   (defmethod print-method Throwable
     [t ^Writer writer]
-    (.write writer ^String (System/lineSeparator))
+    (.write writer ^String System/lineSeparator)
     (.write writer (e/format-exception t)))
 
   ;; This is necessary due to direct linking (from clojure.test to clojure.stacktrace).

test/clj_commons/binary_test.clj

@@ -45,7 +45,7 @@
 
 (deftest binary-fonts
   (let [byte-data (byte-array [0x59 0x65 073 0x20 0x4e 0x00 0x00 0x09 0x80 0xff])]
-    (is (= ["{0;90}0000:{} {0;36}59{} {0;36}65{} {0;36}3B{} {0;32}20{} {0;36}4E{} {0;90}00{} {0;90}00{} {0;32}09{} {0;33}80{} {0;33}FF{}                   |{0;36}Ye;{0;32} {0;36}N{0;90}••{0;32}_{0;33}××{}      |"]
+    (is (= ["{0;90}0000:{} {0;36}59{} {0;36}65{} {0;36}3B{} {0;32}20{} {0;36}4E{} {0;90}00{} {0;90}00{} {0;32}09{} {0;33}80{} {0;33}FF{}                   │{0;36}Ye;{0;32} {0;36}N{0;90}••{0;32}_{0;33}××{}      │"]
            (-> (b/format-binary byte-data {:ascii true})
                fixup-sgr
                string/split-lines)))))
@@ -87,14 +87,14 @@
        (format-binary-delta-plain expected actual))
 
     "123" "123"
-    ["0000: 31 32 33                                        | 31 32 33"]
+    ["0000: 31 32 33                                        │ 31 32 33"]
 
     "abcdefghijklmnopqrstuvwyz" "abCdefghijklmnopqrs"
-    ["0000: 61 62 63 64 65 66 67 68 69 6A 6B 6C 6D 6E 6F 70 | 61 62 43 64 65 66 67 68 69 6A 6B 6C 6D 6E 6F 70"
-     "0010: 71 72 73 74 75 76 77 79 7A                      | 71 72 73 -- -- -- -- -- --"]
+    ["0000: 61 62 63 64 65 66 67 68 69 6A 6B 6C 6D 6E 6F 70 │ 61 62 43 64 65 66 67 68 69 6A 6B 6C 6D 6E 6F 70"
+     "0010: 71 72 73 74 75 76 77 79 7A                      │ 71 72 73 -- -- -- -- -- --"]
 
     "abc" "abcdef"
-    ["0000: 61 62 63 -- -- --                               | 61 62 63 64 65 66"]))
+    ["0000: 61 62 63 -- -- --                               │ 61 62 63 64 65 66"]))
 
 
 (deftest deltas-with-fonts
@@ -110,14 +110,14 @@
     ;; 32 is green for whitespace
     ;; 102 is bright green backround,
     ;; 101 is bright red background
-    ["{0;90}0000:{} {0;36}31{} {0;36}32{} {0;36}33{} {0;32;102}09{}                                     | {0;36}31{} {0;36}32{} {0;36}33{} {0;32;101}0A{}"]
+    ["{0;90}0000:{} {0;36}31{} {0;36}32{} {0;36}33{} {0;32;102}09{}                                     │ {0;36}31{} {0;36}32{} {0;36}33{} {0;32;101}0A{}"]
 
     "1234" "12"
-    ["{0;90}0000:{} {0;36}31{} {0;36}32{} {0;36;102}33{} {0;36;102}34{}                                     | {0;36}31{} {0;36}32{} {0;101}--{} {0;101}--{}"]
+    ["{0;90}0000:{} {0;36}31{} {0;36}32{} {0;36;102}33{} {0;36;102}34{}                                     │ {0;36}31{} {0;36}32{} {0;101}--{} {0;101}--{}"]
 
     ;; 2 is faint for non-printable
     "\u001B" "\u001Cxyz"
-    ["{0;90}0000:{} {0;32;102;2}1B{} {0;102}--{} {0;102}--{} {0;102}--{}                                     | {0;32;101;2}1C{} {0;36;101}78{} {0;36;101}79{} {0;36;101}7A{}"]
+    ["{0;90}0000:{} {0;32;102;2}1B{} {0;102}--{} {0;102}--{} {0;102}--{}                                     │ {0;32;101;2}1C{} {0;36;101}78{} {0;36;101}79{} {0;36;101}7A{}"]
     ))
 
 

test/table_demo.clj

@@ -1,5 +1,5 @@
 (ns table-demo
-  (:require [clj-commons.format.table :refer [print-table] :as t]))
+  (:require [clj-commons.format.table :refer [print-table] :as table]))
 
 (def row [{:first "Arthur" :middle "C" :last "Clark"}
           {:first "Alan" :last "Turing"}
@@ -16,8 +16,8 @@
                               :bold))}])
 (comment
   (print-table columns row)
-  (print-table {:style t/minimal-style :columns columns} row)
-  (print-table {:style         t/skinny-style
+  (print-table {:style table/minimal-style :columns columns} row)
+  (print-table {:style         table/skinny-style
                 :row-annotator (fn [i row]
                                  (when (= i 2)
                                    [:italic " (prescient)"]))
@@ -27,10 +27,7 @@
                     :blue))
                 :columns       columns} row)
 
-  (print-table
-    [:method
-     :path
-     {:key :route-name :title "Name" :title-align :left}]
+  (def routes
     [{:method     :get
       :path       "/"
       :route-name :root-page}
@@ -41,4 +38,20 @@
       :path       "/status"
       :route-name :status}])
 
+  (print-table
+    [:method
+     :path
+     {:key :route-name :title "Name" :title-align :left}]
+    routes)
+
+  (print-table
+    {:columns [:method
+               :path
+               {:key :route-name :title "Name" :title-align :left}]
+     :style   table/skinny-style}
+    routes)
+
+
+
+  ;
    )