diff --git a/site/docs/commands/test.md b/site/docs/commands/test.md index 75d861ac7..5a203484f 100644 --- a/site/docs/commands/test.md +++ b/site/docs/commands/test.md @@ -31,15 +31,21 @@ very_good test [arguments] Run "very_good help" to see global options. ``` +:::tip +For **Dart** projects, use **`very_good dart test`** instead. + +All test parameters and options work identically with this command. +::: + ### Passing Flutter specific arguments -The `flutter test` command exposes more arguments than those available through `very_good test`. Despite this, you can use the argument terminator `--` to signify the end of `very_good test` command options and the beginning of `flutter test` command options; making all `flutter test` arguments available! +The `dart test` and `flutter test` commands expose more arguments than those available through `very_good dart test` or `very_good test`. However, you can use the argument terminator `--` to pass additional arguments directly to the underlying test commands. Any arguments after `--` will be forwarded to `dart test` or `flutter test`, making all their options available. For example, if you wish to run `flutter test --no-track-widget-creation` you can simply use `very_good test -- --no-track-widget-creation`. ### Tests without pub install -Unlike `flutter test`, `very_good test` will always run your tests without installing the projects dependencies (i.e. `--no-pub` flag). +Unlike `dart test` or `flutter test`, `very_good test` will always run your tests without installing the projects dependencies (i.e. `--no-pub` flag). This is an optimization done by the CLI because dependency installation is usually run once after cloning the repository. Conversely, running tests locally is usually done many times and it's often unnecessary to re-install dependencies prior to each test run. diff --git a/site/docs/overview.md b/site/docs/overview.md index 546873788..bc86c9bac 100644 --- a/site/docs/overview.md +++ b/site/docs/overview.md @@ -128,6 +128,12 @@ very_good test --recursive very_good test -r ``` +:::tip +For **Dart** projects, use **`very_good dart test`** instead. + +All test parameters and options work identically with this command. +::: + ### `very_good --help` See the complete list of commands and usage information.