practicalli / practicalli/clojure
Human readable Spec messages
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 117
- Forks
- 36
- PR merge metrics
- No merged PRs in 30d
Description
TODOL create a section on understanding spec error messages
A section on improving spec error message
Expound formats clojure.spec error messages in a way that is optimized for humans to read.
https://github.com/bhb/expound
For example, Expound will replace a clojure.spec error message like:
val: {} fails spec: :example/place predicate: (contains? % :city)
val: {} fails spec: :example/place predicate: (contains? % :state)
with
-- Spec failed --------------------
{}
should contain keys: :city, :state
| key | spec |
|========+=========|
| :city | string? |
|--------+---------|
| :state | string? |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or documentation entry point is named. Start by reviewing the repository's existing documentation structure and the linked Expound examples, then determine where a section on improving Clojure spec error messages belongs. Done means the documentation explains the human-readable transformation and includes a clear example like the one in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100