From d606998824e07b942273f640338da9abf063388d Mon Sep 17 00:00:00 2001 From: mrkldshv Date: Thu, 28 Jul 2022 17:00:37 +0000 Subject: [PATCH 1/3] feat: reference kit types in ambient file --- .changeset/tricky-moose-sip.md | 7 +++++++ packages/create-svelte/templates/default/src/app.d.ts | 2 -- packages/create-svelte/templates/skeleton/src/app.d.ts | 2 -- packages/kit/src/core/sync/write_env.js | 2 ++ 4 files changed, 9 insertions(+), 4 deletions(-) create mode 100644 .changeset/tricky-moose-sip.md diff --git a/.changeset/tricky-moose-sip.md b/.changeset/tricky-moose-sip.md new file mode 100644 index 000000000000..5502ee3ddd78 --- /dev/null +++ b/.changeset/tricky-moose-sip.md @@ -0,0 +1,7 @@ +--- +'default-template': patch +'create-svelte': patch +'@sveltejs/kit': patch +--- + +[feat] include reference to `@sveltejs/kit` types in ambient file diff --git a/packages/create-svelte/templates/default/src/app.d.ts b/packages/create-svelte/templates/default/src/app.d.ts index c9d56c4cab5c..76372f545e22 100644 --- a/packages/create-svelte/templates/default/src/app.d.ts +++ b/packages/create-svelte/templates/default/src/app.d.ts @@ -1,5 +1,3 @@ -/// - // See https://kit.svelte.dev/docs/types#app // for information about these interfaces // and what to do when importing types diff --git a/packages/create-svelte/templates/skeleton/src/app.d.ts b/packages/create-svelte/templates/skeleton/src/app.d.ts index ff717de9551f..f69cbcbf5910 100644 --- a/packages/create-svelte/templates/skeleton/src/app.d.ts +++ b/packages/create-svelte/templates/skeleton/src/app.d.ts @@ -1,5 +1,3 @@ -/// - // See https://kit.svelte.dev/docs/types#app // for information about these interfaces // and what to do when importing types diff --git a/packages/kit/src/core/sync/write_env.js b/packages/kit/src/core/sync/write_env.js index 04acbb27e587..1dfc37d87ae5 100644 --- a/packages/kit/src/core/sync/write_env.js +++ b/packages/kit/src/core/sync/write_env.js @@ -4,6 +4,7 @@ import { get_env } from '../../vite/utils.js'; import { write_if_changed, reserved, valid_identifier } from './utils.js'; const autogen_comment = '// this file is generated — do not edit it\n'; +const types_reference = '/// \n\n'; /** * Writes the existing environment variables in process.env to @@ -29,6 +30,7 @@ export function write_env(config, mode) { write_if_changed( path.join(config.outDir, 'ambient.d.ts'), autogen_comment + + types_reference + create_types('$env/static/public', env.public) + '\n\n' + create_types('$env/static/private', env.private) From 84a97b5ca81d0e4dc22d6412a63739611eaddc22 Mon Sep 17 00:00:00 2001 From: mrkldshv Date: Fri, 29 Jul 2022 11:34:02 +0000 Subject: [PATCH 2/3] chore: rename module and functions to write_ambient --- packages/kit/src/core/sync/sync.js | 4 ++-- .../sync/{write_env.js => write_ambient.js} | 17 +++++++++-------- 2 files changed, 11 insertions(+), 10 deletions(-) rename packages/kit/src/core/sync/{write_env.js => write_ambient.js} (80%) diff --git a/packages/kit/src/core/sync/sync.js b/packages/kit/src/core/sync/sync.js index 5493d477ceb1..a7517f5f5a86 100644 --- a/packages/kit/src/core/sync/sync.js +++ b/packages/kit/src/core/sync/sync.js @@ -6,7 +6,7 @@ import { write_matchers } from './write_matchers.js'; import { write_root } from './write_root.js'; import { write_tsconfig } from './write_tsconfig.js'; import { write_types } from './write_types.js'; -import { write_env } from './write_env.js'; +import { write_ambient } from './write_ambient.js'; /** * Initialize SvelteKit's generated files. @@ -17,7 +17,7 @@ export function init(config, mode) { copy_assets(path.join(config.kit.outDir, 'runtime')); write_tsconfig(config.kit); - write_env(config.kit, mode); + write_ambient(config.kit, mode); } /** diff --git a/packages/kit/src/core/sync/write_env.js b/packages/kit/src/core/sync/write_ambient.js similarity index 80% rename from packages/kit/src/core/sync/write_env.js rename to packages/kit/src/core/sync/write_ambient.js index 1dfc37d87ae5..800e1ccce708 100644 --- a/packages/kit/src/core/sync/write_env.js +++ b/packages/kit/src/core/sync/write_ambient.js @@ -7,33 +7,34 @@ const autogen_comment = '// this file is generated — do not edit it\n'; const types_reference = '/// \n\n'; /** - * Writes the existing environment variables in process.env to + * Writes ambient declarations including types reference to @sveltejs/kit, + * and the existing environment variables in process.env to * $env/static/private and $env/static/public * @param {import('types').ValidatedKitConfig} config * @param {string} mode The Vite mode */ -export function write_env(config, mode) { +export function write_ambient(config, mode) { const env = get_env(mode, config.env.publicPrefix); // TODO when testing src, `$app` points at `src/runtime/app`... will // probably need to fiddle with aliases write_if_changed( path.join(config.outDir, 'runtime/env/static/public.js'), - create_module('$env/static/public', env.public) + create_env_module('$env/static/public', env.public) ); write_if_changed( path.join(config.outDir, 'runtime/env/static/private.js'), - create_module('$env/static/private', env.private) + create_env_module('$env/static/private', env.private) ); write_if_changed( path.join(config.outDir, 'ambient.d.ts'), autogen_comment + types_reference + - create_types('$env/static/public', env.public) + + create_env_types('$env/static/public', env.public) + '\n\n' + - create_types('$env/static/private', env.private) + create_env_types('$env/static/private', env.private) ); } @@ -42,7 +43,7 @@ export function write_env(config, mode) { * @param {Record} env * @returns {string} */ -function create_module(id, env) { +function create_env_module(id, env) { /** @type {string[]} */ const declarations = []; @@ -76,7 +77,7 @@ function create_module(id, env) { * @param {Record} env * @returns {string} */ -function create_types(id, env) { +function create_env_types(id, env) { const declarations = Object.keys(env) .filter((k) => valid_identifier.test(k)) .map((k) => `\texport const ${k}: string;`) From 62c8cd16429c8c386c5eea0e605b7dad155966e7 Mon Sep 17 00:00:00 2001 From: Simon H <5968653+dummdidumm@users.noreply.github.com> Date: Fri, 29 Jul 2022 15:43:54 +0200 Subject: [PATCH 3/3] Update .changeset/tricky-moose-sip.md --- .changeset/tricky-moose-sip.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.changeset/tricky-moose-sip.md b/.changeset/tricky-moose-sip.md index 5502ee3ddd78..a744a6675806 100644 --- a/.changeset/tricky-moose-sip.md +++ b/.changeset/tricky-moose-sip.md @@ -1,5 +1,4 @@ --- -'default-template': patch 'create-svelte': patch '@sveltejs/kit': patch ---