Fix issue where one could not use ints or longs in the $ macro, and add clj-kondo hook for better validation.

2 files changed, 39 insertions, 0 deletions

diff --git a/resources/clj-kondo/config.edn b/resources/clj-kondo/config.edn
new file mode 100644
index 0000000..fa8d235
--- /dev/null
+++ b/resources/clj-kondo/config.edn
@@ -0,0 +1,2 @@
+{:hooks {:analyze-call {dompa.utils/$ hooks.dompa/$}}
+ :linters {:dompa.utils/$-arg-validation {:level :warning}}}
\ No newline at end of file
diff --git a/resources/clj-kondo/hooks/dompa.clj b/resources/clj-kondo/hooks/dompa.clj
new file mode 100644
index 0000000..b0eee7a
--- /dev/null
+++ b/resources/clj-kondo/hooks/dompa.clj
@@ -0,0 +1,37 @@
+(ns hooks.dompa
+  (:require [clj-kondo.hooks-api :as api]))
+
+(defn string-like? [x]
+  (or (api/string-node? x)
+      (api/token-node? x)))
+
+(defn $ [{:keys [node]}]
+  (let [[_ first-arg & rest-args] (:children node)]
+    (cond
+      ; if the first arg is string-like, then no sequences
+      ; are allowed, because you are only allowed to concat
+      ; strings, i.e. whatever (str) can do.
+      (or (api/string-node? first-arg)
+          (api/token-node? first-arg))
+      (let [invalid-args (filter #(not (string-like? %)) rest-args)]
+        (doall
+          (for [invalid-arg invalid-args]
+            (api/reg-finding!
+              (assoc (meta invalid-arg)
+                :message (str "Invalid argument type. When creating a text node, "
+                              "only literal values (strings, numbers and symbols) are allowed.")
+                :type :dompa.utils/$-arg-validation)))))
+
+      ; if the first arg is a keyword, then the second argument can only be
+      ; a sequence or a map.
+      (and (api/keyword-node? first-arg)
+           (seq rest-args)
+           (not (or (api/map-node? (first rest-args))
+                    (api/list-node? (first rest-args)))))
+      (api/reg-finding!
+        (assoc (meta (first rest-args))
+          :message (str "Invalid argument type. When creating a non-text node, "
+                        "the second argument must be a sequence or a map. "
+                        "In other words, the second argument must be an attribute map "
+                        "or sequence of other nodes created with the $ macro.")
+          :type :dompa.utils/$-arg-validation)))))
\ No newline at end of file