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: add @types/node as an optional peer dependency #10757

Merged
merged 1 commit into from Nov 4, 2022

Conversation

sodatea
Copy link
Member

@sodatea sodatea commented Nov 2, 2022

Description

The built bundle of Vite starts with a reference to node types: https://unpkg.com/browse/vite@3.2.2/dist/node/index.d.ts

This means those who depend on Vite type definitions should install @types/node in their projects to do type-checking successfully. In that sense, @types/node is an optional peer dependency of Vite.

After this is fixed, we should revert vitejs/vite-ecosystem-ci#85 because not explicitly depending on @types/node should be erroneous. The ecosystem CI shouldn't cover that error for downstream packages.

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 Commit 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.

The built bundle of Vite starts with a reference to `node` types:
https://unpkg.com/browse/vite@3.2.2/dist/node/index.d.ts

This means those who depend on Vite type definitions should install
`@types/node` in their projects to successfully do type-checking.
In that sense, `@types/node` is an optional peer dependency of Vite.

After this being fixed, we should revert vitejs/vite-ecosystem-ci#85 because not explicitly depending on
`@types/node` *should* be erroneous. The ecosystem CI shouldn't cover
that error for downstream packages.
@patak-dev patak-dev merged commit 57916a4 into vitejs:main Nov 4, 2022
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.

None yet

4 participants