Move to lread.status-line for script status msgs

Moved internal script helper.status out to its own project so that I can
reuse it across projects.

Author: lread

.clj-kondo/config.edn

@@ -1,4 +1,4 @@
-{:config-paths ^:replace []
+{:config-paths ^:replace ["lread/status-line"]
  :lint-as
  { clojure.test.check.clojure-test/defspec clojure.core/def
   clojure.test.check.properties/for-all clojure.core/let

.clj-kondo/lread/status-line/config.edn

@@ -0,0 +1,2 @@
+{:lint-as {lread.status-line/line clojure.tools.logging/infof
+           lread.status-line/die clojure.tools.logging/infof}}

bb.edn

@@ -4,4 +4,6 @@
         docopt/docopt {:git/url "https://github.com/nubank/docopt.clj"
                        :sha "98814f559d2e50fdf10f43cbe3b7da0ca3cca423"}
         doric/doric {:mvn/version "0.9.0"}
-        version-clj/version-clj {:mvn/version "2.0.1"}}}
+        version-clj/version-clj {:mvn/version "2.0.1"}
+        lread/status-line {:git/url "https://github.com/lread/status-line.git"
+                           :sha "35ed39645038e81b42cb15ed6753b8462e60a06d"}}}

script/apply_import_vars.clj

@@ -3,14 +3,14 @@
 (ns apply-import-vars
   (:require [helper.env :as env]
             [helper.shell :as shell]
-            [helper.status :as status]))
+            [lread.status-line :as status]))
 
 (defn -main[& args]
   (env/assert-min-versions)
   (let [cmd (first args)]
     (when (not (#{"gen-code" "check"} cmd))
-      (status/fatal "Usage: apply-import-vars [gen-code|check]"))
-    (status/line :info (str "Running apply import vars " cmd))
+      (status/die 1 "Usage: apply-import-vars [gen-code|check]"))
+    (status/line :head (str "Running apply import vars " cmd))
     (shell/command ["clojure" "-X:apply-import-vars:script" cmd])
     nil))
 

script/ci_tests.clj

@@ -4,7 +4,7 @@
   (:require [helper.env :as env]
             [helper.fs :as fs]
             [helper.shell :as shell]
-            [helper.status :as status]))
+            [lread.status-line :as status]))
 
 (defn clean []
   (doseq [dir ["target" ".cpcache .shadow-cljs"]]

script/clj_tests.clj

@@ -5,7 +5,7 @@
             [clojure.tools.cli :as cli]
             [helper.env :as env]
             [helper.shell :as shell]
-            [helper.status :as status]))
+            [lread.status-line :as status]))
 
 (def allowed-clojure-versions '("1.9" "1.10"))
 (def default-clojure-version "1.10")
@@ -40,17 +40,16 @@
 (defn exit [code msg]
   (if (zero? code)
     (status/line :detail msg)
-    (status/line :error msg))
-  (System/exit code))
+    (status/die code msg)))
 
 (defn run-unit-tests [{:keys [:clojure-version]}]
-  (status/line :info (str "testing clojure source against clojure v" clojure-version))
+  (status/line :head (str "testing clojure source against clojure v" clojure-version))
   (shell/command ["clojure"
                   (str "-M:test-common:kaocha:" clojure-version)
                   "--reporter" "documentation"]))
 
 (defn run-isolated-tests[{:keys [:clojure-version]}]
-  (status/line :info (str "running isolated tests against clojure v" clojure-version))
+  (status/line :head (str "running isolated tests against clojure v" clojure-version))
   (shell/command ["clojure" (str "-M:kaocha:" clojure-version)
                   "--profile" "test-isolated"
                   "--reporter" "documentation"]))

script/clj_watch.clj

@@ -3,11 +3,11 @@
 (ns clj-watch
   (:require [helper.env :as env]
             [helper.shell :as shell]
-            [helper.status :as status]))
+            [lread.status-line :as status]))
 
 (defn -main []
   (env/assert-min-versions)
-  (status/line :info "launching kaocha watch on clojure sources")
+  (status/line :head "launching kaocha watch on clojure sources")
   (shell/command (concat ["clojure" "-M:test-common:kaocha" "--watch"] *command-line-args*)))
 
 (env/when-invoked-as-script

script/cljdoc_preview.clj

@@ -10,7 +10,7 @@
             [helper.env :as env]
             [helper.fs :as fs]
             [helper.shell :as shell]
-            [helper.status :as status]))
+            [lread.status-line :as status]))
 
 ;;
 ;; constants
@@ -29,7 +29,7 @@
 (defn check-prerequisites []
   (let [missing-cmds (doall (remove #(fs/on-path %) ["git" "docker"]))]
     (when (seq missing-cmds)
-      (status/fatal (string/join "\n" ["Required commands not found:"
+      (status/die 1 (string/join "\n" ["Required commands not found:"
                                        (string/join "\n" missing-cmds)])))))
 ;;
 ;; os/fs support
@@ -51,9 +51,9 @@
     (apply zxml/xml1-> (concat  [xml] tag-path [zxml/text]))))
 
 (defn local-install []
-  (status/line :info "building thin jar")
+  (status/line :head "building thin jar")
   (shell/command ["clojure" "-X:jar"])
-  (status/line :info "installing project to local maven repo")
+  (status/line :head "installing project to local maven repo")
   (shell/command ["clojure" "-X:deploy:local"]))
 
 (defn get-project []
@@ -107,7 +107,7 @@
                                                     {:out :string})]
     (if (zero? exit)
       (-> out string/trim seq)
-      (status/fatal "Failed to check for unpushed commits to branch, is your branch pushed?"))))
+      (status/die 1 "Failed to check for unpushed commits to branch, is your branch pushed?"))))
 
 ;;
 ;; docker
