devenv-run-tests: run examples+tests by default

cachix · Oct 7, 2024 · 9eccaee · 9eccaee
1 parent fed89ff
commit 9eccaee
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/devenv-run-tests/src/main.rs b/devenv-run-tests/src/main.rs
@@ -23,7 +23,7 @@ struct Args {
     )]
     override_input: Vec<String>,
 
-    #[clap(value_parser, required = true)]
+    #[clap(value_parser, default_values = vec!["examples", "tests"])]
     directories: Vec<PathBuf>,
 }
 

diff --git a/docs/community/contributing.md b/docs/community/contributing.md
@@ -38,13 +38,13 @@ of source code directory by calling `<PATH-TO-DEVENV-SOURCE-CODE>/result/bin/dev
 - Examples are automatically tested on CI and are the best way to work on developing new modules, see `examples/` and `tests/`
 - Documentation is in `docs/`.
 - To run a development server, run `devenv up`.
-- To run a test, run `devenv-run-tests --only <example-name> examples`.
+- To run a test from `examples/` or `tests/`, run `devenv-run-tests --only <name>`.
 
 ## Contributing language improvements
 
 Language integration happens in stages. We welcome even the most basic support for getting started.
 
-The most basic language support starts with the `languages.*.enable` flag, which turns on basic tooling. 
+The most basic language support starts with the `languages.*.enable` flag, which turns on basic tooling.
 For an example, see `src/modules/languages/elm.nix`.
 
 The next step is to make the tooling customizable, so the versions can be overridden.