From 2597b914bdef8205b6cef3e9acc3104fed19ac29 Mon Sep 17 00:00:00 2001 From: Tom Vaughan Date: Fri, 10 May 2024 20:49:49 -0400 Subject: [PATCH] Update README and kibit.driver/exec docstring. --- README.md | 6 ++---- src/kibit/driver.clj | 13 ++++++------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3a7e1f8..6f8eb77 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,7 @@ instead of: Add the following to your aliases ```clojure -:kibit {:extra-deps {clj-commons/kibit {:mvn/version "0.X.Y"}} +:kibit {:extra-deps {jonase/kibit {:mvn/version "0.1.10"}} :exec-fn kibit.driver/exec :exec-args {:paths ["."]}} ``` @@ -148,11 +148,9 @@ Add the following to your aliases Then run `clojure -X:kibit`. For more options, please see the docstring on `kibit.driver/exec`. -**NOTE:** At least Clojure v1.9 and Kibit v0.X.Y are required to use this +**NOTE:** At least Clojure v1.9 and Kibit v0.1.10 are required to use this exec-fn method. -For alternative options to use kibit from inside deps.edn, check out [this issue](https://github.com/clj-commons/kibit/issues/221) - ## Usage from inside Emacs If you use Emacs for hacking Clojure, here's a way to use kibit from diff --git a/src/kibit/driver.clj b/src/kibit/driver.clj index 628b200..4098aac 100644 --- a/src/kibit/driver.clj +++ b/src/kibit/driver.clj @@ -90,14 +90,13 @@ into an equivalent set of options as expected by run and external-run above. Please note that rules is not supported. nil is passed to external-run below - which enables all rules (see kibit.rules/all-rules). I don't know what rules - should be. A list of rule names as strings doesn't seem to be it. + which enables all rules (see kibit.rules/all-rules). **DO NOT** escape the dobule-quotes in deps.edn or on the command-line. To make use of this, add an alias, e.g. kibit, to deps.edn: - :kibit {:extra-deps {jonase/kibit {:mvn/version \"0.2.0\"}} + :kibit {:extra-deps {jonase/kibit {:mvn/version \"0.1.10\"}} :exec-fn kibit.driver/exec :exec-args {:paths [\"src\" \"test\"]}} @@ -108,18 +107,18 @@ Additional command-line options can be added in deps.edn or on the command-line. For example, in deps.edn: - :kibit {:extra-deps {jonase/kibit {:mvn/version \"0.2.0\"}} + :kibit {:extra-deps {jonase/kibit {:mvn/version \"0.1.10\"}} :exec-fn kibit.driver/exec :exec-args {:paths [\"src\" \"test\"] - :interactive true}} + :interactive true}} Or on the command-line: clojure -X:kibit :interactive true - To use [babashka.cli][babashka.cli], update the kibit aliasn in deps.edn: + To use [babashka.cli][babashka.cli], update the kibit alias in deps.edn: - :kibit {:extra-deps {jonase/kibit {:mvn/version \"0.2.0\"}} + :kibit {:extra-deps {jonase/kibit {:mvn/version \"0.1.10\"}} org.babashka/cli {:mvn/version \"0.7.51\"}} :exec-fn kibit.driver/exec :exec-args {:paths [\"src\" \"test\"]}