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

chore(templates): alias react to preact/compat in tsconfig #14262

Merged
merged 1 commit into from
Sep 11, 2023

Conversation

rschristian
Copy link
Contributor

Description

Adds TS aliases for react and react-dom, which we (the Preact team) recommend users who wish to make use of preact/compat do (@preactjs/preset-vite has the react, react-dom -> preact/compat aliases enabled by default).

Additional context

I've seen a handful of users confused about type errors, assuming the preset would handle aliasing fully, including the TS portion. Obviously this isn't the case, but I'd like to provide a nicer experience out-of-the-box for these users.

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.

@stackblitz
Copy link

stackblitz bot commented Sep 2, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@rschristian rschristian changed the title chore(templates): Alias react to preact/compat in tsconfig chore(templates): alias react to preact/compat in tsconfig Sep 2, 2023
@bluwy bluwy merged commit c796959 into vitejs:main Sep 11, 2023
10 of 11 checks passed
@rschristian rschristian deleted the chore/preact-compat-ts-aliases branch September 11, 2023 06:34
Gaubee pushed a commit to Gaubee/vite that referenced this pull request Sep 13, 2023
bluwy added a commit to bluwy/create-vite-extra that referenced this pull request Nov 15, 2023
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