https://github.com/clj-commons/pretty

Library for helping print things prettily, in Clojure - ANSI fonts, formatted exceptions
https://github.com/clj-commons/pretty

ansi-colors clojure feedback

Last synced: 8 days ago
JSON representation

Library for helping print things prettily, in Clojure - ANSI fonts, formatted exceptions

• Host: GitHub
• URL: https://github.com/clj-commons/pretty
• Owner: clj-commons
• License: apache-2.0
• Created: 2013-10-18T20:53:32.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2025-03-28T21:38:00.000Z (25 days ago)
• Last Synced: 2025-04-11T10:05:41.498Z (11 days ago)
• Topics: ansi-colors, clojure, feedback
• Language: Clojure
• Homepage: https://cljdoc.org/d/org.clj-commons/pretty
• Size: 2.54 MB
• Stars: 605
• Watchers: 18
• Forks: 29
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE-asl.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
[![Clojars](https://img.shields.io/clojars/v/org.clj-commons/pretty.svg)](http://clojars.org/org.clj-commons/pretty)

[![CI](https://github.com/clj-commons/pretty/actions/workflows/clojure.yml/badge.svg)](https://github.com/clj-commons/pretty/actions/workflows/clojure.yml)

[![cljdoc badge](https://cljdoc.org/badge/org.clj-commons/pretty)](https://cljdoc.org/d/org.clj-commons/pretty/)

*Sometimes, neatness counts*

If you are trying to puzzle out a stack trace, 

pick a critical line of text out of a long stream of console output,

or compare two streams of binary data, a little bit of formatting can go a long way.

That's what `org.clj-commons/pretty` is for.  It adds support for pretty output where it counts:

* Readable output for exceptions

* General ANSI font and background color support

* Readable output for binary sequences

![Example](docs/images/formatted-exception.png)

Or, compare an example from

[Pedestal](http://github.com/pedestal/pedestal)'s test suite:

![No Pretty](docs/images/pedestal-without-pretty.png)

Or, same thing, but with Pretty enabled:

![With Pretty](docs/images/pedestal-with-pretty.png)

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.

## Beyond Exceptions

Pretty can print out a sequence of bytes; it includes color-coding inspired by

[hexyl](https://github.com/sharkdp/hexyl):

![Binary Output](docs/images/binary-output.png)

Pretty can also print out a delta of two byte sequences, using background color

to indicate where the two sequences differ.

![Binary Delta](docs/images/binary-delta.png)

Pretty can output pretty tabular data:

```

(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  ┃    Name    ┃

┣━━━━━━━━╋━━━━━━━━━╋━━━━━━━━━━━━┫

┃   :get ┃       / ┃ :root-page ┃

┃  :post ┃  /reset ┃ :reset     ┃

┃   :get ┃ /status ┃ :status    ┃

┗━━━━━━━━┻━━━━━━━━━┻━━━━━━━━━━━━┛

=> nil

```

The `print-table` function has many options to easily adjust the output to your needs, including fonts, text alignment, and the table border.

## Compatibility

Pretty is compatible with Clojure 1.10 and above.

Parts of Pretty can be used with [Babashka](https://book.babashka.org/#introduction), such as the `clj-commons.ansi`

namespace; however, Babashka runs in an interpreter and its approach to exceptions is

incompatible with JVM exceptions.

## License

The majority of this code is available under the terms of the Apache Software License 1.0; some portions

are available under the terms of the Eclipse Public Licence 1.0.