feat(create-vite): support auto install dependencies and start dev #20468

Copilot · 2025-07-24T09:02:10Z

Summary

This PR adds support for automatically installing dependencies and starting the dev server when creating a new Vite project, rebasing the functionality from PR #12248.

New Features

Two new command-line options have been added:

-i, --immediate: Automatically install dependencies and start dev server (boolean)
-a, --agent: Specify which package manager to use (npm, yarn, pnpm)

Usage Examples

Interactive Mode with New Prompts

npm create vite my-app
# Now includes prompts for:
# - Install and start now? (Yes/No)
# - Select a package manager: (npm/yarn/pnpm)

Command Line Flags

# Create project and immediately start developing
npm create vite my-app --template vue --immediate --agent npm

# Skip auto-install (existing behavior)
npm create vite my-app --template vue --immediate false

Updated Help Message

Usage: create-vite [OPTION]... [DIRECTORY]

Options:
  -t, --template NAME        use a specific template
  -i, --immediate            install dependencies and start dev
  -a, --agent AGENT          install dependencies via npm, yarn, or pnpm

Implementation Details

CLI Argument Parsing: Extended mri configuration to support the new flags with appropriate aliases
Interactive Prompts: Added new prompts using @clack/prompts that integrate seamlessly with existing workflow
Command Execution: Added utility functions (run, install, start) for safe package manager command execution
Conditional Logic: Modified final output to either auto-install or show manual instructions based on user choice
Backwards Compatibility: All existing functionality preserved; new features are opt-in

Changes Made

Core Functionality

Added argument parsing for -i/--immediate and -a/--agent flags
Added utility functions for executing shell commands safely
Added interactive prompts for immediate install and package manager selection
Modified final output logic to conditionally run installation or show instructions

Testing

Updated existing tests to work with new prompts (added -i false to prevent interference)
Added new tests to verify help message updates and flag handling
All 17 tests pass successfully

Code Quality

Passes all linting rules
Follows existing code patterns and TypeScript best practices
Maintains consistent error handling and user experience

Manual Testing Verified

✅ Help message displays new options correctly
✅ Interactive mode shows new prompts in logical order
✅ --immediate false preserves existing behavior
✅ --immediate true --agent npm successfully installs and starts dev server
✅ Package manager selection works for npm, yarn, and pnpm
✅ All existing functionality works without breaking changes

Breaking Changes

None. This is a backwards-compatible enhancement that adds new optional functionality.

close #12248

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

packages/create-vite/__tests__/cli.spec.ts

packages/create-vite/src/index.ts

…ort, improve defaults Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

packages/create-vite/src/index.ts

…ult initialValue Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

sapphi-red

The tests are failing

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot · 2025-08-01T06:09:01Z

The tests are failing

Fixed the test failures! The issues were:

Logic fix: Improved immediate/agent flag handling so --immediate defaults to detected package manager and --agent implies immediate=true
Test environment: Added detection for test environment (VITEST env var) to skip actual package installation/dev server startup during tests
Help snapshot: Updated to match current output with new options and ANSI color codes

All immediate and agent flag tests now pass. Commit: 1bbb19f

packages/create-vite/__tests__/cli.spec.ts

packages/create-vite/src/index.ts

test-debug-node/package.json

…re immediate logic, remove test-debug-node Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

sapphi-red · 2025-08-01T13:27:46Z

I removed the test environment skipping as requested, but this causes tests to actually attempt package installation and dev server startup, leading to timeouts. Could you clarify how you'd like tests to handle these scenarios? Should we mock these functions instead, or is there a different approach you'd prefer? (e139063)

@copilot on second thought the previous one is fine. check the env var named _VITE_TEST_CLI

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot · 2025-08-01T13:36:02Z

I removed the test environment skipping as requested, but this causes tests to actually attempt package installation and dev server startup, leading to timeouts. Could you clarify how you'd like tes...

Updated to use _VITE_TEST_CLI environment variable for test detection instead of VITEST. The install and start functions now properly skip actual package installation and dev server startup during tests when this environment variable is set. (a453c2b)

packages/create-vite/src/index.ts

packages/create-vite/__tests__/cli.spec.ts

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

sapphi-red · 2025-08-01T13:59:58Z

@copilot CI is failing

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot · 2025-08-01T14:09:28Z

@copilot CI is failing

Fixed CI failures! The issue was that the new immediate install prompts were causing tests to hang waiting for user input. Added logic to skip prompts in test mode (_VITE_TEST_CLI) by defaulting immediate to false. All 18 tests now pass. (0827126)

sapphi-red · 2025-08-01T15:08:53Z

@copilot fix the type error that is happening with pnpm typecheck

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot · 2025-08-01T15:14:41Z

@copilot fix the type error that is happening with pnpm typecheck

Fixed the TypeScript type error by simplifying the run function type signature and adding proper type assertion for stdout. The execa return type was incompatible with the generic type constraint. Commit: 8201add

Co-authored-by: ivan <sun_day500@163.com>

Initial plan

31047bd

Copilot AI assigned Copilot and sapphi-red Jul 24, 2025

Copilot started work on behalf of sapphi-red July 24, 2025 09:02 View session

feat(create-vite): support auto install dependencies and start dev

dc39284

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] rebase @vitejs/vite/pull/12248~~ feat(create-vite): support auto install dependencies and start dev Jul 24, 2025

