feat(cli): advertise VP_USER_AGENT to child processes#1958
Conversation
Set `VP_USER_AGENT=vp/<version>` once at startup so spawned tools can detect vp as the package manager. Underlying package managers overwrite `npm_config_user_agent`, so a dedicated variable is needed. Enables `vp dlx create-vite` to scaffold with vp commands.
✅ Deploy Preview for viteplus-preview canceled.
|
✅ Deploy Preview for viteplus-preview canceled.
|
|
@codex review |
![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: 2d9a056834
ℹ️ 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".
When vp runs as a managed npm/npx/node shim, the user is invoking that tool, not vp, so clear VP_USER_AGENT before dispatching the shim. Otherwise a child like create-vite would wrongly scaffold vp commands.
Detect shim mode in `main` before the runtime starts and set VP_USER_AGENT only when not a shim, instead of setting it unconditionally and clearing it in the shim branch. Also makes `detect_shim_tool` run genuinely single-threaded (it clears VP_SHIM_TOOL), matching its own SAFETY note.
| if shim_tool.is_none() { | ||
| unsafe { | ||
| std::env::set_var( | ||
| vite_shared::env_vars::VP_USER_AGENT, |
There was a problem hiding this comment.
It seems not completely the same as #2029, VP_HOME in #2029 is set in shellrc (env script), means it can be always accessible if you installed Vite+. And this is only set for Vite+'s child processes.
For the purpose let child processes know whether it is spawned by Vite+, I think it is still worth doing.
2 participants
Problem
When
vpruns a tool (e.g.vp dlx create-vite), the child can't tell it was launched by vp. The underlying package manager (pnpm/npm/yarn/bun) overwritesnpm_config_user_agentwith its own value, so that channel can't carry the vp signal.Fix
Set a dedicated
VP_USER_AGENT=vp/<version>env var once at startup, inherited by every child process. Tools like create-vite can read it to detect vp and scaffold withvp install/vp dev/vp dlx.VP_USER_AGENTconstant to the centralenv_varsregistry.main, before the async runtime starts (edition 2024set_varmust run single-threaded), mirroring thevite_installerpattern. This covers all dlx paths including thenpxfallback used when there is no localpackage.json.Companion
create-vite reads
VP_USER_AGENT: vitejs/vite#22788