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

fix(metadata): expose viteMetadata type #11511

Merged
merged 1 commit into from
Jan 4, 2023
Merged

Conversation

bluwy
Copy link
Member

@bluwy bluwy commented Dec 28, 2022

Description

fix #11324

I believe viteMetadata is public API (we also export the ChunkMetadata types), but when a user creates a Vite plugin with renderChunk(), the chunk autocomplete doesn't show viteMetadata as a possible property.

This is because the declare module augmented types isn't bundled by api-extractor. This PR re-shuffles the types so that the augmented types are in types/metadata.d.ts, and node/index.d.ts would re-export the ChunkMetadata types from it. Indirectly doing so, the augmented types are detected by TypeScript too.

Additional context


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the PR Title Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@bluwy bluwy added the p2-nice-to-have Not breaking anything but nice to have (priority) label Dec 28, 2022
@patak-dev patak-dev added this to the 4.1 milestone Jan 3, 2023
@patak-dev patak-dev merged commit 32dee3c into main Jan 4, 2023
@patak-dev patak-dev deleted the fix-viteMetadata-types branch January 4, 2023 16:08
futurGH pushed a commit to futurGH/vite that referenced this pull request Feb 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2-nice-to-have Not breaking anything but nice to have (priority)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Expose the RenderedChunk typing for plugin authors to more easily consume
3 participants