From 0f386d18962d699c2a9d29f5b62fa645ad887d5f Mon Sep 17 00:00:00 2001 From: figsoda Date: Mon, 28 Nov 2022 17:25:46 -0500 Subject: [PATCH] docs/rust: document `cargoNextestHook` and `useNextest` --- doc/languages-frameworks/rust.section.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/languages-frameworks/rust.section.md b/doc/languages-frameworks/rust.section.md index db5d8c699e3a..591014480299 100644 --- a/doc/languages-frameworks/rust.section.md +++ b/doc/languages-frameworks/rust.section.md @@ -331,6 +331,20 @@ rustPlatform.buildRustPackage { } ``` +#### Using `cargo-nextest` {#using-cargo-nextest} + +Tests can be run with [cargo-nextest](https://github.com/nextest-rs/nextest) +by setting `useNextest = true`. The same options still apply, but nextest +accepts a different set of arguments and the settings might need to be +adapted to be compatible with cargo-nextest. + +```nix +rustPlatform.buildRustPackage { + /* ... */ + useNextest = true; +} +``` + #### Setting `test-threads` {#setting-test-threads} `buildRustPackage` will use parallel test threads by default, @@ -474,6 +488,9 @@ you of the correct hash. flags can be passed to the tests using `checkFlags` and `checkFlagsArray`. By default, tests are run in parallel. This can be disabled by setting `dontUseCargoParallelTests`. +* `cargoNextestHook`: run tests using + [cargo-nextest](https://github.com/nextest-rs/nextest). The same + options for `cargoCheckHook` also applies to `cargoNextestHook`. * `cargoInstallHook`: install binaries and static/shared libraries that were built using `cargoBuildHook`. * `bindgenHook`: for crates which use `bindgen` as a build dependency, lets