diff --git a/.VERSION_PREFIX b/.VERSION_PREFIX index aafe62c3..38ab2bd6 100644 --- a/.VERSION_PREFIX +++ b/.VERSION_PREFIX @@ -1 +1 @@ -1.75 \ No newline at end of file +1.76 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 6df21e24..992e81b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# Unreleased +# 1.76.1230 (2023-01-25 / 2b9d9df) ## Added @@ -986,4 +986,4 @@ namespace. - The configuration format has changed, you should now start with the `#kaocha {}` tagged reader literal in `tests.edn` to provide defaults. If you want more control then overwrite `tests.edn` with the output of `--print-config` and - tweak. + tweak. \ No newline at end of file diff --git a/README.md b/README.md index d7ea00e2..41872456 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ There is also a [#kaocha](https://clojurians.slack.com/messages/CCY2V0U6A/convo/ - [CLI: `--reporter` option](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/cli-reporter-option) - [CLI: Selecting test suites](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/cli-selecting-test-suites) - [Configuration: Bindings](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/configuration-bindings) +- [Configuration: Warnings](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/configuration-warnings) - [Focusing based on metadata](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/focusing-based-on-metadata) - [Focusing on specific tests](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/focusing-on-specific-tests) - [Skipping based on metadata](https://cljdoc.org/d/lambdaisland/kaocha/CURRENT/doc/skipping-based-on-metadata) @@ -103,7 +104,7 @@ Add Kaocha as a dependency, preferably under an alias. ;; deps.edn {:deps { ,,, } :aliases - {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.75.1190"}} + {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.76.1230"}} :main-opts ["-m" "kaocha.runner"]}}} ``` @@ -124,7 +125,7 @@ Add a profile and alias ;; project.clj (defproject my-proj "0.1.0" :dependencies [,,,] - :profiles {:kaocha {:dependencies [[lambdaisland/kaocha "1.75.1190"]]}} + :profiles {:kaocha {:dependencies [[lambdaisland/kaocha "1.76.1230"]]}} :aliases {"kaocha" ["with-profile" "+kaocha" "run" "-m" "kaocha.runner"]}) ``` @@ -168,7 +169,7 @@ options. If you nonetheless prefer `:exec-fn`/`-X`, you can set up `deps.edn`: ;; deps.edn {:deps { ,,, } :aliases - {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.75.1190"}} + {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.76.1230"}} :exec-fn kaocha.runner/exec-fn :exec-args {}}}} ``` @@ -189,10 +190,10 @@ of tests skipped. You could save that configuration with an additional alias: ;; deps.edn {:deps { ,,, } :aliases - {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.75.1190"}} + {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.76.1230"}} :exec-fn kaocha.runner/exec-fn :exec-args {}} - :watch-test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.75.1190"}} + :watch-test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.76.1230"}} :exec-fn kaocha.runner/exec-fn :exec-args {:watch? true :skip-meta :slow @@ -323,4 +324,4 @@ line with the project's goals. Copyright © 2018-2023 Arne Brasseur and contributors Available under the terms of the Eclipse Public License 1.0, see LICENSE.txt - \ No newline at end of file + diff --git a/doc/02_installing.md b/doc/02_installing.md index 9d5b1e93..76191400 100644 --- a/doc/02_installing.md +++ b/doc/02_installing.md @@ -9,7 +9,7 @@ The main namespace for use at the command line is `kaocha.runner`, regardless of For example: ``` shell -clojure -Sdeps '{:deps {lambdaisland/kaocha {:mvn/version "1.75.1190"}}}' -m kaocha.runner --test-help +clojure -Sdeps '{:deps {lambdaisland/kaocha {:mvn/version "1.76.1230"}}}' -m kaocha.runner --test-help ``` Below are instructions on the recommended way to set things up for various build tools. @@ -23,7 +23,7 @@ In `deps.edn`, create a `test` "alias" (profile) that loads the `lambdaisland/ka {:deps { ,,, } :aliases {:test {:main-opts ["-m" "kaocha.runner"] - :extra-deps {lambdaisland/kaocha {:mvn/version "1.75.1190"}}}}} + :extra-deps {lambdaisland/kaocha {:mvn/version "1.76.1230"}}}}} ``` Other dependencies that are only used for tests, like test framework or assertion @@ -82,7 +82,7 @@ options. If you nonetheless prefer `:exec-fn`/`-X`, you can set up `deps.edn`: ;; deps.edn {:deps { ,,, } :aliases - {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.75.1190"}} + {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.76.1230"}} :exec-fn kaocha.runner/exec-fn :exec-args {}}}} ``` @@ -103,10 +103,10 @@ of tests skipped. You could save that configuration with an additional alias: ;; deps.edn {:deps { ,,, } :aliases - {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.75.1190"}} + {:test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.76.1230"}} :exec-fn kaocha.runner/exec-fn :exec-args {}} - :watch-test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.75.1190"}} + :watch-test {:extra-deps {lambdaisland/kaocha {:mvn/version "1.76.1230"}} :exec-fn kaocha.runner/exec-fn :exec-args {:watch? true :skip-meta :slow @@ -123,7 +123,7 @@ Add Kaocha to your `:dev` profile, then add an alias that invokes `lein run -m k ``` clojure (defproject my-proj "0.1.0" :dependencies [,,,] - :profiles {:dev {:dependencies [,,, [lambdaisland/kaocha "1.75.1190"]]}} + :profiles {:dev {:dependencies [,,, [lambdaisland/kaocha "1.76.1230"]]}} :aliases {"kaocha" ["run" "-m" "kaocha.runner"]}) ``` @@ -156,7 +156,7 @@ alias that activates the profile and invokes `lein run -m kaocha.runner`: ``` clojure (defproject my-proj "0.1.0" :dependencies [,,,] - :profiles {:kaocha {:dependencies [[lambdaisland/kaocha "1.75.1190"]]}} + :profiles {:kaocha {:dependencies [[lambdaisland/kaocha "1.76.1230"]]}} :aliases {"kaocha" ["with-profile" "+kaocha" "run" "-m" "kaocha.runner"]}) ``` diff --git a/doc/config/warnings.md b/doc/config/warnings.md new file mode 100644 index 00000000..a63634d5 --- /dev/null +++ b/doc/config/warnings.md @@ -0,0 +1,60 @@ + + +# Configuration: Warnings + +Kaocha will warn about common mistakes. + +## No config + +- Given a file named "test/my/foo_test.clj" with: + +``` clojure +(ns my.foo-test + (:require [clojure.test :refer :all])) + +(deftest var-test + (is (= 456 456))) +``` + + +- When I run `bin/kaocha -c alt-tests.edn` + +- Then stderr should contain: + +``` nil +Did not load a configuration file and using the defaults. +``` + + + +## Warn about bad configuration + +- Given a file named "tests.edn" with: + +``` clojure +#kaocha/v1 +{:plugins notifier} +``` + + +- And a file named "test/my/foo_test.clj" with: + +``` clojure +(ns my.foo-test + (:require [clojure.test :refer :all])) + +(deftest var-test + (is (= 456 456))) +``` + + +- When I run `bin/kaocha` + +- Then stderr should contain: + +``` nil +Invalid configuration file: +``` + + +