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: 6 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 (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-04-26T21:04:19.000Z (7 months ago)
• Last Synced: 2024-05-19T05:04:53.002Z (6 months ago)
• Topics: ansi-colors, clojure, feedback
• Language: Clojure
• Homepage: https://cljdoc.org/d/org.clj-commons/pretty
• Size: 1.69 MB
• Stars: 590
• Watchers: 19
• Forks: 27
• 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)

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.