From 49c428c86fab2b82d863f4dedea3afd77f1173b1 Mon Sep 17 00:00:00 2001 From: Ian VanSchooten Date: Fri, 17 Nov 2023 08:26:36 -0500 Subject: [PATCH 1/2] Clarify difference between skipped and excluded tags --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 572b0f43..89534a64 100644 --- a/README.md +++ b/README.md @@ -165,7 +165,7 @@ Usage: test-storybook [options] | `--failOnConsole` | Makes tests fail on browser console errors
`test-storybook --failOnConsole` | | `--includeTags` | (experimental) Only test stories that match the specified tags, comma separated
`test-storybook --includeTags="test-only"` | | `--excludeTags` | (experimental) Do not test stories that match the specified tags, comma separated
`test-storybook --excludeTags="broken-story,todo"` | -| `--skipTags` | (experimental) Skip test stories that match the specified tags, comma separated
`test-storybook --skipTags="design"` | +| `--skipTags` | (experimental) Do not test stories that match the specified tags and mark them as skipped in the CLI output, comma separated
`test-storybook --skipTags="design"` | ## Ejecting configuration @@ -240,6 +240,8 @@ export const Secondary = { Once your stories have your own custom tags, you can filter them via the [tags property](#tags-experimental) in your test-runner configuration file. You can also use the CLI flags `--includeTags`, `--excludeTags` or `--skipTags` for the same purpose. The CLI flags will take precedence over the tags in the test-runner config, therefore overriding them. +Both `--skipTags` and `--excludeTags` will prevent a story from being tested. The difference is that skipped tets will appear as "skipped" in the cli output, whereas excluded tests will not appear at all. Skipped tests can be useful to indicate tests that are temporarily disabled. + ## Test reporters The test runner uses default Jest reporters, but you can add additional reporters by ejecting the configuration as explained above and overriding (or merging with) the `reporters` property. From 77751c3332e338c4dc6d1e0619e4fc580fa88272 Mon Sep 17 00:00:00 2001 From: Yann Braga Date: Fri, 17 Nov 2023 14:43:49 +0100 Subject: [PATCH 2/2] Update README.md [skip-ci] --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 89534a64..2be361cb 100644 --- a/README.md +++ b/README.md @@ -240,7 +240,7 @@ export const Secondary = { Once your stories have your own custom tags, you can filter them via the [tags property](#tags-experimental) in your test-runner configuration file. You can also use the CLI flags `--includeTags`, `--excludeTags` or `--skipTags` for the same purpose. The CLI flags will take precedence over the tags in the test-runner config, therefore overriding them. -Both `--skipTags` and `--excludeTags` will prevent a story from being tested. The difference is that skipped tets will appear as "skipped" in the cli output, whereas excluded tests will not appear at all. Skipped tests can be useful to indicate tests that are temporarily disabled. +Both `--skipTags` and `--excludeTags` will prevent a story from being tested. The difference is that skipped tests will appear as "skipped" in the cli output, whereas excluded tests will not appear at all. Skipped tests can be useful to indicate tests that are temporarily disabled. ## Test reporters