From c5bfdab82ae14c5c69e2f1a6f3bd7f3d978a822f Mon Sep 17 00:00:00 2001 From: Jeppe Reinhold Date: Fri, 10 Feb 2023 14:50:22 +0100 Subject: [PATCH 1/2] Document index.json mode for Svelte CSF --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 418bc83f..c7723a7a 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,9 @@ yarn test-storybook --url https://the-storybook-url-here.com By default, the test runner transforms your story files into tests. It also supports a secondary "index.json mode" which runs directly against your Storybook's index data, which dependending on your Storybook version is located in a `stories.json` or `index.json`, a static index of all the stories. -This is particularly useful for running against a deployed storybook because `index.json` is guaranteed to be in sync with the Storybook you are testing. In the default, story file-based mode, your local story files may be out of sync – or you might not even have access to the source code. Furthermore, it is not possible to run the test-runner directly against `.mdx` stories, and `index.json` mode must be used. +This is particularly useful for running against a deployed storybook because `index.json` is guaranteed to be in sync with the Storybook you are testing. In the default, story file-based mode, your local story files may be out of sync – or you might not even have access to the source code. + +Furthermore, it is not possible to run the test-runner directly against `.mdx` stories or custom CSF dialects like when writing Svelte native stories with `addon-svelte-csf`. In these cases `index.json` mode must be used. From 5db77770ebb04c260a0487a41057f476a09ff1fe Mon Sep 17 00:00:00 2001 From: Jeppe Reinhold Date: Sat, 11 Feb 2023 22:06:21 +0100 Subject: [PATCH 2/2] README: link to addon-svelte-csf --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c7723a7a..5721b742 100644 --- a/README.md +++ b/README.md @@ -189,7 +189,7 @@ By default, the test runner transforms your story files into tests. It also supp This is particularly useful for running against a deployed storybook because `index.json` is guaranteed to be in sync with the Storybook you are testing. In the default, story file-based mode, your local story files may be out of sync – or you might not even have access to the source code. -Furthermore, it is not possible to run the test-runner directly against `.mdx` stories or custom CSF dialects like when writing Svelte native stories with `addon-svelte-csf`. In these cases `index.json` mode must be used. +Furthermore, it is not possible to run the test-runner directly against `.mdx` stories or custom CSF dialects like when writing Svelte native stories with [`addon-svelte-csf`](https://github.com/storybookjs/addon-svelte-csf). In these cases `index.json` mode must be used.