Add more libraries to lib tests

We now also run unit tests for following libries against rewrite-clj v1:
- depot
- kibit
- lein-ancient
- mutant

Update docs to track what we lib test in README only.
Was formerly also tracking in design notes and developer user guide.

Author: lread

README.adoc

@@ -42,36 +42,38 @@ See https://github.com/clj-commons/rewrite-clj/projects/1[project page for curre
 ** link:doc/design/01-merging-rewrite-clj-and-rewrite-cljs.adoc[Merging rewrite-clj and rewrite-cljs]
 * link:doc/03-faq.adoc[FAQ]
 
+[[used-in]]
 == Used In...
 
 Some projects using rewrite-clj v1
 
-* https://github.com/liquidz/antq[antq] ^t^
-* https://github.com/borkdude/carve[carve] ^t^ (in dev)
-* https://github.com/clojure-lsp/clojure-lsp[clojure-lsp] ^t^ (in dev)
-* https://github.com/borkdude/rewrite-edn[rewrite-edn] ^t^
-* https://github.com/lread/test-doc-blocks[test-doc-blocks]
+* https://github.com/liquidz/antq[antq] ^🐥^
+* https://github.com/borkdude/carve[carve] ^🐥^ (in dev)
+* https://github.com/clojure-lsp/clojure-lsp[clojure-lsp] ^🐥^ (in dev)
+* https://github.com/borkdude/rewrite-edn[rewrite-edn] ^🐥^
+* https://github.com/lread/test-doc-blocks[test-doc-blocks] ^🐥^
 
 Some projects using rewrite-clj v0 and/or rewrite-cljs
 
-* https://github.com/mauricioszabo/atom-chlorine[atom-chlorine]
-* https://github.com/weavejester/cljfmt[cljfmt] ^t^
-* https://github.com/greglook/cljstyle[cljstyle] ^t^ ^h^
-* https://github.com/Olical/depot[depot]
-* https://github.com/jonase/kibit[kibit]
-* https://github.com/xsc/lein-ancient[lein-ancient]
-* https://github.com/benedekfazekas/mranderson[mranderson] ^t^
-* https://github.com/jstepien/mutant[mutant]
-* https://github.com/juxt/pack.alpha[pack (alpha)]
-* https://github.com/clojure-emacs/refactor-nrepl[refactor-nrepl] ^t^
-* https://github.com/mauricioszabo/repl-tooling[repl-tooling]
-* https://github.com/atomist-skills/update-leiningen-dependencies-skill[update-leiningen-dependencies-skill]
-* https://github.com/kkinnear/zprint[zprint] ^t^ ^h^
+* https://github.com/mauricioszabo/atom-chlorine[atom-chlorine] ^📍^
+* https://github.com/weavejester/cljfmt[cljfmt] ^🐥^
+* https://github.com/greglook/cljstyle[cljstyle] ^🐥^ ^🩹^
+* https://github.com/Olical/depot[depot] ^🐥^ ^🩹^
+* https://github.com/jonase/kibit[kibit] ^🐥^
+* https://github.com/xsc/lein-ancient[lein-ancient] ^🐥^
+* https://github.com/benedekfazekas/mranderson[mranderson] ^🐥^
+* https://github.com/jstepien/mutant[mutant] ^🐥^
+* https://github.com/juxt/pack.alpha[pack (alpha)] ^📍^
+* https://github.com/clojure-emacs/refactor-nrepl[refactor-nrepl] ^🐥^
+* https://github.com/mauricioszabo/repl-tooling[repl-tooling] ^📍^
+* https://github.com/atomist-skills/update-leiningen-dependencies-skill[update-leiningen-dependencies-skill] ^📍^
+* https://github.com/kkinnear/zprint[zprint] ^🐥^ ^🩹^
 
 Have an update? Let us know!
 
-^t^ [.small]#included in rewrite-clj v1 link:doc/02-developer-guide.adoc#libs-test[lib test suite]# +
-^h^ [.small]#required minor change to work with rewrite-clj v1#
+^🐥^ [.small]#canary tested against rewrite-clj v1 link:doc/02-developer-guide.adoc#libs-test[lib test suite]# +
+^🩹^ [.small]#source required minor change to work with rewrite-clj v1# +
+^📍^ [.small]#no easy to run unit tests found for this project#
 
 == Versioning
 

doc/02-developer-guide.adoc

@@ -210,18 +210,7 @@ To try to ensure our changes to rewrite-clj do not inadvertently break existing
 bb ./script/libs_tests.clj run
 ----
 
-Current libs we test against:
-
-* antq
-* carve
-* cljfmt
-* cljstyle
-* clojure-lsp
-* mranderson
-* rewrite-edn
-* refactor-nrepl
-* test-doc-blocks
-* zprint
+See link:../README.adoc#used-in[README] for current libs we test against.
 
 Additional libs are welcome.
 

