Windows Support (#22)

* - add `windows?` constant for checking if running on windows
- make bbin-root using OS-dependent path separator

* - pull out script installation IO to a separate function
- don't try to chmod on windows

* use OS-dependent file separator

* add docstring

* add extension when on windows

* swap `File/separator` for `fs` version

* different commands for running scripts in bash or windows

* change cmd script extension to bat (windows)

* add bbin bat file for windows

* script-name-fn no longer needed

* - when on windows, write a bb script that execs the 'proper' bb
 invocation, and write a batch file that calls it

* - remove leading spaces that break ls
- delete wrapper batch file when on windows
- always look for semicolon on windows from parse-script

* add some basic flows to design doc (including
 capturing Windows differences)

* - add tool template for windows
- add shebangs to windows scripts (to later test if we can use the bb scripts for all cases)

* add extra line to tool usage output to match bash script

* add mock local tool

* add local-rooted tool test

* add Windows install instructions

* commit updated script

* add note about line endings for Windows to readme

* a bunch of little cleanup things

* correct tag in readme

* wipe the windows section from the readme (until it gets updated with new version)

Author: bobisageek

README.template.md

@@ -70,6 +70,21 @@ echo 'export PATH="$PATH:$HOME/.bbin/bin"' >> ~/.zshrc && exec /bin/zsh
 echo 'export PATH="$PATH:$HOME/.bbin/bin"' >> ~/.bashrc && exec /bin/bash
 ```
 
+### Windows (Manual)
+
+**1. Install `bbin` CLI (and batch file, because Windows):**
+```shell
+> set BBIN_DEST=%HOMEDRIVE%%HOMEPATH%\.bbin\bin
+> mkdir %BBIN_DEST% && curl -o %BBIN_DEST%\bbin -L https://raw.githubusercontent.com/babashka/bbin/v{{version}}/bbin && curl -o %BBIN_DEST%\bbin.bat -L https://raw.githubusercontent.com/babashka/bbin/v{{version}}/bbin.bat
+> set BBIN_DEST=
+```
+
+**2. Add `%HOMEDRIVE%%HOMEPATH%\.bbin\bin` to `Path` environment variable**
+
+Because `Path` is often a system-level and user-level variable, setting from the command line can be messy; it's probably easiest to add it in the Environment Variables settings window.
+
+Also, remember to check line endings.
+
 ## Usage
 
 ```

bbin

@@ -50,7 +50,7 @@ Usage: bbin <command>
 (defn now []
   (Date.))
 
-(def ^:dynamic *bbin-root* (fs/expand-home "~/.bbin"))
+(def ^:dynamic *bbin-root* (fs/expand-home (str "~" fs/file-separator ".bbin")))
 
 (defn bbin-root [_]
   *bbin-root*)
@@ -66,6 +66,11 @@ Usage: bbin <command>
 (defn ensure-bbin-dirs [cli-opts]
   (fs/create-dirs (bin-dir cli-opts)))
 
+(def windows?
+  (some-> (System/getProperty "os.name")
+    (str/lower-case)
+    (str/index-of "win")))
+
 (defn print-version [& {:as opts}]
   (if (:help opts)
     (print-help)
@@ -105,16 +110,69 @@ Usage: bbin <command>
             [clojure.pprint :as pprint]
             [selmer.parser :as selmer]
             [selmer.util :as selmer-util]
+            [selmer.filters :as filters]
             [babashka.bbin.util :as util :refer [sh]]))
 
 (defn- pprint [x _]
   (pprint/pprint x))
 
 (defn- gitlib-path [cli-opts script-deps]
   (let [coords (val (first script-deps))]
-    (fs/expand-home (str "~/.gitlibs/libs/" (:script/lib cli-opts) "/" (:git/sha coords)))))
+    (fs/expand-home (str/join fs/file-separator ["~" ".gitlibs" "libs" (:script/lib cli-opts) (:git/sha coords)]))))
+
+; windows scripts are babashka/clojure instead of shell scripts, so we need a variable 
+; comment character in the script meta
+(def ^:private comment-char
+  (if util/windows? "; " "# "))
+
+(def windows-wrapper-extension ".bat")
+
+; selmer filter for clojure escaping for e.g. files
+(filters/add-filter! :pr-str (comp pr-str str))
 
 (def ^:private tool-template-str
+  (if util/windows?
+    "#!/usr/bin/env bb
+; :bbin/start
+;
+{{script/meta}}
+; :bbin/end
+(require '[babashka.process :as process]
+         '[babashka.fs :as fs]
+         '[clojure.string :as str])
+
+(let [SCRIPT_ROOT        {{script/root|pr-str}}
+      SCRIPT_LIB         '{{script/lib}}
+      SCRIPT_COORDS      {{script/coords|str}}
+      SCRIPT_NS_DEFAULT  '{{script/ns-default}}
+      SCRIPT_NAME        (fs/file-name *file*)
+      TMP_EDN            (doto (fs/file (fs/temp-dir) (str (gensym \"bbin\")))
+                           (spit (str \"{:deps {\" SCRIPT_LIB SCRIPT_COORDS \"}}\"))
+                           (fs/delete-on-exit))
+      [first-arg & rest-args] *command-line-args*]
+  (if first-arg
+    (process/exec
+      (str/join \" \" (concat [\"bb --deps-root \" SCRIPT_ROOT \"--config\" (str TMP_EDN)
+                               \"-x\" (str SCRIPT_NS_DEFAULT \"/\" first-arg)
+                               \"--\"] rest-args)))
+    (do
+      (let [script (str \"(require '\" SCRIPT_NS_DEFAULT \")
+                     (def fns (filter #(fn? (deref (val %))) (ns-publics '\" SCRIPT_NS_DEFAULT \")))
+                     (def max-width (->> (keys fns) (map (comp count str)) (apply max)))
+                     (defn pad-right [x] (format (str \\\"%-\\\" max-width \\\"s\\\") x))
+                     (println (str \\\"Usage: \" SCRIPT_NAME \" <command>\\\"))
+                     (newline)
+                     (doseq [[k v] fns]
+                       (println
+                         (str \\\"  \" SCRIPT_NAME \" \\\" (pad-right k) \\\"  \\\"
+                            (when (:doc (meta v))
+                              (first (str/split-lines (:doc (meta v))))))))\")
+             cmd-line     [\"bb\" \"--deps-root\" SCRIPT_ROOT \"--config\"  (str TMP_EDN)
+                           \"-e\"  script]]
+         (process/exec cmd-line)))))"
+;    
+; non-windows tool script
+;
   "#!/usr/bin/env bash
 set -e
 
@@ -152,9 +210,36 @@ else
     --config <(echo \"{:deps {$SCRIPT_LIB $SCRIPT_COORDS}}\") \\
     -x $SCRIPT_NS_DEFAULT/$1 \\
     -- \"${@:2}\"
-fi")
+fi"))
 
 (def ^:private git-or-local-template-str
+  (if util/windows?
+    "#!/usr/bin/env bb
+; :bbin/start
+;
+{{script/meta}}
+; :bbin/end
+
+(require '[babashka.process :as process]
+         '[babashka.fs :as fs]
+         '[clojure.string :as str])
+
+(let [SCRIPT_ROOT    {{script/root|pr-str}}             
+      SCRIPT_LIB     '{{script/lib}}
+      SCRIPT_COORDS  {{script/coords|str}}               
+      SCRIPT_MAIN_OPTS_FIRST  {{script/main-opts.0|pr-str}}
+      SCRIPT_MAIN_OPTS_SECOND {{script/main-opts.1|pr-str}} 
+      TMP_EDN (doto (fs/file (fs/temp-dir) (str (gensym \"bbin\")))
+                      (spit (str \"{:deps {\" SCRIPT_LIB SCRIPT_COORDS\"}}\"))
+                      (fs/delete-on-exit))]
+                        
+     (process/exec
+        (str/join \" \" (concat [\"bb --deps-root\" SCRIPT_ROOT \"--config\" (str TMP_EDN)
+                         SCRIPT_MAIN_OPTS_FIRST SCRIPT_MAIN_OPTS_SECOND
+                         \"--\"] *command-line-args*))))"
+;
+; non-windows script template
+;
   "#!/usr/bin/env bash
 set -e
 
@@ -174,7 +259,7 @@ exec bb \\
   --deps-root \"$SCRIPT_ROOT\" \\
   --config <(echo \"{:deps {$SCRIPT_LIB $SCRIPT_COORDS}}\") \\
   $SCRIPT_MAIN_OPTS_FIRST \"$SCRIPT_MAIN_OPTS_SECOND\" \\
-  -- \"$@\"")
+  -- \"$@\""))
 
 (defn- http-url->script-name [http-url]
   (first
@@ -201,6 +286,23 @@ exec bb \\
                            code)]
     (str/join "\n" next-lines)))
 
+(defn- install-script 
+  "Spits `contents` to `path` (adding an extension on Windows), or 
+  pprints them if `dry-run?` is truthy.
+  Side-effecting."
+  [path contents dry-run?]
+  (let [path-str (str path)]
+    (if dry-run?
+      (pprint {:script-file     path-str
+               :script-contents contents}
+        dry-run?)
+      (do
+        (spit path-str contents)
+        (when-not util/windows? (sh ["chmod" "+x" path-str]))
+        (when util/windows? 
+          (spit (str path-str windows-wrapper-extension) (str "@bb -f %~dp0" (fs/file-name path-str) " -- %*")))
+        nil))))
+
 (defn- install-http [cli-opts]
   (let [http-url (:script/lib cli-opts)
         script-deps {:bbin/url http-url}
@@ -211,14 +313,7 @@ exec bb \\
                             (insert-script-header header))
         script-file (fs/canonicalize (fs/file (util/bin-dir cli-opts) script-name)
                                      {:nofollow-links true})]
-    (if (:dry-run cli-opts)
-      (pprint {:script-file (str script-file)
-               :script-contents script-contents}
-              cli-opts)
-      (do
-        (spit (str script-file) script-contents)
-        (sh ["chmod" "+x" (str script-file)])
-        nil))))
+    (install-script script-file script-contents (:dry-run cli-opts))))
 
 (defn- default-script-config [cli-opts]
   (let [[ns name] (str/split (:script/lib cli-opts) #"/")
@@ -253,7 +348,7 @@ exec bb \\
                       (:main-opts script-config))
         template-opts {:script/meta (->> script-edn-out
                                          str/split-lines
-                                         (map #(str "# " %))
+                                         (map #(str comment-char %))
                                          (str/join "\n"))
                        :script/root script-root
                        :script/lib (pr-str (key (first script-deps)))
@@ -272,16 +367,34 @@ exec bb \\
         template-out (selmer-util/without-escaping
                        (selmer/render template-str template-opts'))
         script-file (fs/canonicalize (fs/file (util/bin-dir cli-opts) script-name) {:nofollow-links true})]
-    (if (:dry-run cli-opts)
-      (pprint {:script-file (str script-file)
-               :template-out template-out}
-              cli-opts)
-      (do
-        (spit (str script-file) template-out)
-        (sh ["chmod" "+x" (str script-file)])
-        nil))))
+    (install-script script-file template-out (:dry-run cli-opts))))
 
 (def ^:private maven-template-str
+  (if util/windows?
+    "#!/usr/bin/env bb
+; :bbin/start
+;
+{{script/meta}}
+; :bbin/end
+(require '[babashka.process :as process]
+         '[babashka.fs :as fs]
+         '[clojure.string :as str])
+
+(let [SCRIPT_LIB     '{{script/lib}}
+      SCRIPT_COORDS  {{script/coords|str}}
+      SCRIPT_MAIN_OPTS_FIRST  {{script/main-opts.0|pr-str}}
+      SCRIPT_MAIN_OPTS_SECOND {{script/main-opts.1|pr-str}} 
+      TMP_EDN (doto (fs/file (fs/temp-dir) (str (gensym \"bbin\")))
+                 (spit (str \"{:deps {\" SCRIPT_LIB SCRIPT_COORDS \"}}\"))
+                 (fs/delete-on-exit))]
+                                         
+(process/exec
+  (str/join \" \" (concat [\"bb --config\" (str TMP_EDN)
+                   SCRIPT_MAIN_OPTS_FIRST SCRIPT_MAIN_OPTS_SECOND
+                   \"--\"] *command-line-args*))))\""
+;
+; non-windows script template
+;  
   "#!/usr/bin/env bash
 set -e
 
@@ -299,7 +412,7 @@ SCRIPT_MAIN_OPTS_SECOND='{{script/main-opts.1}}'
 exec bb \\
   --config <(echo \"{:deps {$SCRIPT_LIB $SCRIPT_COORDS}}\") \\
   $SCRIPT_MAIN_OPTS_FIRST \"$SCRIPT_MAIN_OPTS_SECOND\" \\
-  -- \"$@\"")
+  -- \"$@\""))
 
 (defn- install-deps-maven [cli-opts]
   (let [script-deps {(edn/read-string (:script/lib cli-opts))
@@ -318,7 +431,7 @@ exec bb \\
                       (:main-opts script-config))
         template-opts {:script/meta (->> script-edn-out
                                          str/split-lines
-                                         (map #(str "# " %))
+                                         (map #(str comment-char %))
                                          (str/join "\n"))
                        :script/root script-root
                        :script/lib (pr-str (key (first script-deps)))
@@ -331,14 +444,7 @@ exec bb \\
         template-out (selmer-util/without-escaping
                        (selmer/render maven-template-str template-opts))
         script-file (fs/canonicalize (fs/file (util/bin-dir cli-opts) script-name) {:nofollow-links true})]
-    (if (:dry-run cli-opts)
-      (pprint {:script-file (str script-file)
-               :template-out template-out}
-              cli-opts)
-      (do
-        (spit (str script-file) template-out)
-        (sh ["chmod" "+x" (str script-file)])
-        nil))))
+    (install-script script-file template-out (:dry-run cli-opts))))
 
 (defn- parse-script [s]
   (let [lines (str/split-lines s)
@@ -356,6 +462,7 @@ exec bb \\
        (filter #(.isFile %))
        (map (fn [x] [(symbol (str (fs/relativize (util/bin-dir cli-opts) x)))
                      (parse-script (slurp x))]))
+       (filter second)
        (into {})))
 
 (defn ls [cli-opts]
@@ -386,6 +493,7 @@ exec bb \\
       (let [script-name (:script/lib cli-opts)
             script-file (fs/canonicalize (fs/file (util/bin-dir cli-opts) script-name) {:nofollow-links true})]
         (when (fs/delete-if-exists script-file)
+          (when util/windows? (fs/delete-if-exists (fs/file (str script-file windows-wrapper-extension))))
           (println "Removing" (str script-file)))))))
 
 (ns babashka.bbin.cli

bbin.bat

@@ -0,0 +1,4 @@
+@echo off
+set ARGS=%*
+set SCRIPT=%~dp0bbin
+bb -f %SCRIPT% %ARGS%

docs/design.md

@@ -5,3 +5,21 @@
 - Provide a CLI that's easy to remember and type
 - Allow project authors to provide default script names
 - When possible, follow existing patterns from `tools.deps` for managing dependencies
+
+
+## Basic Flows
+### `install`
+- Determine the type of install (http, maven, etc)
+- Build the script from the corresponding template
+  - Selmer template rendering of a bash script (or a babashka script on Windows)
+  - Script also includes commented metadata for use by `ls`
+- Write script out to bbin's bin directory (~/.bbin/bin)
+  - On Windows, a batch file is also written to provide a command-line executable
+
+### `uninstall`
+- Delete the script created by install
+  - On Windows, also delete the batch file 
+
+### `ls`
+- Find all files in the bin directory that contain metadata
+- pprint a map of script -> metadata