https://github.com/escherize/malli-descriptions
Describe malli schemas in plain english
https://github.com/escherize/malli-descriptions
Last synced: 9 months ago
JSON representation
Describe malli schemas in plain english
- Host: GitHub
- URL: https://github.com/escherize/malli-descriptions
- Owner: escherize
- License: mit
- Created: 2022-12-19T20:31:46.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-19T21:34:40.000Z (over 3 years ago)
- Last Synced: 2023-07-31T23:56:15.574Z (almost 3 years ago)
- Language: Clojure
- Size: 4.88 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Describe Malli Schemas
> (describe schema) => "a string that is the schema's description"
```clojure
(require [malli-descriptions.core :as md])
```
```clojure
(md/describe [:map [:x int?]])
;;=> "a map like {:x -> }"
```
```clojure
(md/describe [:map [:x int?]])
;;=> "a map like {:x -> }"
```
```clojure
(md/describe [:map [:x {:optional true} int?] [:y :boolean]])
;;=> "a map like {:x (optional) -> , :y -> }"
```
```clojure
(md/describe [:map {:closed true} [:x int?]])
;;=> "a map like {:x -> } with no other keys"
```
```clojure
(md/describe [:map {:closed true} [:x {:optional true} int?] [:y :boolean]])
;;=> "a map like {:x (optional) -> , :y -> } with no other keys"
```
```clojure
(md/describe [:=> [:cat int?] int?])
;;=> "a function that takes input: [integer] and returns integer"
```
```clojure
(md/describe
[:map [:j-code [:and :keyword
[:fn {:description "has length 4"} #(= 4 (count (name %)))]]]])
;;=> "a map like {:j-code -> }"
```
```clojure
(md/describe [:map-of {:title "dict"} :int :string])
"a map (titled: ‘dict’) from to "
```
```clojure
(md/describe [:vector [:sequential [:set :int]]])
"vector of sequence of set of integer"
```
```clojure
(md/describe [:multi {:dispatch :type
:dispatch-description "the type of animal"}
[:dog [:map [:x :int]]]
[:cat :any]])
"one of <:dog = a map like {:x -> } | :cat = anything> dispatched by the type of animal"
```
```clojure
(md/describe [:multi {:dispatch :type}
[:dog [:map [:x :int]]]
[:cat :any]])
"one of <:dog = a map like {:x -> } | :cat = anything> dispatched by :type"
```
```clojure
(md/describe [:schema
{:registry {"ConsCell" [:maybe [:tuple :int [:ref "ConsCell"]]]}}
"ConsCell"])
"ConsCell \"ConsCell\""
```
```clojure
(md/describe
[:schema
{:registry
{"Country" [:map
{:closed true}
[:name [:enum :FI :PO]]
[:neighbors
{:optional true}
[:vector [:ref "Country"]]]],
"Burger" [:map
[:name string?]
[:description {:optional true} string?]
[:origin [:maybe "Country"]]
[:price pos-int?]],
"OrderLine" [:map
{:closed true}
[:burger "Burger"]
[:amount int?]],
"Order" [:map
{:closed true}
[:lines [:vector "OrderLine"]]
[:delivery
[:map
{:closed true}
[:delivered boolean?]
[:address
[:map
[:street string?]
[:zip int?]
[:country "Country"]]]]]]}}
"Order"])
"Order which is: , :neighbors (optional) -> \"Country\"} with ;;=> no other keys, Burger is a map like {:name -> , :description (optional) -> , :origin -> , :price -> }, OrderLine is a map like {:burger -> , :amount -> } with no other keys, Order is a map like {:lines -> , :delivery -> , :address -> , :zip -> , :country -> }>} with no other keys>} with no other keys>"
```