io.aviso/pretty 1.4.2
Clojure library to help print things, prettily.
Namespaces
io.aviso.ansi
Help with generating textual output that includes ANSI escape codes for formatting. The compose function is the best starting point.
+Generated by Codox
io.aviso/pretty 1.4.3
io.aviso/pretty 1.4.3
Clojure library to help print things, prettily.
Namespaces
io.aviso.ansi
Help with generating textual output that includes ANSI escape codes for formatting. The compose function is the best starting point.
Public variables and functions:
- ansi-output-enabled?
- black
- black-bg
- black-bg-font
- black-font
- blue
- blue-bg
- blue-bg-font
- blue-font
- bold
- bold-black
- bold-black-bg
- bold-black-bg-font
- bold-black-font
- bold-blue
- bold-blue-bg
- bold-blue-bg-font
- bold-blue-font
- bold-cyan
- bold-cyan-bg
- bold-cyan-bg-font
- bold-cyan-font
- bold-font
- bold-green
- bold-green-bg
- bold-green-bg-font
- bold-green-font
- bold-magenta
- bold-magenta-bg
- bold-magenta-bg-font
- bold-magenta-font
- bold-red
- bold-red-bg
- bold-red-bg-font
- bold-red-font
- bold-white
- bold-white-bg
- bold-white-bg-font
- bold-white-font
- bold-yellow
- bold-yellow-bg
- bold-yellow-bg-font
- bold-yellow-font
- bright-black
- bright-black-bg
- bright-black-bg-font
- bright-black-font
- bright-blue
- bright-blue-bg
- bright-blue-bg-font
- bright-blue-font
- bright-cyan
- bright-cyan-bg
- bright-cyan-bg-font
- bright-cyan-font
- bright-green
- bright-green-bg
- bright-green-bg-font
- bright-green-font
- bright-magenta
- bright-magenta-bg
- bright-magenta-bg-font
- bright-magenta-font
- bright-red
- bright-red-bg
- bright-red-bg-font
- bright-red-font
- bright-white
- bright-white-bg
- bright-white-bg-font
- bright-white-font
- bright-yellow
- bright-yellow-bg
- bright-yellow-bg-font
- bright-yellow-font
- compose
- csi
- cyan
- cyan-bg
- cyan-bg-font
- cyan-font
- default-background
- default-background-font
- default-foreground
- default-foreground-font
- faint
- faint-font
- green
- green-bg
- green-bg-font
- green-font
- inverse
- inverse-font
- italic
- italic-font
- magenta
- magenta-bg
- magenta-bg-font
- magenta-font
- normal
- normal-font
- not-underlined
- not-underlined-font
- plain
- plain-font
- red
- red-bg
- red-bg-font
- red-font
- reset-font
- roman
- roman-font
- sgr
- strip-ansi
- underlined
- underlined-font
- visual-length
- white
- white-bg
- white-bg-font
- white-font
- yellow
- yellow-bg
- yellow-bg-font
- yellow-font
io.aviso.binary
Utilities for formatting binary data (byte arrays) or binary deltas.
Public variables and functions:
io.aviso.clipboard
Utilities for accessing text on the system clipboard using AWT.
io.aviso.columns
Assistance for formatting data into columns. Each column has a width, and data within the column may be left or right justified. Generally, columns are sized to the largest item in the column. When a value is provided in a column, it may be associated with an explicit width which is helpful when the value contains non-printing characters (such as those defined in the io.aviso.ansi
namespace).
Generated by Codox
io.aviso/pretty 1.4.2
io.aviso.ansi
Help with generating textual output that includes ANSI escape codes for formatting. The compose function is the best starting point.
+Generated by Codox
io.aviso/pretty 1.4.3
io.aviso.ansi
Help with generating textual output that includes ANSI escape codes for formatting. The compose function is the best starting point.
Reference: Wikipedia.
In version 1.4, the incorrectly named bold-<color>
functions and constants were deprecated in favor of the bright-<color>
equivalents (correcting a day 1 naming mistake).
ansi-output-enabled?
added in 1.3
Determine if ANSI output is enabled.
@@ -105,7 +105,7 @@Font defs apply on top of the font def of the enclosing block, and the outer block’s font def is restored at the end of the inner block, e.g. [:red " RED " [:bold "RED/BOLD"] " RED "]
.
compose
presumes that on entry the current font is plain (default foreground and background, not bold, or inverse, or italic) and appends a reset-font to the end of the returned string to ensure that later output is also plain.
cyan-bg
(cyan-bg text)
Wraps the provided text with ANSI codes to render with a cyan background.
cyan-bg-font
Constant for ANSI code to render with a cyan background.
diff --git a/pretty/io.aviso.binary.html b/pretty/io.aviso.binary.html index 12e1d12..3278a64 100644 --- a/pretty/io.aviso.binary.html +++ b/pretty/io.aviso.binary.html @@ -1,6 +1,6 @@ -Generated by Codox
io.aviso/pretty 1.4.2
io.aviso.binary
Utilities for formatting binary data (byte arrays) or binary deltas.
+Generated by Codox
io.aviso/pretty 1.4.3
io.aviso.binary
Utilities for formatting binary data (byte arrays) or binary deltas.
BinaryData
protocol
Allows various data sources to be treated as a byte-array data type that supports a length and random access to individual bytes.
BinaryData is extended onto byte arrays, java.nio.ByteBuffer, java.lang.String, java.lang.StringBuilder, and onto nil.
members
byte-at
(byte-at this index)
The byte value at a specific offset.
diff --git a/pretty/io.aviso.clipboard.html b/pretty/io.aviso.clipboard.html index 136c9c6..66d248d 100644 --- a/pretty/io.aviso.clipboard.html +++ b/pretty/io.aviso.clipboard.html @@ -1,6 +1,6 @@ -Generated by Codox
io.aviso/pretty 1.4.2
io.aviso.clipboard
added in 0.1.33
Utilities for accessing text on the system clipboard using AWT.
+Generated by Codox
io.aviso/pretty 1.4.3
io.aviso.clipboard
added in 0.1.33
Utilities for accessing text on the system clipboard using AWT.
This is segregated from other code to prevent the AWT stack from initializing unnecessarily. On OS X, this initialization is seen as a Java application icon appearing in the Dock.
copy
(copy)
Copies the current contents of the Clipboard, returning its contents as a string.
paste
(paste s)
Pastes a string in as the new content of the Clipboard.
diff --git a/pretty/io.aviso.columns.html b/pretty/io.aviso.columns.html index 4c78290..c153c62 100644 --- a/pretty/io.aviso.columns.html +++ b/pretty/io.aviso.columns.html @@ -1,6 +1,6 @@ -Generated by Codox
io.aviso/pretty 1.4.2
io.aviso.columns
Assistance for formatting data into columns. Each column has a width, and data within the column may be left or right justified. Generally, columns are sized to the largest item in the column. When a value is provided in a column, it may be associated with an explicit width which is helpful when the value contains non-printing characters (such as those defined in the io.aviso.ansi
namespace).
Generated by Codox
io.aviso/pretty 1.4.3
io.aviso.columns
Assistance for formatting data into columns. Each column has a width, and data within the column may be left or right justified. Generally, columns are sized to the largest item in the column. When a value is provided in a column, it may be associated with an explicit width which is helpful when the value contains non-printing characters (such as those defined in the io.aviso.ansi
namespace).
format-columns
(format-columns & column-defs)
Converts a number of column definitions into a formatting function. Each column definition may be:
- a string, to indicate a non-consuming column that outputs a fixed value. This is often just a space character or two, to separate columns. diff --git a/pretty/io.aviso.component.html b/pretty/io.aviso.component.html index 7e50716..60a7a06 100644 --- a/pretty/io.aviso.component.html +++ b/pretty/io.aviso.component.html @@ -1,6 +1,6 @@ -
Generated by Codox
io.aviso/pretty 1.4.2
io.aviso.component
added in 0.1.35
Changes exception output for SystemMap and Lifecycle, from Stuart Sierra’s Component library, to be shorter placeholders.
+Generated by Codox
io.aviso/pretty 1.4.3
io.aviso.component
added in 0.1.35
Changes exception output for SystemMap and Lifecycle, from Stuart Sierra’s Component library, to be shorter placeholders.
SystemMap instances print as #<SystemMap>
.
Lifecycle instances print as #<Component CLASS>
(where CLASS
is name of the record class).
Without these changes, exception output for system maps produces volumes of deeply nested and redundant data.
diff --git a/pretty/io.aviso.exception.html b/pretty/io.aviso.exception.html index 06314e3..d8d60a1 100644 --- a/pretty/io.aviso.exception.html +++ b/pretty/io.aviso.exception.html @@ -1,6 +1,6 @@ -Generated by Codox
io.aviso/pretty 1.4.2
io.aviso.exception
Format and present exceptions in a pretty (structured, formatted) way.
+Generated by Codox
io.aviso/pretty 1.4.3
io.aviso.exception
Format and present exceptions in a pretty (structured, formatted) way.
*app-frame-names*
dynamic
Set of strings or regular expressions defining the application’s namespaces, which allows such namespaces to be highlighted in exception output.
*default-frame-filter*
dynamic
added in 0.1.16
(*default-frame-filter* frame)
Default stack frame filter used when printing REPL exceptions, driven by *default-frame-rules*.
*default-frame-rules*
dynamic
added in 0.1.18
The set of rules that forms the basis for *default-frame-filter*, as a vector or vectors.
diff --git a/pretty/io.aviso.lein-pretty.html b/pretty/io.aviso.lein-pretty.html index 326dfa0..2fb71f3 100644 --- a/pretty/io.aviso.lein-pretty.html +++ b/pretty/io.aviso.lein-pretty.html @@ -1,6 +1,6 @@ -Generated by Codox
io.aviso/pretty 1.4.2
io.aviso.lein-pretty
added in 0.1.19
A plugin for Leiningen that automatically enables pretty printing.
+Generated by Codox
io.aviso/pretty 1.4.3
io.aviso.lein-pretty
added in 0.1.19
A plugin for Leiningen that automatically enables pretty printing.
inject
(inject project)
Adds the :injections that enable Pretty inside the project’s process, by executing (io.aviso.repl/install-pretty-exceptions)
.
This is enabled by adding io.aviso.lein-pretty/inject
to the :middleware of the project.clj.
Generated by Codox
io.aviso/pretty 1.4.2
io.aviso.logging
added in 0.1.15
Provides functions that hook into clojure.tools.logging to make use of Pretty to format exceptions.
+Generated by Codox
io.aviso/pretty 1.4.3
io.aviso.logging
added in 0.1.15
Provides functions that hook into clojure.tools.logging to make use of Pretty to format exceptions.
You must add clojure.tools.logging as an explicit dependency of your project.
install-pretty-logging
(install-pretty-logging)
(install-pretty-logging frame-filter-fn)
Modifies clojure.tools.logging to use pretty exception logging.
install-uncaught-exception-handler
(install-uncaught-exception-handler)
Installs a default UncaughtExceptionHandler.
diff --git a/pretty/io.aviso.repl.html b/pretty/io.aviso.repl.html index eb85960..542e677 100644 --- a/pretty/io.aviso.repl.html +++ b/pretty/io.aviso.repl.html @@ -1,6 +1,6 @@ -Generated by Codox
io.aviso/pretty 1.4.2
io.aviso.repl
Utilities to assist with REPL-oriented development.
+Generated by Codox
io.aviso/pretty 1.4.3
io.aviso.repl
Utilities to assist with REPL-oriented development.
If you are using Stuart Sierra’s component library, you may want to also require io.aviso.component.
-main
added in 1.3.0
(-main & args)
Installs pretty exceptions, then delegates to clojure.main/main.
copy
added in 0.1.32
(copy)
Copies the current contents of the Clipboard, returning its contents as a string.