feat(cli): refuse vp dev/build in Nuxt and Astro projects - #2456
Draft
fengmk2 wants to merge 7 commits into
Draft
Conversation
vp dev and vp build run the bundled Vite CLI, which cannot serve or build a Nuxt or Astro project: dev answers every URL with 404 and build fails on the missing index.html entry. Detect nuxt.config.* or astro.config.* next to the nearest package.json and stop with an error that points at vp run <command>. An explicit --config/-c flag skips the refusal. Refs #1506
✅ Deploy Preview for viteplus-preview canceled.
|
Contributor
|
✅ Staging deployment successful! Preview: https://viteplus-staging.void.app/ |
fengmk2
added
the
preview-build
Contributor
Native binary sizes (
|
| Artifact | Format | Base | PR | Change |
|---|---|---|---|---|
vp (Linux x64) |
Binary | 10.67 MiB | 10.67 MiB | 0 B (0.00%) |
vp (Linux x64) |
gzip -9 | 4.62 MiB | 4.62 MiB | 0 B (0.00%) |
| NAPI (Linux x64) | Binary | 32.02 MiB | 32.03 MiB | +12.00 KiB (+0.04%) |
| NAPI (Linux x64) | gzip -9 | 12.61 MiB | 12.61 MiB | +1.67 KiB (+0.01%) |
vp (macOS ARM64) |
Binary | 7.98 MiB | 7.98 MiB | 0 B (0.00%) |
vp (macOS ARM64) |
gzip -9 | 4.03 MiB | 4.03 MiB | 0 B (0.00%) |
| NAPI (macOS ARM64) | Binary | 39.68 MiB | 39.68 MiB | +16 B (+0.00%) |
| NAPI (macOS ARM64) | gzip -9 | 16.92 MiB | 16.92 MiB | +3.97 KiB (+0.02%) |
vp (Windows x64) |
Binary | 8.55 MiB | 8.55 MiB | 0 B (0.00%) |
vp (Windows x64) |
gzip -9 | 3.73 MiB | 3.73 MiB | +1 B (+0.00%) |
| NAPI (Windows x64) | Binary | 26.89 MiB | 26.90 MiB | +8.50 KiB (+0.03%) |
| NAPI (Windows x64) | gzip -9 | 10.68 MiB | 10.68 MiB | +1.35 KiB (+0.01%) |
| Trampoline (Windows x64) | Binary | 205.00 KiB | 205.00 KiB | 0 B (0.00%) |
| Trampoline (Windows x64) | gzip -9 | 99.00 KiB | 99.00 KiB | -1 B (-0.00%) |
| Installer (Windows x64) | Binary | 4.47 MiB | 4.47 MiB | 0 B (0.00%) |
| Installer (Windows x64) | gzip -9 | 2.09 MiB | 2.09 MiB | 0 B (0.00%) |
Astro only searches astro.config.{mjs,js,ts,mts} (configPaths in
withastro/astro), so drop the .cjs/.cts names it never loads. Nuxt
resolves nuxt.config through c12, which accepts all six script
extensions. Cite the pinned upstream sources in the framework table.
Also reword the refusal to 'this project uses <name>' and drop the
article field it needed.
Split the refusal error into two sentences and rewrite the guard comments, docs, and fixture comments in short active sentences. Re-record the fixture snapshots for the new wording.
Without a script named after the command, the old hint pointed at a vp run task that does not exist. The hint now picks the first path that works: the same-name script, a script that runs the framework command under another name (matched on whitespace boundaries against the nuxt/nuxi/astro bins), or the framework CLI through vp exec. Add snapshot coverage for the no-scripts and renamed-script cases.
Member
Author
|
@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: 8abcf9a6b5
ℹ️ 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".
A package script can run vp dev or vp build itself. The guard now checks direct invocations only, with the same task and npm_lifecycle_event gate the script note uses (extracted as spawned_from_script). Add task-spawned and npm-spawned snapshot cases that build through a nested vp build without a refusal.
|
From a user's perspective, would it not be more convenient if As far as I understand the discussion in #1506, proper support for nuxt/astro is desired just not very high on the prio queue. So for training the correct muscle memory, supporting |
Member
Author
|
@tobiasdiez That's a different issue. Currently, built-in commands are still not allowed to be overridden. |
Run the refusal after resolve_app_target, so defaultPackage keeps acting as an implicit -C and the hint comes from the target package. The script note asks the guard first (print-free applies) and stays silent right before a refusal. Let help and version requests reach the tool: vp dev --help prints the Vite help again. Tokens after the -- terminator stay positionals, for the config bypass too. Qualify the docs: the hint points at the matching script, or at vp exec when no script matches.
Member
Author
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: dad5d88aec
ℹ️ 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".
Classify the args with the app-target walk: a positional is the Vite root and becomes the guarded directory, and explicit invocations (help/version, --config) reach the tool. This replaces the hand-rolled flag scans. Validate the same-named script's command before recommending it: an unrelated "dev": "storybook dev" no longer becomes the hint. Carry the resolved target into the hints as -C <target> after a defaultPackage or picker retarget, and for positional roots. Refuse at a framework workspace root instead of falling into package elicitation. An explicit defaultPackage still wins.
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.
Refs #1506. First step from #1506 (comment): detect a Nuxt or Astro config, refuse
vp dev/vp build, and point atvp run dev.Both commands run the bundled Vite CLI, which cannot serve or build a Nuxt or Astro project: dev answers every URL with 404, and build fails on the missing
index.htmlentry (repros: nuxt, astro). Now:The guard sits in the NAPI binding dispatch, so the local and global CLI behave the same. It checks the config files each framework loader resolves:
nuxt.config.{js,ts,mjs,cjs,mts,cts}andastro.config.{mjs,js,ts,mts}, with the upstream sources cited in code comments. Without adev/buildscript, the hint points at a script that runs the framework command under another name, or atvp exec nuxt dev. The guard checks direct invocations only: a command spawned from a task or package script, such as a"dev": "vp dev"script, runs as invoked. An explicit--config/-cflag skips the refusal. A positional directory target (vp dev apps/web) is not inspected.Covered by unit tests, the
builtin_framework_guardPTY snapshot fixture (local and global flavors), and docs updates inguide/run.mdandguide/troubleshooting.md.