-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Vue: Properly resolve Vite plugin #29795
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
5 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 517dba5. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@@ -1,6 +1,6 @@ | |||
import type { Plugin } from 'vite'; | |||
|
|||
export async function templateCompilation() { | |||
export async function templateCompilation(): Promise<Plugin> { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually don't see a reason for this to be a promise in the first place cc @yannbf ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is no reason. The others were needed because they do dynamic imports, but this one seems simple enough
Package BenchmarksCommit: The following packages have significant changes to their size or dependencies:
|
Before | After | Difference | |
---|---|---|---|
Dependency count | 61 | 61 | 0 |
Self size | 916 KB | 695 KB | 🎉 -221 KB 🎉 |
Dependency size | 13.86 MB | 13.86 MB | 0 B |
Bundle Size Analyzer | Link | Link |
Vue: Properly resolve Vite plugin (cherry picked from commit f25b824)
Thanks for the quick merge! |
What I did
Currently, the vue preset adds
storybook:vue-template-compilation
as unresolvedPromise<Plugin>
. This leads to memory issues downstream as analyzed in nuxt-modules/storybook#740 (comment). This is fixed by awating the promise. Also changed the types of the plugin array to the strongerPlugin
type, which doesn't admit promises to prevent this from reaccouring the future.Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>
Greptile Summary
Fixes memory issues in Vue's Vite plugin system by properly resolving plugin promises and enforcing stricter typing for plugin arrays.
storybookVuePlugin
incode/frameworks/vue3-vite/src/vite-plugin.ts
to properly await plugin promisesPluginOption[]
to stricterPlugin[]
type incode/frameworks/vue3-vite/src/preset.ts
templateCompilation
function incode/frameworks/vue3-vite/src/plugins/vue-template.ts
💡 (4/5) You can add custom instructions or style guidelines for the bot here!