Add tap> support; add Babashka compatibility and remove ClojureScript dependency in Clojure

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: ci
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Prepare java
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'zulu'
+          java-version: '11'
+
+      - name: Install clojure tools
+        uses: DeLaGuardo/[email protected]
+        with:
+          lein: 2.9.10
+          bb: latest
+
+      - name: Execute lein tests
+        run: lein test
+
+      - name: Execute babashka tests
+        run: bb test:bb

.gitignore

@@ -17,9 +17,15 @@
 /examples/.rebel_readline_history
 /examples/.lein-repl-history
 
+/.idea/
+/*.iml
+
 /resources/public/js/
 
 *~
 *#
 .#*
 
+.cache
+.lein-failures
+/.cpcache/

bb.edn

@@ -0,0 +1,16 @@
+{:deps {philoskim/debux {:local/root "."}}
+ :tasks
+
+ {test:bb
+  {:doc "Run babashka tests"
+   :extra-deps {eftest/eftest {:mvn/version "0.6.0"}}
+   :extra-paths ["test"]
+   :requires ([eftest.runner :refer [find-tests run-tests]])
+   :task (let [{:keys [fail error]} (run-tests
+                                     (find-tests "test")
+                                     (when-not (System/console)
+                                               ;; better output in github actions
+                                       {:report clojure.test/report}))]
+           (when (or (pos? fail)
+                     (pos? error))
+             (throw (ex-info "Tests failed" {:babashka/exit 1}))))}}}

deps.edn

@@ -0,0 +1 @@
+{:paths ["src"]}

examples/src/cljs/examples/core.cljs

@@ -11,4 +11,3 @@
 ))
 
 (defn init [])
-

project.clj

@@ -1,9 +1,8 @@
-(defproject philoskim/debux "0.8.3"
+(defproject com.github.gnl/debux "0.8.4-1"
   :description "A trace-based debugging library for Clojure and ClojureScript"
   :url "https://github.com/philoskim/debux"
   :license {:name "Eclipse Public License - v 1.0"
             :url "http://www.eclipse.org/legal/epl-v10.html"}
-  :dependencies [[org.clojure/clojure "1.8.0"]
-                 [org.clojure/clojurescript "1.10.238"]
-                 [clojure-future-spec "1.9.0"]]
+  :dependencies [[org.clojure/clojure "1.10.0" :scope "provided"]
+                 [org.clojure/clojurescript "1.10.238" :scope "provided"]]
   :source-paths ["src"])

src/debux/common/macro_specs.cljc

@@ -1,7 +1,6 @@
 (ns debux.common.macro-specs
   "clojure.core macro specs which are minified, simplified and modified."
-  (:require [clojure.spec.alpha :as s]
-            [clojure.future :refer :all] ))
+  (:require [clojure.spec.alpha :as s]))
 
 (declare skip o-skip a-skip)
 ; skip => full skip

src/debux/common/util.cljc

@@ -3,8 +3,7 @@
   (:require [clojure.string :as str]
             [clojure.pprint :as pp]
             [clojure.zip :as z]
-            [clojure.walk :as walk]
-            [cljs.analyzer.api :as ana] ))
+            [clojure.walk :as walk]))
 
 ;;; For internal debugging
 (defmacro d
@@ -37,9 +36,14 @@
   (cond-> {:ns (symbol ns)}
     line (merge {:line line})))
 
+(comment
+  (defn src-info+tap-data [tap-data opts]
+    (merge (select-keys [:ns :line :msg] opts)
+           tap-data)))
+
 
 ;;; dynamic vars
-(def ^:dynamic *indent-level* 0)
+(def ^:dynamic *indent-level* 1)
 (def ^:dynamic *debug-level* 0)
 
 
@@ -51,7 +55,8 @@
          :ns-blacklist nil
          :ns-whitelist nil
          :line-bullet "|"
-         :cljs-devtools nil} ))
+         :cljs-devtools nil
+         :tap-output false}))
 
 (defn set-debug-mode! [val]
   (swap! config* assoc :debug-mode val)
@@ -81,6 +86,10 @@
   (swap! config* assoc :cljs-devtools bool)
   nil)
 
+(defn set-tap-output! [bool]
+  (swap! config* assoc :tap-output bool)
+  nil)
+
 
 (defn ns-match? [current-ns target-ns]
   (-> (re-pattern (str/escape target-ns {\. "\\." \* ".*"}))
@@ -165,7 +174,7 @@
 
 #?(:clj
    (defn- ns-symbol-for-cljs [sym env]
-     (if-let [meta (ana/resolve env sym)]
+     (if-let [meta ((requiring-resolve 'cljs.analyzer.api/resolve) env sym)]
        ;; normal symbol
        (if (:local meta)
          sym
@@ -242,11 +251,31 @@
   [line indent-level]
   (str (make-bullets indent-level) line))
 
+(defn tap-data
+  ([tap-map]
+   (->> tap-map
+        (merge {:form nil
+                :result nil
+                :indent-level 0
+                :info nil})
+        tap>))
+  ([form result]
+   (tap-data form result *indent-level* nil))
+  ([form result indent-level]
+   (tap-data form result indent-level nil))
+  ([form result indent-level info]
+   (tap> {:form form
+          :result result
+          :indent-level indent-level
+          :info info})))
+
 (defn print-title-with-indent
   [src-info title]
   (when (:source-info-mode @config*)
     (println (prepend-bullets-in-line src-info (dec *indent-level*))))
   (println (prepend-bullets-in-line title (dec *indent-level*)))
+  (when (:tap-output @config*)
+    (tap-data nil nil (dec *indent-level*) title))
   (flush))
 
 (defn print-form-with-indent
@@ -268,7 +297,9 @@
     (println (->> (str/split pprint #"\n")
                   (mapv #(str prefix %))
                   (str/join "\n")))
-    (flush) ))
+    (when (:tap-output @config*)
+      (tap-data nil result *indent-level* ":locals"))
+    (flush)))
 
 (defn pprint-result-with-indent
   [result]
@@ -340,6 +371,9 @@
         (= :level fst)
         (recur (nnext opts) (assoc acc :level snd))
 
+        (= :simple fst)
+        (recur (next opts) (assoc acc :simple true))
+
 
         ;;; for clojureScript only
         (= :js fst)
@@ -391,12 +425,16 @@
   [pre-result quoted-form & [opts]]
   (print-form-with-indent (form-header quoted-form))
   (pprint-result-with-indent pre-result)
+  (when (:tap-output @config*)
+    (tap-data quoted-form pre-result))
   pre-result)
 
 (defn spy-last
   [quoted-form pre-result & [opts]]
   (print-form-with-indent (form-header quoted-form))
   (pprint-result-with-indent pre-result)
+  (when (:tap-output @config*)
+    (tap-data quoted-form pre-result))
   pre-result)
 
 (defn spy-comp
@@ -406,29 +444,37 @@
       (let [result (apply form arg)]
         (print-form-with-indent (form-header quoted-form))
         (pprint-result-with-indent result)
-        result) )))
+        (when (:tap-output @config*)
+          (tap-data quoted-form result))
+        result))))
 
 
 ;;; spy macros
 (defmacro spy
   [form]
   `(let [result# ~form]
-    (print-form-with-indent (form-header '~form))
-    (pprint-result-with-indent result#)
-    result#))
+     (print-form-with-indent (form-header '~form))
+     (pprint-result-with-indent result#)
+     (when (:tap-output @config*)
+       (tap-data '~form result#))
+     result#))
 
 (defmacro spy-first2
   [pre-result form]
   `(let [result# (-> ~pre-result ~form)]
      (print-form-with-indent (form-header '~form))
      (pprint-result-with-indent result#)
+     (when (:tap-output @config*)
+       (tap-data '~form result#))
      result#))
 
 (defmacro spy-last2
   [form pre-result]
   `(let [result# (->> ~pre-result ~form)]
      (print-form-with-indent (form-header '~form))
      (pprint-result-with-indent result#)
+     (when (:tap-output @config*)
+       (tap-data '~form result#))
      result#))
 
 (defn print-xform [quoted-xform indent-level]

src/debux/core.clj

@@ -22,6 +22,8 @@
 (defmacro set-ns-whitelist! [whitelist]
   `(ut/set-ns-whitelist! ~whitelist))
 
+(defmacro set-tap-output! [bool]
+  `(ut/set-tap-output! ~bool))
 
 ;;; debugging APIs
 (def locking* (Object.))

src/debux/cs/core.cljc

@@ -31,6 +31,9 @@
 (defmacro set-cljs-devtools! [bool]
   `(ut/set-cljs-devtools! ~bool))
 
+(defmacro set-tap-output! [bool]
+  `(ut/set-tap-output! ~bool))
+
 
 ;;; debugging APIs
 (defmacro dbg [form & opts]

src/debux/cs/macro_types.clj

@@ -1,6 +1,7 @@
 (ns debux.cs.macro-types
   (:require [clojure.set :as set]
-            [debux.common.util :as ut] ))
+            [debux.common.util :as ut]
+            [debux.dbg :as d]))
 
 (def macro-types*
   (atom {:def-type '#{def cljs.core/defonce}
@@ -59,7 +60,12 @@
 (defmacro register-macros! [macro-type new-symbols]
   (-> (swap! macro-types* update macro-type
              #(merge-symbols % new-symbols &env))
-      ut/quote-vals))
+      ut/quote-vals)
+  (when (= macro-type :let-type)
+    (-> (swap! d/dbg-macro-types* update :let
+               #(merge-symbols % new-symbols &env))
+        ut/quote-vals)))
+
 
 (defmacro show-macros
   ([] (ut/quote-vals @macro-types*))

src/debux/cs/util.cljc

@@ -1,7 +1,6 @@
 (ns debux.cs.util
   "Utilities for clojurescript only"
   (:require [clojure.string :as str]
-            [cljs.analyzer.api :as ana]
             #?(:cljs [cljs.pprint :as pp])
             [debux.common.util :as ut] ))