fireworks.pp — io.github.paintparty/fireworks 0.5.0

A pretty-printer for Clojure data structures.

Based on the algorithm described in "Pretty-Printing, Converting List to Linear Structure" by Ira Goldstein (Artificial Intelligence, Memo No. 279 in Massachusetts Institute of Technology A.I. Laboratory, February 1973).

!?pp clj/s

(!?pp x)

(!?pp label x)

-pprint clj

(-pprint this writer opts)

Given a form, a CountKeepingWriter, and an options map, pretty-print the form into the writer.

Options:

:level (long) The current nesting level. For example, in [[:a 1]], the outer vector is nested at level 0, and the inner vector is nested at level 1.

:indentation (String) A string (of spaces) to use for indentation.

:reserve-chars (long) The number of characters reserved for closing delimiters of S-expressions above the current nesting level.

-print cljs

(-print this writer opts)

?pp clj/s macro

(?pp x)

(?pp label x)

count-keeping-writer clj/s

(count-keeping-writer writer opts)

Given a java.io.Writer and an options map, wrap the java.io.Writer such that it becomes a CountKeepingWriter: a writer that keeps count of the length of the strings written into each line.

Options:

:max-width (long) Maximum line width.

CountKeepingWriter clj/s protocol

nl clj/s

(nl this)

Write a newline into the underlying java.io.Writer.

Resets the number of characters allotted to the current line to zero.

pprint clj/s

(pprint x)

(pprint x opts)

(pprint writer
        x
        {:keys [max-width map-entry-separator]
         :or {max-width 72 map-entry-separator ","}
         :as opts})

Pretty-print an object.

Given one arg (an object), pretty-print the object into out using the default options.

Given two args (an object and an options map), pretty-print the object into out using the given options.

Given three args (a java.io.Writer, a object, and an options map), pretty-print the object into the writer using the given options.

If print-dup is true, pprint does not attempt to pretty-print; instead, it falls back to default print-dup behavior. ClojureScript does not support print-dup.

Options:

:max-width (long or ##Inf, default: 72) Avoid printing anything beyond the column indicated by this value.

:map-entry-separator (string, default: ",") The string to print between map entries. To not print commas between map entries, use an empty string.