docs: clarify lazy plugin side effects#1841
Open
leno23 wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for viteplus-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8104d7e2cc
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
fengmk2
reviewed
Jun 15, 2026
|
|
||
| ```ts [vite.config.ts] | ||
| import { defineConfig } from 'vite-plus'; | ||
| import { defineConfig } from "vite-plus"; |
Member
There was a problem hiding this comment.
Can the format replacement of single quotes be reverted? These should not need changes.
fengmk2
reviewed
Jun 15, 2026
Comment on lines
70
to
74
| When `vite.config.ts` imports heavy plugins at the top level, every `import` is evaluated eagerly, even for commands like `vp lint` or `vp fmt` that don't need those plugins. This can make config loading noticeably slow. | ||
|
|
||
| Eager plugins can also run unexpected side effects in long-lived tooling processes, such as editor integrations, format or lint language servers, and background workers. If a plugin touches the file system, starts a watcher, reads environment-specific files, or talks to a service during setup, prefer loading it through `lazyPlugins` so those side effects only happen for commands that actually execute the Vite pipeline. | ||
|
|
||
| Use `lazyPlugins` to wrap plugin loading. Plugins are only loaded for commands that need them (`dev`, `build`, `test`, `preview`), and skipped for everything else: |
Member
There was a problem hiding this comment.
The added guidance is useful, but the new paragraph feels a bit dense. I’d suggest merging the background-process and side-effect examples into a shorter version:
Suggested change
| When `vite.config.ts` imports heavy plugins at the top level, every `import` is evaluated eagerly, even for commands like `vp lint` or `vp fmt` that don't need those plugins. This can make config loading noticeably slow. | |
| Eager plugins can also run unexpected side effects in long-lived tooling processes, such as editor integrations, format or lint language servers, and background workers. If a plugin touches the file system, starts a watcher, reads environment-specific files, or talks to a service during setup, prefer loading it through `lazyPlugins` so those side effects only happen for commands that actually execute the Vite pipeline. | |
| Use `lazyPlugins` to wrap plugin loading. Plugins are only loaded for commands that need them (`dev`, `build`, `test`, `preview`), and skipped for everything else: | |
| When `vite.config.ts` imports plugins at the top level, they are evaluated for every command, including `vp lint`, `vp fmt`, editor integrations, and long-lived background processes. This can make config loading slow and may trigger plugin setup side effects, such as reading files, starting watchers, or connecting to services. | |
| Use `lazyPlugins` to load plugins only when the Vite pipeline actually runs (`dev`, `build`, `test`, `preview`): |
This keeps the same intent while making the guidance easier to scan.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
lazyPluginsfor plugins with setup-time side effectsAddresses #1580 by covering the LSP/background-process case in the troubleshooting guidance.
Verification
pnpm exec oxfmt --check docs/guide/troubleshooting.mdnode -e "const fs=require('fs'); const text=fs.readFileSync('docs/guide/troubleshooting.md','utf8'); for (const s of ['long-lived tooling processes','editor integrations','format or lint language servers','lazyPlugins']) if (!text.includes(s)) throw new Error('missing '+s); console.log('lazy plugin docs ok')"