Comments (4)
@vemv I haven't dug in, but off the top of my head, I think it'd require some pretty in-depth design on a number of parts of error messages, including
- How to highlight the bad value when it's part of a larger value
- How to handle multiple branches of
or
specs - How to print out tables of missing keys
Just fair warning - you're welcome to make a PR, but I think the bar for this change is pretty high and I'll probably politely decline the PR unless it works across the range of features that Expound includes 😄 .
from expound.
@vemv Hi, thanks very much for your question!
There is not currently an option to remove the newlines and separators. The error messages in Expound rely on whitespace (including newlines) in a number of cases. For instance, in the following example, the error message relies on newlines to underline the bad part of the map:
;; -- Spec failed --------------------
;; {:city ..., :state :CO}
;; ^^^
;; should satisfy
;; string?
I can certainly understand why messages without newlines would be useful in your context, but Expound's error messages are intentionally multi-line and verbose to assist with understanding.
A different set of messages that are single-line and compact would be also useful, but out of scope for this particular project.
Thanks!
from expound.
Thanks for the explanation @bhb !
I might give a shot to a PR, assuming the changes aren't too intrusive.
from expound.
Again, thanks for the fair warning!
I gave some thought to your feedback.
Probably plain data could do the job:
{:bad-value "X"
:bad-value-path [0 0 :foo 0] ;; get-in style
:missing-keys [:x :y :z]
:branches [...]
...
}
Something like that. With a bit of luck, expound could build this data structure first, and present its traditional informational messages on top of that.
It doesn't sound easy but I had been wanting to allocate a day to FOSS!
from expound.
Related Issues (20)
- Error reports returned as :cause string in an exception when produced by instrumentation within generative testing HOT 11
- allow passing options map to expound/expound-str HOT 1
- Improve grouping of spec errors HOT 2
- Unnecessary dependency on `cider-nrepl` HOT 1
- Regression of #3 HOT 4
- Easier editing of error messages
- `printer` has invalid spec HOT 2
- "Cannot convert path" on instrumentation failures in the wild HOT 4
- (cljs.spec.test.alpha/instrument) breaks expound due to wrong arity HOT 4
- should expound work anywhere s/explain works? - clojurescript error HOT 7
- Error in :ret check when using with Orchestra 2020.07.12-1 HOT 5
- Internal error in `lift-singleton-groups` when having a datomic db value in fn args HOT 13
- Crash bug when printing, if a datomic db is present and the spec fails HOT 19
- Feature inquiry: a convenience function for validating a value against a spec HOT 4
- Wrapped `s/keys` does not properly display unqualified keyword specs HOT 5
- ClassCastException from `expound-str` when running in AWS Lambda HOT 9
- Small *print-length* and/or *print-level* sometimes yield NPE HOT 5
- PersistentList cannot be cast to class Named HOT 3
- proposal : defmsg equivalent for arbitrary predicates HOT 15
- optional include location of the spec error in the message. HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from expound.