chore: upgrade vite-plus to 0.1.20-alpha.4#2
Draft
fengmk2 wants to merge 1 commit into
Draft
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request simplifies the AGENTS.md file by removing detailed command workflows and common pitfalls in favor of links to external documentation. Additionally, it pins the versions of vite, vitest, and vite-plus to a specific alpha release in pnpm-workspace.yaml. Feedback indicates that the removal of explicit rules in AGENTS.md—such as the requirement to import from vite-plus and the prohibition of direct package manager usage—may negatively impact the ability of AI agents to correctly interact with the project's unique toolchain.
Comment on lines
+7
to
+13
| Docs are local at `node_modules/vite-plus/docs` or online at https://viteplus.dev/guide/. | ||
|
|
||
| `vp` is a global binary that handles the full development lifecycle. Run `vp help` to print a list of commands and `vp <command> --help` for information about a specific command. | ||
|
|
||
| ### Start | ||
|
|
||
| - create - Create a new project from a template | ||
| - migrate - Migrate an existing project to Vite+ | ||
| - config - Configure hooks and agent integration | ||
| - staged - Run linters on staged files | ||
| - install (`i`) - Install dependencies | ||
| - env - Manage Node.js versions | ||
|
|
||
| ### Develop | ||
|
|
||
| - dev - Run the development server | ||
| - check - Run format, lint, and TypeScript type checks | ||
| - lint - Lint code | ||
| - fmt - Format code | ||
| - test - Run tests | ||
|
|
||
| ### Execute | ||
|
|
||
| - run - Run monorepo tasks | ||
| - exec - Execute a command from local `node_modules/.bin` | ||
| - dlx - Execute a package binary without installing it as a dependency | ||
| - cache - Manage the task cache | ||
|
|
||
| ### Build | ||
|
|
||
| - build - Build for production | ||
| - pack - Build libraries | ||
| - preview - Preview production build | ||
|
|
||
| ### Manage Dependencies | ||
|
|
||
| Vite+ automatically detects and wraps the underlying package manager such as pnpm, npm, or Yarn through the `packageManager` field in `package.json` or package manager-specific lockfiles. | ||
|
|
||
| - add - Add packages to dependencies | ||
| - remove (`rm`, `un`, `uninstall`) - Remove packages from dependencies | ||
| - update (`up`) - Update packages to latest versions | ||
| - dedupe - Deduplicate dependencies | ||
| - outdated - Check for outdated packages | ||
| - list (`ls`) - List installed packages | ||
| - why (`explain`) - Show why a package is installed | ||
| - info (`view`, `show`) - View package information from the registry | ||
| - link (`ln`) / unlink - Manage local package links | ||
| - pm - Forward a command to the package manager | ||
|
|
||
| ### Maintain | ||
|
|
||
| - upgrade - Update `vp` itself to the latest version | ||
|
|
||
| These commands map to their corresponding tools. For example, `vp dev --port 3000` runs Vite's dev server and works the same as Vite. `vp test` runs JavaScript tests through the bundled Vitest. The version of all tools can be checked using `vp --version`. This is useful when researching documentation, features, and bugs. | ||
|
|
||
| ## Common Pitfalls | ||
|
|
||
| - **Using the package manager directly:** Do not use pnpm, npm, or Yarn directly. Vite+ can handle all package manager operations. | ||
| - **Always use Vite commands to run tools:** Don't attempt to run `vp vitest` or `vp oxlint`. They do not exist. Use `vp test` and `vp lint` instead. | ||
| - **Running scripts:** Vite+ commands take precedence over `package.json` scripts. If there is a `test` script defined in `scripts` that conflicts with the built-in `vp test` command, run it using `vp run test`. | ||
| - **Do not install Vitest, Oxlint, Oxfmt, or tsdown directly:** Vite+ wraps these tools. They must not be installed directly. You cannot upgrade these tools by installing their latest versions. Always use Vite+ commands. | ||
| - **Use Vite+ wrappers for one-off binaries:** Use `vp dlx` instead of package-manager-specific `dlx`/`npx` commands. | ||
| - **Import JavaScript modules from `vite-plus`:** Instead of importing from `vite` or `vitest`, all modules should be imported from the project's `vite-plus` dependency. For example, `import { defineConfig } from 'vite-plus';` or `import { expect, test, vi } from 'vite-plus/test';`. You must not install `vitest` to import test utilities. | ||
| - **Type-Aware Linting:** There is no need to install `oxlint-tsgolint`, `vp lint --type-aware` works out of the box. | ||
|
|
||
| ## Review Checklist for Agents | ||
| ## Review Checklist | ||
|
|
||
| - [ ] Run `vp install` after pulling remote changes and before getting started. | ||
| - [ ] Run `vp check` and `vp test` to validate changes. | ||
| - [ ] Run `vp check` and `vp test` to format, lint, type check and test changes. | ||
| - [ ] Check if there are `vite.config.ts` tasks or `package.json` scripts necessary for validation, run via `vp run <script>`. |
There was a problem hiding this comment.
The removal of the detailed command workflow and the Common Pitfalls section significantly reduces the context available to AI agents. For a file specifically named AGENTS.md, providing explicit rules is crucial to prevent agents from suggesting standard ecosystem patterns that are incompatible with the Vite+ toolchain.
Specifically, the following critical rules are lost in this version:
- Imports: The requirement to import from
vite-plusinstead ofviteorvitest(e.g.,import { defineConfig } from 'vite-plus'). - Package Management: The instruction to use
vpinstead ofpnpm/npmdirectly for all operations. - Bundled Tools: The warning against installing
vitest,oxlint, ortsdowndirectly as they are managed byvite-plus.
Consider retaining a condensed version of these rules to ensure agents remain effective without needing to parse external documentation.
commit: |
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
1 participant
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.
Upgrade vite-plus and related packages to 0.1.20-alpha.4 alpha version.