zprint is a library and command line tool providing a variety of pretty printing capabilities for both Clojure code and Clojure/EDN structures. It can meet almost anyone's needs. As such, it supports a number of major source code formatting approaches.
zprint does far more than just properly indent code. Before:
(defn change-start-column [new-start-column style-vec [inline-comment-index
start-column spaces-before :as comment-vec]] (if (zero? inline-comment-index)
style-vec (let [delta-spaces (- new-start-column start-column) new-spaces
(+ spaces-before delta-spaces) previous-element-index (dec
inline-comment-index) [s c e :as previous-element] (nth style-vec
previous-element-index) new-previous-element (cond (= e :indent) [(str "\n"
(blanks new-spaces)) c e] (= e :whitespace) [(str (blanks new-spaces))
c e 26] :else nil)] (assoc style-vec previous-element-index
new-previous-element))))
After:
(defn change-start-column
[new-start-column style-vec
[inline-comment-index start-column spaces-before :as comment-vec]]
(if (zero? inline-comment-index)
style-vec
(let [delta-spaces (- new-start-column start-column)
new-spaces (+ spaces-before delta-spaces)
previous-element-index (dec inline-comment-index)
[s c e :as previous-element] (nth style-vec previous-element-index)
new-previous-element
(cond (= e :indent) [(str "\n" (blanks new-spaces)) c e]
(= e :whitespace) [(str (blanks new-spaces)) c e 26]
:else nil)]
(assoc style-vec previous-element-index new-previous-element))))
:sort-require
, will sort the requires in an ns
macro,
as suggested by
how-to-ns.
This will interoperate with :ns-justify
well, but be sure and put
the :sort-require
to the left of (i.e., before) the :ns-justify
.
This will sort the elements of the :refer
vector as well.:ns-justify
has been modified to support explicit parameters
for the variance in the :require
, :require-macros
and :import
sections of the ns
macro. They are :require-max-variance
,
:require-macros-max-variance
and :import-max-variance
and may
be used in a style map. For example {:style-call :ns-justify :require-max-variance 1000}
will try as hard as possible to justify
the :require
list in an ns
macro.zprintma-1.2.9
from the release to get the Apple Silicon version.bbin
.
It starts very quickly and runs faster than the uberjar on even very
large files. If using a task, you don't need to install a new version,
just edit bb.edn
. See the simple detals here1.2.6
. Avoid 1.2.6
, use 1.2.7
or later.1.2.5
, the largest remaining problem
was comment wrapping causing changes to the formatting in subsequent
runs. In addition, the comment wrapping has been very simplistic
since its inception, leaving wrapped comments looking pretty bad.
There is a new capability called {:comment {:smart-wrap? true}}
which will now word wrap comments cleanly. It will also repair
most of the problems that the simplistic wrapping produced in the
past. It is now the default, in no small part to repair the
problems of the past. If you are working to minimize changes
when running zprint, I would recommend running it once over your
code before you disable it, as will clean up most of the problems
that were added by zprint in the past. You can disable it with
{:comment {:smart-wrap? false}}
. You can also configure it to
minimize the amount of word wrapping it does, while still allowing
it to do much better than the previous default by using {:style :minimal-smart-wrap}
. You need to have {:comment {:smart-wrap? true}}
to use :minimal-smart-wrap
. Smart wrap works hard to
not wrap things like numbered or bulleted lists. If you have a
case where it wraps something that it shouldn't, please submit an
issue. It is likely that it can be fixed with a configuration
change. See the reference manual for more details on how to
configure smart wrap.{:map {:key-order [...]}}
configuration places all of the keys prior to the distinguished key
:|
at the front of the map, and all of the keys after the :|
key
at the end of the map.In addition, zprint is very handy to use at the REPL.
Maybe one of the existing "styles" will meet your needs. All you have to
do is put {:style ...}
on the command line or as the third argument
to a zprint call. For example, {:style :community}
or
{:style :respect-bl}
.
Some commonly used styles:
quote
, deref
, var
, unquote
in structuresLeiningen (via Clojars)
zprint has been tested in each of the following environments:
planck
2.27.0 (Clojurescript 1.11.60)It requires tools.reader
at least 1.0.5, which all of the environments
above contain.
The last zprint release built with Clojure 1.8 was [zprint "0.4.15"].
In addition to the zprint dependency, you also need to include the following library when using Clojure 1.8:
[clojure-future-spec "1.9.0-alpha17"]
:style
quote
, deref
, var
, unquote
in structureslet
binding vectorscond
, assoc
pairsInformation on testing and development can be found here.
Note: Changed the default branch to main
.
A number of folks have contributed to zprint, not all of whom show up on GitHub because I have integrated the code or suggestions manually. Thanks for all of the great contributions!
sci.core
in babashka: @borkduderewrite-cljs
dependency to 0.4.5
@rundis/--url
and --url-only
: @coltnzUTF-8
locale to build the native image: @mynomoto:respect-bl
: @griffis:option-fn
and :fn-format
for enhanced vector formatting: @milankinenspec.cljc
: @Quezionns
macro: @pesterhazyThanks to everyone who has contributed fixes as well as everyone who has reported an issue. I really appreciate all of the help making zprint better for everybody!
At the core of zprint
is the rewrite-clj
library originally
created by Yannick Scherer, ported to Clojurescript by Magnus
Rundberget, and recently merged into a single, supported, documented,
and updated library by Lee Read. This is a great library! I would not have
attempted zprint
if rewrite-clj
didn't exist to build upon.
Additionally, allowing options maps containing functions to be read
from files safely is made possible by sci
, the Small Clojure Interpreter
by Michael Borkent (@borkdude). This is a very well designed and
implemented addition to Clojure that required almost no effort to integrate
into zprint.
Copyright © 2016-2023 Kim Kinnear
Distributed under the MIT License. See the file LICENSE for details.
Can you improve this documentation? These fine people already did:
Kim Kinnear, Brett Rowberry, Quest Yarbrough, vemv, Andrea Richiardi & Brian HurlowEdit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close