diff --git a/README.md b/README.md index 40bae3c..657bbed 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,12 @@ Flexible test runner for testing Nix code, written in Go. -[![asciicast](https://asciinema.org/a/VS8uIiEQiPRtXbOreJqrxO7X6.svg)](https://asciinema.org/a/VS8uIiEQiPRtXbOreJqrxO7X6) - ## Features - Snapshot, Unit (equal checks) and Script-Tests (unit tests with assertions you could say) - Supports testing against raw Nix code or derivation output - Simple and easy to read summary of test results - ![screenshot](./docs/images/summary_screenshot.png) - Junit report support (eg. for displaying the results in GitLab etc.) - ![screenshot](./docs/images/gitlab_junit_screenshot.png) ## Usage diff --git a/docs/cli.md b/docs/cli.md index 943939e..9c69c9c 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -3,11 +3,10 @@ ```sh title="nix run .#nixtests:run -- --help" Usage of nixtest: --junit string Path to generate JUNIT report to, leave empty to disable - --no-color Disable coloring --pure Unset all env vars before running script tests - -s, --skip string Regular expression to skip tests (e.g., 'test-.*|.*-b') + --skip string Regular expression to skip (e.g., 'test-.*|.*-b') --snapshot-dir string Directory where snapshots are stored (default "./snapshots") - -f, --tests string Path to JSON file containing tests (required) - -u, --update-snapshots Update all snapshots - -w, --workers int Amount of tests to run in parallel (default 4) + --tests string Path to JSON file containing tests + --update-snapshots Update all snapshots + --workers int Amount of tests to run in parallel (default 4) ``` diff --git a/docs/images/gitlab_junit_screenshot.png b/docs/images/gitlab_junit_screenshot.png deleted file mode 100644 index 03696af..0000000 Binary files a/docs/images/gitlab_junit_screenshot.png and /dev/null differ diff --git a/docs/images/summary_screenshot.png b/docs/images/summary_screenshot.png deleted file mode 100644 index af60a6d..0000000 Binary files a/docs/images/summary_screenshot.png and /dev/null differ diff --git a/docs/index.md b/docs/index.md index f9fc7b5..37124d9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,6 +7,4 @@ Flexible test runner for testing Nix code, written in Go. - Snapshot, Unit (equal checks) and Script-Tests (unit tests with assertions you could say) - Supports testing against raw Nix code or derivation output - Simple and easy to read summary of test results - ![screenshot](./images/summary_screenshot.png) - Junit report support (eg. for displaying the results in GitLab etc.) - ![screenshot](./images/gitlab_junit_screenshot.png) diff --git a/docs/usage.md b/docs/usage.md index fbcccb3..2c72e4a 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -93,7 +93,7 @@ Examples: name = "pretty-test"; # by default it uses json to serialize and compare the values. Derivations # and functions don't really work that way though, so you can also use - # "pretty" to use lib.generators.toPretty + # "pretty" to use lib.generators.pretty format = "pretty"; # you can also set the pos here pos = __curPos;