doc/design/01-merging-rewrite-clj-and-rewrite-cljs.adoc

@@ -77,121 +77,105 @@ We'll happily continue with `rewrite-clj` for rewrite-clj v1 work:
 I've tried to make note of popular/active projects that make use of rewrite-clj v0 and rewrite-cljs.
 I've linked where I've explicitly verified a migration to rewrite-clj v1.
 
-[cols="15%,20%,20%,15%,30%"]
+See README for up to date list of which libraries directly use so form of rewrite-clj and which ones we are currently link:#canary-testing[canary testing].
+
+[cols="15%,20%,20%,55%"]
 |===
-| Project | rewrite‑clj? | rewrite‑cljs? | link:#canary-testing[Canary Tested?] | Notes
+| Project | rewrite‑clj? | rewrite‑cljs? | Notes
 
 | https://github.com/mauricioszabo/atom-chlorine[chlorine]
 |
 | yes
-|
-| REPL support for Atom editor
+| REPL support for Atom editor. +
+I do not see easy to run unit tests for this project.
 
 | https://github.com/borkdude/clj-kondo[clj-kondo]
 | custom version
 |
-|
 | uses an internal custom version of rewrite-clj
 
 | https://github.com/weavejester/cljfmt[cljfmt]
 | yes
 | yes
-| yes
 | source code formatter
 
 | https://github.com/greglook/cljstyle[cljstyle]
 | yes
 |
-|
 | source code formatter based on cljfmt
 
 | https://github.com/snoe/clojure-lsp[clojure-lsp]
 | yes
 |
-| yes
 | language server for Clojure
 
 | https://github.com/Olical/depot[depot]
 | yes
 |
-|
 | find newer versions of your deps.edn dependencies
 
 | https://github.com/jonase/kibit[kibit]
 | yes
 |
-|
 | Finds non-idiomatic Clojure code
 
 | https://github.com/xsc/lein-ancient[lein-ancient]
 | yes
 |
-|
 | find newer versions of your lein dependencies
 
 | https://github.com/benedekfazekas/mranderson[MrAnderson]
 | yes
 |
-| yes
 | Dependency inliner
 
 | https://github.com/jstepien/mutant[mutant]
 | yes
 |
-|
 | Source code mutator
 
 | https://github.com/juxt/pack.alpha[pack (alpha)]
 | yes
 |
-|
 | Clojure project packager
 
 | https://github.com/bhauman/rebel-readline[rebel-readline]
 | indirectly via cljfmt
 |
-|
 | smart editing at at the REPL terminal, optionally used in conjunction with https://github.com/bhauman/figwheel-main[figwheel-main]
 
 | https://github.com/cognitect-labs/REBL-distro[REBL]
 | indirectly via cljfmt
 |
-|
 | graphical interactive tool for browsing Clojure data
 
 | https://github.com/clojure-emacs/refactor-nrepl[refactor-nrepl]
 | yes
 |
-| yes
 | refactoring support used in conjunction with https://github.com/clojure-emacs/cider[cider]
 
 | https://github.com/mauricioszabo/repl-tooling[repl-tooling]
 |
 | yes
-|
-| base package for Clojure editor tooling. Interesting: uses rewrite-clj.reader directly.
+| base package for Clojure editor tooling. Interesting: uses rewrite-clj.reader directly. +
+I do not see easy to run unit tests for this project.
 
 | https://github.com/atomist-skills/update-leiningen-dependencies-skill[update-leiningen-dependencies-skill]
 |
 | yes
-|
 | dependency version tracker, great for a migration test of a project that uses shadow-cljs
 
 | https://github.com/kkinnear/zprint[zprint]
 | yes
 | yes
-| yes
 | source code formatter
 
 |===
 
 [#rewrite-clj-v1-libs]
 == Projects Using rewrite-clj v1
-We have at least three early adopters, for all of which we do link:#canary-testing[canary testing]:
 
-* https://github.com/liquidz/antq[antq]
-* https://github.com/borkdude/carve[carve]
-* https://github.com/borkdude/rewrite-edn[rewrite-edn]
+See README for up to date list.
 
 [#canary-testing]
 == Canary Testing

script/libs_tests.clj

@@ -230,6 +230,44 @@
                    "java.lang.Exception: Unexpected"
                    "clojure.lang.ExceptionInfo: Unexpected"))
 
