Skip to content
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.

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

Update adapter entrypoint typings to be NodeNext/ESNext-compatible. #5111

Merged
merged 3 commits into from
May 30, 2022
Merged

Update adapter entrypoint typings to be NodeNext/ESNext-compatible. #5111

merged 3 commits into from
May 30, 2022

Conversation

adam-coster
Copy link
Contributor

As discussed in #5110, the entry index.d.ts files of the adapters all use a node-resolution-compatible export syntax like this:

 declare function plugin(): Adapter; 
 export = plugin; 

However, all of these packages use ESM (instead of CommonJS) so they can instead use:

export default function plugin(): Adapter;

Making this change resolves a Typescript 4.7+ error where import adapter from '@sveltejs/adapter-auto'; throws a compiler error when the tsconfig.json is configured with moduleResolution set to NodeNext or ESNext.

To make this change, all of the index.js files that import these types have to have their JSDoc import statements changed to explicitly grab the default export. E.g. /** @type {import('.')} **/ ➡️ /** @type {import('.').default} **/.

Since these packages are already modules these typings are more technically correct, though it's possible that this change will result in new Typescript errors for some compiler configurations. With Typescript 4.8 (dev), I can confirm that this change results in no errors with either of the following tsconfig configurations:

// Node resolution and ES2020 targets
"compilerOptions":{
    "target": "ES2020",
    "lib": ["ES2020"],
    "module": "ES2020",
    "moduleResolution": "Node",
}
// NodeNext resolution and ESNext targtes
"compilerOptions":{
    "target": "ESNext",
    "lib": ["ESNext"],
    "module": "ESNext",
    "moduleResolution": "NodeNext",
}

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

  • [x ] 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

⚠️ My test environment didn't have Chrome, so those tests did not pass.

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. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented May 29, 2022

🦋 Changeset detected

Latest commit: 9a0b1ac

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 7 packages
Name Type
@sveltejs/adapter-auto Patch
@sveltejs/adapter-cloudflare-workers Patch
@sveltejs/adapter-cloudflare Patch
@sveltejs/adapter-netlify Patch
@sveltejs/adapter-node Patch
@sveltejs/adapter-static Patch
@sveltejs/adapter-vercel Patch

Not sure what this means? Click here to learn what changesets are.

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

@Rich-Harris Rich-Harris merged commit 7d5fb30 into sveltejs:master May 30, 2022
@Rich-Harris
Copy link
Member

thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants