From ff019956912e46d82791d355bef64b6e13530678 Mon Sep 17 00:00:00 2001 From: Daniel Imms <2193314+Tyriar@users.noreply.github.com> Date: Sun, 7 Jul 2024 08:32:19 -0700 Subject: [PATCH] Improve testing instructions --- CONTRIBUTING.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b71f746f..6c1633dd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,25 +65,22 @@ One area that always needs attention is improving out unit test coverage, you ca ### Unit tests -All unit tests can be run with: +Unit tests are run with `yarn test-unit`: ```sh +# All unit tests yarn test-unit -``` -Run a subset of tests like this: - -```sh -# Absolute file path: +# Absolute file path yarn test-unit out-esbuild/browser/Terminal.test.js -# Wildcard: +# Filter by wildcard yarn test-unit out-esbuild/**/Terminal.test.js -# All of an specific addon's tests: +# Specific addon unit tests tests yarn test-unit addons/addon-image/out-esbuild/*.test.js -# Multiple files: +# Multiple files yarn test-unit out-esbuild/**/Terminal.test.js out-esbuild/**/InputHandler.test.js ``` @@ -91,16 +88,16 @@ These use mocha to run all `.test.js` files within the esbuild output (`out-esbu ### Integration tests -All integration tests can be run with: +Integration tests are run with `yarn test-integration`: ```sh +# All integration tests yarn test-integration -``` -Run a particular suite with the `--suite` flag: - -```sh +# Core integration tests yarn test-integration --suite=core + +# Specific addon integration tests yarn test-integration --suite=addon-search ```