Update README.md

Author: vlaaad

README.md

@@ -14,7 +14,8 @@ The default developer experience of cljfx has some issues:
 
 Cljfx dev tools solve these issues by providing:
 - reference for cljfx types and props;
-- specs for cljfx descriptions, so they can be validated (both individually and in running apps). 
+- specs for cljfx descriptions, so they can be validated;
+- dev-time lifecycles that perform validation and add cljfx component stacks to exceptions to help with debugging;
 
 ## Installation
 
@@ -112,7 +113,7 @@ You can set validating type->lifecycle opt that will validate all cljfx componen
     :opts (cond-> {}
             ;; Validate descriptions in dev
             in-development?
-            (assoc :fx.opt/type->lifecycle @(requiring-resolve 'cljfx.dev/validating-type->lifecycle)))))
+            (assoc :fx.opt/type->lifecycle @(requiring-resolve 'cljfx.dev/type->lifecycle)))))
 
 (defn -main []
   (fx/mount-renderer state renderer))
@@ -137,7 +138,7 @@ You can set validating type->lifecycle opt that will validate all cljfx componen
 ;;     at cljfx.dev$wrap_lifecycle$reify__22150.advance(validation.clj:80)
 ;;     at ...
 ```
-If you already use custom type->lifecycle opt, instead of using `cljfx.dev/validating-type->lifecycle` you can use `cljfx.dev/wrap-validating-type->lifecycle` to wrap your type->lifecycle with validations. 
+If you already use custom type->lifecycle opt, instead of using `cljfx.dev/type->lifecycle` you can use `cljfx.dev/wrap-type->lifecycle` to wrap your type->lifecycle with validations. 
 
 Additionally, you can validate individual descriptions while developing:
 ```clojure

src/cljfx/dev.clj

@@ -319,7 +319,7 @@
 
 (load "dev/validation")
 
-(defn wrap-validating-type->lifecycle
+(defn wrap-type->lifecycle
   "Wrap type->lifecycle used in the cljfx UI app with improved error messages
 
   Wrapped lifecycle performs spec validation of cljfx descriptions that results
@@ -328,21 +328,21 @@
   Additionally, exceptions thrown during cljfx lifecycle show a cljfx component
   stack to help with debugging.
 
-  Args:
+  Optional kv-args:
     type->lifecycle    the type->lifecycle fn used in opts of your app
     type->id           custom type->id if you need a way to get id from your
                        custom lifecycles"
-  ([type->lifecycle]
-   (wrap-validating-type->lifecycle type->lifecycle *type->id*))
-  ([type->lifecycle type->id]
-   (let [f (memoize wrap-lifecycle)]
-     (fn [type]
-       (f type type->lifecycle type->id)))))
-
-(def validating-type->lifecycle
+  [& {:keys [type->lifecycle type->id]
+      :or {type->lifecycle *type->lifecycle*
+           type->id *type->id*}}]
+  (let [f (memoize wrap-lifecycle)]
+    (fn [type]
+      (f type type->lifecycle type->id))))
+
+(def type->lifecycle
   "Default type->lifecycle that can be used in the cljfx UI app to improve error
   messages"
-  (wrap-validating-type->lifecycle (some-fn fx/keyword->lifecycle fx/fn->lifecycle)))
+  (wrap-type->lifecycle))
 
 (defn explain-desc
   "Validate cljfx description and report any issues
@@ -351,16 +351,14 @@
     type->lifecycle    the type->lifecycle fn used in opts of your app
     type->id           custom type->id if you need a way to get id from your
                        custom lifecycles"
-  ([desc]
-   (explain-desc desc *type->lifecycle* *type->id*))
-  ([desc type->lifecycle]
-   (explain-desc desc type->lifecycle *type->id*))
-  ([desc type->lifecycle type->id]
-   (binding [*type->lifecycle* type->lifecycle
-             *type->id* type->id]
-     (if-let [explain-data (s/explain-data :cljfx/desc desc)]
-       (println (explain-str explain-data))
-       (println "Success!")))))
+  [desc & {:keys [type->lifecycle type->id]
+           :or {type->lifecycle *type->lifecycle*
+                type->id *type->id*}}]
+  (binding [*type->lifecycle* type->lifecycle
+            *type->id* type->id]
+    (if-let [explain-data (s/explain-data :cljfx/desc desc)]
+      (println (explain-str explain-data))
+      (println "Success!"))))
 
 ;; stretch goals
 ;; - ui reference for searching the props/types/etc

test/cljfx/dev_test.clj

@@ -8,7 +8,7 @@
 (defn- validated [desc]
   @(fx/on-fx-thread
      (-> desc
-         (fx/create-component {:fx.opt/type->lifecycle fx.dev/validating-type->lifecycle})
+         (fx/create-component {:fx.opt/type->lifecycle fx.dev/type->lifecycle})
          fx/instance)))
 
 (deftest create-test
@@ -29,7 +29,7 @@
                                                 :text "a string"}]}))))
 
 (deftest advance-test
-  (let [opts {:fx.opt/type->lifecycle fx.dev/validating-type->lifecycle}
+  (let [opts {:fx.opt/type->lifecycle fx.dev/type->lifecycle}
         c (fx/create-component
             {:fx/type :label
              :text "foo"}
@@ -65,7 +65,7 @@
         old-err System/err]
     (System/setErr err)
     @(fx/on-fx-thread
-       (let [opts {:fx.opt/type->lifecycle fx.dev/validating-type->lifecycle}
+       (let [opts {:fx.opt/type->lifecycle fx.dev/type->lifecycle}
              c (fx/create-component
                  {:fx/type :stage
                   :showing true