Add Ansi coloring printer about expound HOT 13 CLOSED

@ arichiardi @carocad This feature is included in 0.6.0. Thanks for all your help!

from expound.

@arichiardi Great idea! I have a few ideas on how to start with this.

Unfortunately, it's a bit tricky to describe via GitHub issues because AFAICT, we can't colorize the Github-flavored-markdown, but I'll do my best :)

From the sample output in the README:

;; -- Spec failed --------------------

;;   {:city ..., :state :CO}
;;                      ^^^

;; should satisfy

;;   string?

;; -- Relevant specs -------

;; :example.place/state:
;;   clojure.core/string?
;; :example/place:
;;   (clojure.spec.alpha/keys
;;    :req-un
;;    [:example.place/city :example.place/state])

;; -------------------------
;; Detected 1 error

:CO i.e. the "non-conforming value" : color A
^^^ i.e. the the "highlight" : color B
string? i.e. the "predicate" : color A (so it visually matches the non-conforming value).

everything else could remain uncolored for now.

Some more examples of problems:

I suspect that this scheme would help visually connect the non-conforming value with the problem, but I could be wrong - perhaps in practice, it's nicer to have the entire problem (the whole left hand column) colorized.

What do you think? I'd prefer to start with minimal colors and see if it solves the problem. We can always add more colors as we go.

PRs welcome on this. Otherwise, I'll probably tackle after a few more bug fixes and one more big feature I want to work on.

from expound.

I like your idea, I definitely prefer minimal colors just to catch the eye where the problem is. I would also probably him the separator between spec in order to create a visual barrier between different spec problems.
Good that you started the discussion about this here!

PS.: the text of the second error in the table could be probably colored less 😄

from expound.

the separator between spec in order to create a visual barrier between different spec problem

Yep, good idea. Probably a third color C for this.

the text of the second error in the table could be probably colored less 😄

Yes, perhaps just :v and any.

from expound.

@bhb maybe it would be a good idea to have a color convention similar or equal to figwheel colors for compiler error messages.

The idea is to make the colors as predictable as possible, and since figwheel is (afaik) the standard for Clojurescript I think that it would help to ease understanding the error messages.

• figwheel function

• figwheel feature description

Hope it helps

from expound.

@carocad That's a good idea - Figwheel has already put a lot of thought into this, and it would mean that if you're familiar with Figwheel messages, you'l have an easier time reading Expound error messages as well.

from expound.

@arichiardi @carocad If you have time, I'd appreciate it if you could try out Expound 0.5.1-SNAPSHOT, which includes ansi colorization:

(require '[clojure.spec.alpha :as s])
(require '[clojure.spec.test.alpha :as st])
(require '[expound.alpha :as expound])
(set! s/*explain-out* (expound/custom-printer {:theme :figwheel-theme}))

:figwheel-theme is the only theme right now, but I may add others in the future.

from expound.

(and thanks for suggesting this!)

from expound.

cc @lacarmen @ikitommi feedback is appreciated from you as well 😄

from expound.

This is great and I will definitely try this out as soon as possible. Thanks a lot!

from expound.

@bhb I just gave it a try and I think it is a wonderful piece of work :)

I will stay with the snapshot version until a full release comes out just so that I can keep the colored output.

For those that come here and are curious about it here are some screenshots on the output on my Cursive IDE.

from expound.

@carocad Thank you for trying it out and for the suggestions above!

from expound.

Works very nicely for me with:

{expound {:git/url "https://github.com/bhb/expound"
          :sha "59740c46c5a33cfa1257e563ec37b652eae692fd"}}

and output

from expound.