Skip to content

breaking: stop generating ambient.d.ts #16460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Nic-Polumeyv wants to merge 1 commit into from
Closed

breaking: stop generating ambient.d.ts #16460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/remove-generated-ambient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sveltejs/kit': major
---

breaking: stop generating `ambient.d.ts`, the `@sveltejs/kit` types reference moved into `env.d.ts`
2 changes: 1 addition & 1 deletion documentation/docs/98-reference/54-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ The generated `.svelte-kit/tsconfig.json` file contains a mixture of options. So
"rootDirs": ["..", "./types"]
},
"include": [
"ambient.d.ts",
"env.d.ts",
"non-ambient.d.ts",
"./types/**/$types.d.ts",
"../vite.config.js",
Expand Down
2 changes: 0 additions & 2 deletions packages/kit/src/core/sync/sync.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import create_manifest_data from './create_manifest_data/index.js';
import { write_client_manifest } from './write_client_manifest.js';
import { write_tsconfig } from './write_tsconfig.js';
import { write_types, write_all_types } from './write_types/index.js';
import { write_ambient } from './write_ambient.js';
import { write_non_ambient } from './write_non_ambient.js';
import { write_server } from './write_server.js';
import {
Expand All @@ -21,7 +20,6 @@ import { write_env } from './write_env.js';
*/
export function init(config, root) {
write_tsconfig(config.kit, root);
write_ambient(config.kit);
}

/**
Expand Down
18 changes: 0 additions & 18 deletions packages/kit/src/core/sync/write_ambient.js
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion packages/kit/src/core/sync/write_env.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const DOCS = '// See https://svelte.dev/docs/kit/environment-variables for more
* @param {Record<string, EnvVarConfig<any>> | null} env_config
*/
export function write_env(kit, entry, env_config) {
const content = [];
const content = ['/// <reference types="@sveltejs/kit" />'];
const out = path.join(kit.outDir, 'env.d.ts');

if (entry && env_config) {
Expand Down
1 change: 0 additions & 1 deletion packages/kit/src/core/sync/write_tsconfig.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ export function get_tsconfig(kit, cwd) {
const config_relative = (file) => posixify(path.relative(kit.outDir, file));

const include = new Set([
'ambient.d.ts', // careful: changing this name would be a breaking change, because it's referenced in the service-workers documentation
'env.d.ts',
'non-ambient.d.ts',
'./types/**/$types.d.ts',
Expand Down
1 change: 0 additions & 1 deletion packages/kit/src/core/sync/write_tsconfig.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ test('Creates tsconfig include from kit.files', () => {
const { include } = get_tsconfig(kit, '.');

expect(include).toEqual([
'ambient.d.ts',
'env.d.ts',
'non-ambient.d.ts',
'./types/**/$types.d.ts',
Expand Down
Loading