Skip to content

chore: bump dts-buddy #12134

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

Merged
merged 4 commits into from
Jun 24, 2024
Merged

chore: bump dts-buddy #12134

merged 4 commits into from
Jun 24, 2024

Conversation

Rich-Harris
Copy link
Member

A recent (and slightly embarrassing) revelation — we are currently exposing our private junk in addition to all our public interfaces. It turns out that these are not the same:

declare module 'x' {
  type a = {...};
  export type b = {...};
}
declare module 'x' {
  type a = {...};
  type b = {...};

  export { b };
}

In the first case, for reasons I cannot begin to fathom, TypeScript exposes everything, not just the things that were explicitly marked with the export keyword. In the second case, sanity prevails.

dts-buddy, which generates our bundle of types, was recently fixed to always use the second form. This is technically a breaking change insofar as someone might have depended on a 'private' (and undocumented) type.

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
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests and linting

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

Copy link

changeset-bot bot commented Jun 22, 2024

🦋 Changeset detected

Latest commit: 79d3bf8

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

This PR includes changesets to release 1 package
Name Type
svelte 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

@dummdidumm
Copy link
Member

Thanks to Mateusz I also found out why the behavior is that way. TLDR: Historical reasons; it was an accident it was ever allowed but to not break the world export type ..; type ..; still works "wrong" today while export { .. } "fixes" it. microsoft/TypeScript#58912 (review)

@dummdidumm dummdidumm merged commit 88b0b40 into main Jun 24, 2024
8 of 9 checks passed
@dummdidumm dummdidumm deleted the bump-dts-buddy branch June 24, 2024 10:39
FoHoOV pushed a commit to FoHoOV/svelte that referenced this pull request Jun 27, 2024
new dts-buddy makes sure that only the actual public types are exposed (only export { ... } ensures that, for TS historical reasons)

---------

Co-authored-by: Simon Holthausen <simon.holthausen@vercel.com>
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.

2 participants