From 4f9223d0393346646a47bbad249b338a7f3b5a89 Mon Sep 17 00:00:00 2001 From: Gaurav Singh Date: Wed, 31 Aug 2022 18:14:36 +0530 Subject: [PATCH 1/5] Remove sveltekit:start event Closes #6448 --- .changeset/perfect-cycles-smell.md | 5 +++++ documentation/docs/10-events.md | 7 ------- packages/kit/src/runtime/client/start.js | 2 -- packages/kit/test/utils.js | 10 ---------- 4 files changed, 5 insertions(+), 19 deletions(-) create mode 100644 .changeset/perfect-cycles-smell.md delete mode 100644 documentation/docs/10-events.md diff --git a/.changeset/perfect-cycles-smell.md b/.changeset/perfect-cycles-smell.md new file mode 100644 index 000000000000..b1d0a6d2fb94 --- /dev/null +++ b/.changeset/perfect-cycles-smell.md @@ -0,0 +1,5 @@ +--- +'@sveltejs/kit': patch +--- + +Remove sveltekit:start event diff --git a/documentation/docs/10-events.md b/documentation/docs/10-events.md deleted file mode 100644 index 205b399b30ca..000000000000 --- a/documentation/docs/10-events.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Events ---- - -SvelteKit emits a `sveltekit:start` [CustomEvent](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent) on the `window` object once the app has hydrated. - -You probably won't need to use it, but it can be useful in the context of (for example) integration tests. diff --git a/packages/kit/src/runtime/client/start.js b/packages/kit/src/runtime/client/start.js index ac27e445dc2a..7e8dd591a91a 100644 --- a/packages/kit/src/runtime/client/start.js +++ b/packages/kit/src/runtime/client/start.js @@ -42,6 +42,4 @@ export async function start({ env, hydrate, paths, target, trailing_slash }) { } client._start_router(); - - dispatchEvent(new CustomEvent('sveltekit:start')); } diff --git a/packages/kit/test/utils.js b/packages/kit/test/utils.js index 07d367f93d1e..3e23d49bb77e 100644 --- a/packages/kit/test/utils.js +++ b/packages/kit/test/utils.js @@ -78,16 +78,6 @@ export const test = base.extend({ }, page: async ({ page, javaScriptEnabled }, use) => { - if (javaScriptEnabled) { - page.addInitScript({ - content: ` - addEventListener('sveltekit:start', () => { - document.body.classList.add('started'); - }); - ` - }); - } - // automatically wait for kit started event after navigation functions if js is enabled const page_navigation_functions = ['goto', 'goBack', 'reload']; page_navigation_functions.forEach((fn) => { From 2979590c959436e9147dbe93133920f6946628e0 Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Wed, 31 Aug 2022 13:29:25 -0400 Subject: [PATCH 2/5] setup --- .../apps/basics/src/routes/+layout.svelte | 22 +++-------------- .../apps/dev-only/src/routes/+layout.svelte | 7 ++++++ .../apps/options-2/src/routes/+layout.svelte | 7 ++++++ .../apps/options/source/pages/+layout.svelte | 20 ++-------------- .../apps/writes/src/routes/+layout.svelte | 7 ++++++ packages/kit/test/setup.js | 24 +++++++++++++++++++ 6 files changed, 50 insertions(+), 37 deletions(-) create mode 100644 packages/kit/test/apps/dev-only/src/routes/+layout.svelte create mode 100644 packages/kit/test/apps/options-2/src/routes/+layout.svelte create mode 100644 packages/kit/test/apps/writes/src/routes/+layout.svelte create mode 100644 packages/kit/test/setup.js diff --git a/packages/kit/test/apps/basics/src/routes/+layout.svelte b/packages/kit/test/apps/basics/src/routes/+layout.svelte index b842834a6611..6272671c81ae 100644 --- a/packages/kit/test/apps/basics/src/routes/+layout.svelte +++ b/packages/kit/test/apps/basics/src/routes/+layout.svelte @@ -1,26 +1,10 @@ diff --git a/packages/kit/test/apps/dev-only/src/routes/+layout.svelte b/packages/kit/test/apps/dev-only/src/routes/+layout.svelte new file mode 100644 index 000000000000..5e1f1fed86c2 --- /dev/null +++ b/packages/kit/test/apps/dev-only/src/routes/+layout.svelte @@ -0,0 +1,7 @@ + + + diff --git a/packages/kit/test/apps/options-2/src/routes/+layout.svelte b/packages/kit/test/apps/options-2/src/routes/+layout.svelte new file mode 100644 index 000000000000..5e1f1fed86c2 --- /dev/null +++ b/packages/kit/test/apps/options-2/src/routes/+layout.svelte @@ -0,0 +1,7 @@ + + + diff --git a/packages/kit/test/apps/options/source/pages/+layout.svelte b/packages/kit/test/apps/options/source/pages/+layout.svelte index 030845a5d806..5e1f1fed86c2 100644 --- a/packages/kit/test/apps/options/source/pages/+layout.svelte +++ b/packages/kit/test/apps/options/source/pages/+layout.svelte @@ -1,23 +1,7 @@ diff --git a/packages/kit/test/apps/writes/src/routes/+layout.svelte b/packages/kit/test/apps/writes/src/routes/+layout.svelte new file mode 100644 index 000000000000..5e1f1fed86c2 --- /dev/null +++ b/packages/kit/test/apps/writes/src/routes/+layout.svelte @@ -0,0 +1,7 @@ + + + diff --git a/packages/kit/test/setup.js b/packages/kit/test/setup.js new file mode 100644 index 000000000000..68ce5230a683 --- /dev/null +++ b/packages/kit/test/setup.js @@ -0,0 +1,24 @@ +import { + goto, + invalidate, + prefetch, + prefetchRoutes, + beforeNavigate, + afterNavigate +} from '$app/navigation'; +import { onMount } from 'svelte'; + +export function setup() { + onMount(() => { + Object.assign(window, { + goto, + invalidate, + prefetch, + prefetchRoutes, + beforeNavigate, + afterNavigate + }); + + document.body.classList.add('started'); + }); +} From bc302f94f200e3d2ce943dc85f65d1fe32e406d6 Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Wed, 31 Aug 2022 13:33:55 -0400 Subject: [PATCH 3/5] rename docs files --- documentation/docs/{11-adapters.md => 10-adapters.md} | 0 documentation/docs/{12-page-options.md => 11-page-options.md} | 0 documentation/docs/{13-packaging.md => 12-packaging.md} | 0 documentation/docs/{14-cli.md => 13-cli.md} | 0 documentation/docs/{15-configuration.md => 14-configuration.md} | 0 documentation/docs/{16-types.md => 15-types.md} | 0 documentation/docs/{17-seo.md => 16-seo.md} | 0 documentation/docs/{18-assets.md => 17-assets.md} | 0 documentation/docs/{19-accessibility.md => 18-accessibility.md} | 0 9 files changed, 0 insertions(+), 0 deletions(-) rename documentation/docs/{11-adapters.md => 10-adapters.md} (100%) rename documentation/docs/{12-page-options.md => 11-page-options.md} (100%) rename documentation/docs/{13-packaging.md => 12-packaging.md} (100%) rename documentation/docs/{14-cli.md => 13-cli.md} (100%) rename documentation/docs/{15-configuration.md => 14-configuration.md} (100%) rename documentation/docs/{16-types.md => 15-types.md} (100%) rename documentation/docs/{17-seo.md => 16-seo.md} (100%) rename documentation/docs/{18-assets.md => 17-assets.md} (100%) rename documentation/docs/{19-accessibility.md => 18-accessibility.md} (100%) diff --git a/documentation/docs/11-adapters.md b/documentation/docs/10-adapters.md similarity index 100% rename from documentation/docs/11-adapters.md rename to documentation/docs/10-adapters.md diff --git a/documentation/docs/12-page-options.md b/documentation/docs/11-page-options.md similarity index 100% rename from documentation/docs/12-page-options.md rename to documentation/docs/11-page-options.md diff --git a/documentation/docs/13-packaging.md b/documentation/docs/12-packaging.md similarity index 100% rename from documentation/docs/13-packaging.md rename to documentation/docs/12-packaging.md diff --git a/documentation/docs/14-cli.md b/documentation/docs/13-cli.md similarity index 100% rename from documentation/docs/14-cli.md rename to documentation/docs/13-cli.md diff --git a/documentation/docs/15-configuration.md b/documentation/docs/14-configuration.md similarity index 100% rename from documentation/docs/15-configuration.md rename to documentation/docs/14-configuration.md diff --git a/documentation/docs/16-types.md b/documentation/docs/15-types.md similarity index 100% rename from documentation/docs/16-types.md rename to documentation/docs/15-types.md diff --git a/documentation/docs/17-seo.md b/documentation/docs/16-seo.md similarity index 100% rename from documentation/docs/17-seo.md rename to documentation/docs/16-seo.md diff --git a/documentation/docs/18-assets.md b/documentation/docs/17-assets.md similarity index 100% rename from documentation/docs/18-assets.md rename to documentation/docs/17-assets.md diff --git a/documentation/docs/19-accessibility.md b/documentation/docs/18-accessibility.md similarity index 100% rename from documentation/docs/19-accessibility.md rename to documentation/docs/18-accessibility.md From e944b3788dc1c3f82750df2bacf212e1578d1ef4 Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Wed, 31 Aug 2022 17:13:44 -0400 Subject: [PATCH 4/5] Update .changeset/perfect-cycles-smell.md --- .changeset/perfect-cycles-smell.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/perfect-cycles-smell.md b/.changeset/perfect-cycles-smell.md index b1d0a6d2fb94..829d784c5b3b 100644 --- a/.changeset/perfect-cycles-smell.md +++ b/.changeset/perfect-cycles-smell.md @@ -2,4 +2,4 @@ '@sveltejs/kit': patch --- -Remove sveltekit:start event +[breaking] Remove sveltekit:start event From 702e26d571fdc8289161e33bf7d0fd8a1e63eb09 Mon Sep 17 00:00:00 2001 From: Rich Harris Date: Wed, 31 Aug 2022 17:27:22 -0400 Subject: [PATCH 5/5] comments --- packages/kit/test/setup.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/kit/test/setup.js b/packages/kit/test/setup.js index 68ce5230a683..6bc6ca76fa8b 100644 --- a/packages/kit/test/setup.js +++ b/packages/kit/test/setup.js @@ -10,6 +10,7 @@ import { onMount } from 'svelte'; export function setup() { onMount(() => { + // give tests programmatic control over the app Object.assign(window, { goto, invalidate, @@ -19,6 +20,7 @@ export function setup() { afterNavigate }); + // communicate that the app is ready document.body.classList.add('started'); }); }