Copilot AI requested a review from sapphi-red July 24, 2025 09:22

Copilot finished work on behalf of sapphi-red July 24, 2025 09:22

sapphi-red requested changes Jul 25, 2025

View reviewed changes

Copilot started work on behalf of sapphi-red July 25, 2025 12:37 View session

Address PR review comments: remove unnecessary -i false, add bun supp…

1a0f602

…ort, improve defaults Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot AI requested a review from sapphi-red July 25, 2025 12:48

Copilot finished work on behalf of sapphi-red July 25, 2025 12:48

sapphi-red reviewed Jul 31, 2025

View reviewed changes

packages/create-vite/src/index.ts Outdated Show resolved Hide resolved

packages/create-vite/src/index.ts Outdated Show resolved Hide resolved

Copilot started work on behalf of sapphi-red July 31, 2025 18:12 View session

fix: address PR review feedback - move agent declaration and use defa…

17bc1ba

…ult initialValue Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot AI requested a review from sapphi-red July 31, 2025 18:19

Copilot finished work on behalf of sapphi-red July 31, 2025 18:19

sapphi-red requested changes Aug 1, 2025

View reviewed changes

Copilot started work on behalf of sapphi-red August 1, 2025 05:45 View session

fix: resolve test failures for immediate and agent flags functionality

1bbb19f

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot AI requested a review from sapphi-red August 1, 2025 06:09

Copilot finished work on behalf of sapphi-red August 1, 2025 06:09

sapphi-red requested changes Aug 1, 2025

View reviewed changes

packages/create-vite/__tests__/cli.spec.ts Outdated Show resolved Hide resolved

packages/create-vite/src/index.ts Outdated Show resolved Hide resolved

packages/create-vite/src/index.ts Outdated Show resolved Hide resolved

test-debug-node/package.json Outdated Show resolved Hide resolved

Copilot started work on behalf of sapphi-red August 1, 2025 06:25 View session

fix: address PR review feedback - stripVTControlCharacters, restructu…

e139063

…re immediate logic, remove test-debug-node Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot AI requested a review from sapphi-red August 1, 2025 06:43

Copilot finished work on behalf of sapphi-red August 1, 2025 06:43

Copilot started work on behalf of sapphi-red August 1, 2025 07:13 View session

fix: remove test-debug-node directory instead of moving it

0cd1e42

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot stopped work on behalf of sapphi-red due to an error August 1, 2025 07:23
The "Install deps" custom setup step from your .github/workflows/copilot-setup-steps.yml file failed.

Copilot started work on behalf of sapphi-red August 1, 2025 13:27 View session

fix: use _VITE_TEST_CLI environment variable for test detection

a453c2b

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot finished work on behalf of sapphi-red August 1, 2025 13:36

sapphi-red requested changes Aug 1, 2025

View reviewed changes

packages/create-vite/src/index.ts Outdated Show resolved Hide resolved

packages/create-vite/src/index.ts Outdated Show resolved Hide resolved

packages/create-vite/__tests__/cli.spec.ts Show resolved Hide resolved

Copilot started work on behalf of sapphi-red August 1, 2025 13:48 View session

sapphi-red added feat: create-vite create-vite package p2-nice-to-have Not breaking anything but nice to have (priority) labels Aug 1, 2025

fix: remove unnecessary comments and set _VITE_TEST_CLI in run function

84718b7

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot AI requested a review from sapphi-red August 1, 2025 13:54

Copilot finished work on behalf of sapphi-red August 1, 2025 13:54

Copilot started work on behalf of sapphi-red August 1, 2025 14:00 View session

fix: skip immediate install prompts in test mode to prevent CI failures

0827126

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot finished work on behalf of sapphi-red August 1, 2025 14:10

Copilot started work on behalf of sapphi-red August 1, 2025 15:08 View session

fix: resolve TypeScript type error in create-vite tests

8201add

Co-authored-by: sapphi-red <49056869+sapphi-red@users.noreply.github.com>

Copilot finished work on behalf of sapphi-red August 1, 2025 15:15

sapphi-red marked this pull request as ready for review August 8, 2025 03:00

chore: add co-author

0531bd9

Co-authored-by: ivan <sun_day500@163.com>

sapphi-red approved these changes Aug 8, 2025

View reviewed changes

Uh oh!

feat(create-vite): support auto install dependencies and start dev #20468

Are you sure you want to change the base?

feat(create-vite): support auto install dependencies and start dev #20468

Uh oh!

Conversation

Copilot AI commented Jul 24, 2025 • edited by sapphi-red Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

New Features

Usage Examples

Interactive Mode with New Prompts

Command Line Flags

Updated Help Message

Implementation Details

Changes Made

Core Functionality

Testing

Code Quality

Manual Testing Verified

Breaking Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sapphi-red left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Aug 1, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sapphi-red commented Aug 1, 2025

Uh oh!

Copilot AI commented Aug 1, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sapphi-red commented Aug 1, 2025

Uh oh!

Copilot AI commented Aug 1, 2025

Uh oh!

sapphi-red commented Aug 1, 2025

Uh oh!

Copilot AI commented Aug 1, 2025

Uh oh!

Uh oh!

Copilot AI commented Jul 24, 2025 •

edited by sapphi-red

Loading