+;;
+;; depot
+;;
+(defn depot-patch [{:keys [home-dir rewrite-clj-version]}]
+  (patch-deps {:filename (str (fs/file home-dir "deps.edn"))
+               :removals #{'rewrite-clj/rewrite-clj}
+               :additions {'rewrite-clj/rewrite-clj {:mvn/version rewrite-clj-version}}})
+  (patch-rewrite-cljc-sources home-dir)
+  (status/line :detail "=> depot uses but does not require rewrite-clj.node, need to adjust for rewrite-clj v1")
+  (replace-in-file (str (fs/file home-dir "src/depot/zip.clj"))
+                   "[rewrite-clj.zip :as rzip]"
+                   "[rewrite-clj.zip :as rzip] [rewrite-clj.node]"))
+
+;;
+;; kibit patch
+;;
+(defn- kibit-patch [{:keys [home-dir rewrite-clj-version]}]
+  (patch-deps {:filename (str (fs/file home-dir "project.clj"))
+               :removals #{'rewrite-clj 'org.clojure/clojure}
+               :additions [['rewrite-clj rewrite-clj-version]
+                           ['org.clojure/clojure "1.9.0"]]}))
+
+;;
+;; lein ancient
+;; 
+(defn- lein-ancient-patch [{:keys [home-dir rewrite-clj-version]}]
+  (status/line :detail "=> Patching deps")
+  (let [p (str (fs/file home-dir "project.clj"))]
+    (-> p
+        slurp
+        ;; done with exercising my rewrite-clj skills for now! :-)
+        (string/replace #"rewrite-clj \"[0-9.]+\""
+                        (format "rewrite-clj \"%s\"" rewrite-clj-version))
+        ;; lein-ancient uses pedantic? :abort, so need to match clojure versions
+        (string/replace #"\[org.clojure/clojure .*\]"
+                        "[org.clojure/clojure \"1.10.3\" :scope \"provided\"]")
+        (->> (spit p)))))
+
 ;;
 ;; mranderson
 ;; 
@@ -245,6 +283,15 @@
                         "[$1 :exclusions [org.clojure/tools.reader]]")
         (->> (spit p)))))
 
+;;
+;; mutant
+;;
+(defn- mutant-patch [{:keys [home-dir rewrite-clj-version]}]
+  (patch-deps {:filename (str (fs/file home-dir "project.clj"))
+               :removals #{'rewrite-clj 'org.clojure/clojure}
+               :additions [['rewrite-clj rewrite-clj-version]
+                           ['org.clojure/clojure "1.9.0"]]}))
+
 ;;
 ;; refactor-nrepl
 ;; 
@@ -353,6 +400,32 @@
             :patch-fn clojure-lsp-patch
             :show-deps-fn lein-deps-tree
             :test-cmds [["lein" "test"]]}
+           {:name "depot"
+            :platforms [:clj]
+            :note "1 patch required due to using, but not requiring, rewrite-clj.node"
+            :version "2.1.0"
+            :github-release {:repo "Olical/depot"
+                             :version-prefix "v"}
+            :patch-fn depot-patch
+            :show-deps-fn cli-deps-tree
+            :test-cmds [["bin/kaocha" "--reporter" "documentation"]]}
+           {:name "kibit"
+            :platforms [:clj]
+            :root "kibit"
+            :version "0.1.8"
+            :github-release {:repo "jonase/kibit"}
+            :patch-fn kibit-patch
+            :show-deps-fn lein-deps-tree
+            :test-cmds [["lein" "test-all"]]}
+           {:name "lein-ancient"
+            :platforms [:clj]
+            :version "1.0.0-RC3"
+            :github-release {:repo "xsc/lein-ancient"
+                             :via :tag
+                             :version-prefix "v"}
+            :patch-fn lein-ancient-patch
+            :show-deps-fn lein-deps-tree
+            :test-cmds [["lein" "test"]]}
            {:name "mranderson"
             :version "0.5.3"
             :platforms [:clj]
@@ -362,10 +435,19 @@
             :patch-fn mranderson-patch
             :show-deps-fn lein-deps-tree
             :test-cmds [["lein" "test"]]}
-           {;; has a release on clojars but no release in GitHub repo
-            :name "rewrite-edn"
+           {:name "mutant"
+            :version "0.2.0"
+            :platforms [:clj]
+            :note "Dormant project"
+            :github-release {:repo "jstepien/mutant"
+                             :via :tag}
+            :patch-fn mutant-patch
+            :show-deps-fn lein-deps-tree
+            :test-cmds [["lein" "test"]]}
+           {:name "rewrite-edn"
             :version "8f75cf124984c6c4494df93ce10359de8beb588d"
             :platforms [:clj]
+            :note "has a relase on clojars but no release in GitHub repo"
             :github-release {:repo "borkdude/rewrite-edn"
                              :via :sha}
             :patch-fn deps-edn-v1-patch