@@ -125,17 +125,20 @@
 
 (defn stop-server [ container ]
   (when (= "down" (status-server container))
-    (status/fatal (str (:name container) " does not appear to be running")))
+    (status/die 1
+                "%s does not appear to be running"
+                (:name container)))
   (shell/command ["docker" "stop" (:name container) "--time" "0"]))
 
 (defn wait-for-server
   "Wait for container's http server to become available, assumes server has valid root page"
   [ container ]
-  (status/line :info (str "Waiting for " (:name container) " to become available"))
+  (status/line :head "Waiting for %s to become available" (:name container))
   (when (= "down" (status-server container))
-    (status/fatal (string/join "\n" [(str  (:name container) " does not seem to be running.")
-                                     "Did you run this script with the start command yet?"])))
-  (status/line :detail (str (:name container) " container is running"))
+    (status/die 1
+                "%s does not seem to be running.\nDid you run this script with the start command yet?"
+                (:name container)))
+  (status/line :detail "%s container is running" (:name container))
   (let [url (str "http://localhost:" (:port container))]
     (loop []
       (try
@@ -154,7 +157,7 @@
 ;;
 
 (defn cljdoc-ingest [container project version]
-  (status/line :info (str "Ingesting project " project " " version "\ninto local cljdoc database"))
+  (status/line :head "Ingesting project %s %s\ninto local cljdoc database" project version)
   (shell/command ["docker"
                   "run" "--rm"
                   "-v" (str cljdoc-db-dir ":/app/data")
@@ -173,10 +176,12 @@
 
 (defn start-cljdoc-server [container]
   (when (= "up" (status-server container))
-    (status/fatal (str (:name container) " is already running")))
-  (status/line :info "Checking for updates")
+    (status/die 1
+                "%s is already running"
+                (:name container)))
+  (status/line :head "Checking for updates")
   (docker-pull-latest container)
-  (status/line :info (str "Starting " (:name container) " on port " (:port container)))
+  (status/line :head "Starting %s on port %d" (:name container) (:port container))
   (shell/command ["docker"
                   "run" "--rm"
                   "--name" (:name container)
@@ -188,11 +193,9 @@
                   (:image container)]))
 
 (defn view-in-browser [url]
-  (status/line :info (str "opening " url " in browser"))
+  (status/line :head "opening %s in browser" url)
   (when (not= 200 (:status (curl/get url {:throw false})))
-    (status/fatal (string/join "\n" ["Could not reach:"
-                                     url
-                                     "\nDid you run this script with ingest command yet?"])))
+    (status/die 1 "Could not reach:\n%s\nDid you run this script with ingest command yet?" url))
   (browse/browse-url url))
 
 

script/cljs_tests.clj

@@ -7,7 +7,7 @@
             [helper.env :as env]
             [helper.fs :as fs]
             [helper.shell :as shell]
-            [helper.status :as status]))
+            [lread.status-line :as status]))
 
 (def valid-envs '("node" "chrome-headless" "planck"))
 (def valid-optimizations '("none" "advanced"))
@@ -48,9 +48,7 @@
 (defn exit [code msg]
   (if (zero? code)
     (status/line :detail msg)
-    (status/line :error msg))
-  (System/exit code))
-
+    (status/die code msg)))
 
 (defn compile-opts [out-dir {:keys [:env :optimizations]}]
   {:warnings {:fn-deprecated false}
@@ -80,9 +78,7 @@
       (string/split #" ")))
 
 (defn run-tests [{:keys [:env :optimizations :run-granularity] :as opts}]
-  (status/line :info (format "testing ClojureScript source under %s, cljs optimizations: %s"
-                             env
-                             optimizations))
+  (status/line :head "testing ClojureScript source under %s, cljs optimizations: %s" env optimizations)
   (let [test-combo (str env "-" optimizations)
         out-dir (str "target/cljsbuild/test/" test-combo)
         compile-opts-fname (str out-dir "-cljs-opts.edn")
@@ -105,13 +101,12 @@
       "all" (shell/command cmd)
       ;; I sometimes use namespace granularity to figure out which tests are affecting graal testing
       "namespace" (do
-                    (status/line :info "+ one run for each namespace")
+                    (status/line :head "+ one run for each namespace")
                     (let [nses (find-test-namespaces)
                           total-nses (count nses)]
                       (doall (map-indexed
                               (fn [ndx ns]
-                                (status/line :info (format "%d of %d) running tests for namespace: %s"
-                                                           (inc ndx) total-nses ns))
+                                (status/line :head "%d of %d) running tests for namespace: %s" (inc ndx) total-nses ns)
                                 (shell/command (concat cmd ["--namespace" ns])))
                               nses)))))))
 

script/cljs_watch.clj

@@ -3,7 +3,7 @@
 (ns cljs-watch
   (:require [helper.env :as env]
             [helper.shell :as shell]
-            [helper.status :as status]))
+            [lread.status-line :as status]))
 
 (defn -main []
   (env/assert-min-versions)