move @sveltejs/kit/node types out of ambient.d.ts

[Rich-Harris]

This PR will, if it succeeds, fix one of my long-standing bugbears with the SvelteKit codebase (albeit one that it shares with just about every other package): if you click 'go to definition' on something imported from Kit, VSCode will take you do the type definitions instead of the actual code.

In other words, if you click 'go to definition' on this function...

import { getRequest } from '@sveltejs/kit/node';

// later...
getRequest(...);

...then today it will take you here:

Tomorrow, it will take you here:

From a debugging and understanding perspective, this is vastly preferable.

It will also fix the fact that we always have to make changes in multiple places whenever we update stuff — you need to change the interface/documentation in ambient.d.ts and also update the code that uses the interface. This is stupid. The documentation and the interfaces should be defined in the code itself.

One issue I'm currently facing is that auto-import no longer works. I'm not sure why, but I'm going to blindly proceed on the assumption that it's fixable somehow.

---

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

• It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
• This message body should clearly illustrate what problems it solves.
• Ideally, include a test that fails without this PR but passes with it.

Tests

• Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

• If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

[changeset-bot]

⚠️ No Changeset found

Latest commit: f6f1b54

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[Rich-Harris]

Oh, and the process for generating the docs will need to be updated

[Rich-Harris]

Alright, it turns out that this won't work in its current form — this almost works as a linked package (it just fails to auto-import) where the symlinks resolve to a directory outside a node_modules, but as soon as it's installed inside node_modules TypeScript sticks its fingers in its ears and pretends it can't hear you.

I'm convinced there must be a solution to this, because it would be too daft for there not to be a solution. Either way, if we're forced to generate .d.ts files from source code on prepublishOnly, that seems preferable to the status quo, if less so than a 'go to definition' that takes you to the source.

[balazsorban44]

https://www.typescriptlang.org/tsconfig#declarationMap

hopefully this can point back to the original JS file too.

[Rich-Harris]

closing this for now, until we get a chance to build a tool for generating .d.ts bundles correctly