diff --git a/.clippy.toml b/.clippy.toml index fd0b1c45c2..40215aa466 100644 --- a/.clippy.toml +++ b/.clippy.toml @@ -12,6 +12,7 @@ disallowed-methods = [ { path = "str::replace", reason = "To avoid memory allocation, use `cow_utils::CowUtils::cow_replace` instead." }, { path = "str::replacen", reason = "To avoid memory allocation, use `cow_utils::CowUtils::cow_replacen` instead." }, { path = "std::env::current_dir", reason = "To get an `AbsolutePathBuf`, Use `vite_path::current_dir` instead." }, + { path = "std::io::IsTerminal::is_terminal", reason = "Use `vite_powershell::is_stdin_terminal` for stdin, or `vite_shared::is_stdout_terminal` / `vite_shared::is_stderr_terminal`, which memoize the lookup." }, ] disallowed-types = [ diff --git a/Cargo.lock b/Cargo.lock index 756f413507..f05c4894e7 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -8818,6 +8818,7 @@ dependencies = [ "tracing", "tracing-subscriber", "vite_path", + "vite_powershell", "vite_str", "which", ] diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/apps/web/index.html b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/apps/web/index.html new file mode 100644 index 0000000000..ce6d6280c2 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/apps/web/index.html @@ -0,0 +1,6 @@ + + + +

web

+ + diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/apps/web/package.json b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/apps/web/package.json new file mode 100644 index 0000000000..64630869c1 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/apps/web/package.json @@ -0,0 +1 @@ +{ "name": "web", "private": true } diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/package.json b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/package.json new file mode 100644 index 0000000000..05c1c2ef02 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/package.json @@ -0,0 +1 @@ +{ "name": "app-root-auto-select", "private": true, "workspaces": ["apps/*", "packages/*"] } diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/packages/ui/package.json b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/packages/ui/package.json new file mode 100644 index 0000000000..70bb6aab17 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/packages/ui/package.json @@ -0,0 +1 @@ +{ "name": "ui", "private": true, "type": "module", "main": "src/index.ts" } diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/packages/ui/src/index.ts b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/packages/ui/src/index.ts new file mode 100644 index 0000000000..905c7a9bbb --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/packages/ui/src/index.ts @@ -0,0 +1,3 @@ +export function hello(name: string): string { + return `hello ${name}`; +} diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/snapshots.toml b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/snapshots.toml new file mode 100644 index 0000000000..0d74f9f251 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/snapshots.toml @@ -0,0 +1,10 @@ +[[case]] +name = "auto_select" +vp = ["local", "global"] +comment = """ +With exactly one likely-runnable package, a bare app command in an interactive +terminal auto-selects it, prints the Selected/Tip teaching lines, and runs +there (rfcs/cwd-flag.md). This TTY-only branch was untestable in the old +harness. +""" +steps = [["vp", "build"]] diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/snapshots/auto_select.global.md b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/snapshots/auto_select.global.md new file mode 100644 index 0000000000..edc6dc5023 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/snapshots/auto_select.global.md @@ -0,0 +1,21 @@ +# auto_select + +With exactly one likely-runnable package, a bare app command in an interactive +terminal auto-selects it, prints the Selected/Tip teaching lines, and runs +there (rfcs/cwd-flag.md). This TTY-only branch was untestable in the old +harness. + +## `vp build` + +``` +VITE+ - The Unified Toolchain for the Web + +Selected package: web (apps/web) +Tip: run this directly with `vp -C apps/web build` +vite building client environment for production... +✓ 2 modules transformed. +computing gzip size... +dist/index.html 0.06 kB │ gzip: 0.06 kB + +✓ built in +``` diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/snapshots/auto_select.local.md b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/snapshots/auto_select.local.md new file mode 100644 index 0000000000..a33f993f6c --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_auto_select/snapshots/auto_select.local.md @@ -0,0 +1,19 @@ +# auto_select + +With exactly one likely-runnable package, a bare app command in an interactive +terminal auto-selects it, prints the Selected/Tip teaching lines, and runs +there (rfcs/cwd-flag.md). This TTY-only branch was untestable in the old +harness. + +## `vp build` + +``` +Selected package: web (apps/web) +Tip: run this directly with `vp -C apps/web build` +vite building client environment for production... +✓ 2 modules transformed. +computing gzip size... +dist/index.html 0.06 kB │ gzip: 0.06 kB + +✓ built in +``` diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/package.json b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/package.json new file mode 100644 index 0000000000..b9fabc032d --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/package.json @@ -0,0 +1 @@ +{ "name": "app-root-default-package", "private": true } diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/packages/ui/package.json b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/packages/ui/package.json new file mode 100644 index 0000000000..70bb6aab17 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/packages/ui/package.json @@ -0,0 +1 @@ +{ "name": "ui", "private": true, "type": "module", "main": "src/index.ts" } diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/packages/ui/src/index.ts b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/packages/ui/src/index.ts new file mode 100644 index 0000000000..905c7a9bbb --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/packages/ui/src/index.ts @@ -0,0 +1,3 @@ +export function hello(name: string): string { + return `hello ${name}`; +} diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/snapshots.toml b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/snapshots.toml new file mode 100644 index 0000000000..9b923956c1 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/snapshots.toml @@ -0,0 +1,9 @@ +[[case]] +name = "default_package" +vp = ["local", "global"] +comment = """ +defaultPackage in the root config acts as an implicit -C for bare app +commands, including at a root that is not a JS workspace; vp prints a note +line and runs in the configured directory (rfcs/cwd-flag.md). +""" +steps = [["vp", "pack"]] diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/snapshots/default_package.global.md b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/snapshots/default_package.global.md new file mode 100644 index 0000000000..6e964447e2 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/snapshots/default_package.global.md @@ -0,0 +1,18 @@ +# default_package + +defaultPackage in the root config acts as an implicit -C for bare app +commands, including at a root that is not a JS workspace; vp prints a note +line and runs in the configured directory (rfcs/cwd-flag.md). + +## `vp pack` + +``` +VITE+ - The Unified Toolchain for the Web + +note: vp pack: using ./packages/ui (defaultPackage) +ℹ entry: src/index.ts +ℹ Build start +ℹ dist/index.mjs 0.10 kB │ gzip: 0.11 kB +ℹ 1 files, total: 0.10 kB +✔ Build complete in +``` diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/snapshots/default_package.local.md b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/snapshots/default_package.local.md new file mode 100644 index 0000000000..19638ef47d --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/snapshots/default_package.local.md @@ -0,0 +1,16 @@ +# default_package + +defaultPackage in the root config acts as an implicit -C for bare app +commands, including at a root that is not a JS workspace; vp prints a note +line and runs in the configured directory (rfcs/cwd-flag.md). + +## `vp pack` + +``` +note: vp pack: using ./packages/ui (defaultPackage) +ℹ entry: src/index.ts +ℹ Build start +ℹ dist/index.mjs 0.10 kB │ gzip: 0.11 kB +ℹ 1 files, total: 0.10 kB +✔ Build complete in +``` diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/vite.config.ts b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/vite.config.ts new file mode 100644 index 0000000000..36dab4eb9e --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_default_package/vite.config.ts @@ -0,0 +1,3 @@ +export default { + defaultPackage: './packages/ui', +}; diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/admin/index.html b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/admin/index.html new file mode 100644 index 0000000000..9a194fe836 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/admin/index.html @@ -0,0 +1,6 @@ + + + +

admin

+ + diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/admin/package.json b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/admin/package.json new file mode 100644 index 0000000000..bebad673a4 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/admin/package.json @@ -0,0 +1 @@ +{ "name": "admin", "private": true } diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/web/index.html b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/web/index.html new file mode 100644 index 0000000000..ce6d6280c2 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/web/index.html @@ -0,0 +1,6 @@ + + + +

web

+ + diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/web/package.json b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/web/package.json new file mode 100644 index 0000000000..64630869c1 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/apps/web/package.json @@ -0,0 +1 @@ +{ "name": "web", "private": true } diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/package.json b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/package.json new file mode 100644 index 0000000000..0807f1400d --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/package.json @@ -0,0 +1 @@ +{ "name": "app-root-listing", "private": true, "workspaces": ["apps/*", "packages/*"] } diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/packages/ui/package.json b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/packages/ui/package.json new file mode 100644 index 0000000000..70bb6aab17 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/packages/ui/package.json @@ -0,0 +1 @@ +{ "name": "ui", "private": true, "type": "module", "main": "src/index.ts" } diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/packages/ui/src/index.ts b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/packages/ui/src/index.ts new file mode 100644 index 0000000000..905c7a9bbb --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/packages/ui/src/index.ts @@ -0,0 +1,3 @@ +export function hello(name: string): string { + return `hello ${name}`; +} diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/snapshots.toml b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/snapshots.toml new file mode 100644 index 0000000000..8063e4df48 --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/snapshots.toml @@ -0,0 +1,9 @@ +[[case]] +name = "listing" +vp = ["local", "global"] +comment = """ +A bare app command at a workspace root with several candidate packages prints +the ranked package listing with -C hints and exits 1 instead of building the +root, even in an interactive terminal (rfcs/cwd-flag.md). +""" +steps = [["vp", "build"]] diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/snapshots/listing.global.md b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/snapshots/listing.global.md new file mode 100644 index 0000000000..aa2352460b --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/snapshots/listing.global.md @@ -0,0 +1,23 @@ +# listing + +A bare app command at a workspace root with several candidate packages prints +the ranked package listing with -C hints and exits 1 instead of building the +root, even in an interactive terminal (rfcs/cwd-flag.md). + +## `vp build` + +**Exit code:** 1 + +``` +VITE+ - The Unified Toolchain for the Web + +error: `vp build` at the workspace root needs a target package. + + Packages in this workspace: + admin apps/admin + web apps/web + ui packages/ui + + Pass a directory: vp -C apps/admin build + Or run every package's build script: vp run -r build +``` diff --git a/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/snapshots/listing.local.md b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/snapshots/listing.local.md new file mode 100644 index 0000000000..f8aa7200cd --- /dev/null +++ b/crates/vite_cli_snapshots/tests/cli_snapshots/fixtures/app_root_listing/snapshots/listing.local.md @@ -0,0 +1,21 @@ +# listing + +A bare app command at a workspace root with several candidate packages prints +the ranked package listing with -C hints and exits 1 instead of building the +root, even in an interactive terminal (rfcs/cwd-flag.md). + +## `vp build` + +**Exit code:** 1 + +``` +error: `vp build` at the workspace root needs a target package. + + Packages in this workspace: + admin apps/admin + web apps/web + ui packages/ui + + Pass a directory: vp -C apps/admin build + Or run every package's build script: vp run -r build +``` diff --git a/crates/vite_global_cli/src/cli.rs b/crates/vite_global_cli/src/cli.rs index 2d91427f40..2b7d50c5a9 100644 --- a/crates/vite_global_cli/src/cli.rs +++ b/crates/vite_global_cli/src/cli.rs @@ -3,7 +3,7 @@ //! This module defines the CLI structure using clap and routes commands //! to their appropriate handlers. -use std::{collections::HashSet, ffi::OsStr, io::IsTerminal, process::ExitStatus}; +use std::{collections::HashSet, ffi::OsStr, process::ExitStatus}; use clap::{CommandFactory, FromArgMatches, Parser, Subcommand}; use clap_complete::ArgValueCompleter; @@ -53,6 +53,10 @@ pub struct Args { #[arg(short = 'V', long = "version")] pub version: bool, + /// Run as if vp was started in instead of the current working directory + #[arg(short = 'C', value_name = "DIR")] + pub chdir: Option, + #[clap(subcommand)] pub command: Option, } @@ -805,7 +809,7 @@ fn should_reinstall_node_mismatches( return true; } - if !std::io::stdin().is_terminal() || std::env::var_os("CI").is_some() { + if !vite_shared::is_stdin_terminal() || std::env::var_os("CI").is_some() { let package_names = packages.iter().map(|package| package.name.as_str()).collect::>().join(", "); output::warn(&format!( @@ -848,10 +852,20 @@ pub async fn run_command(cwd: AbsolutePathBuf, args: Args) -> Result Result { + // Apply the global `-C ` flag before anything reads cwd, so local CLI + // resolution and command execution behave as if vp was started in . + // `clean()` normalizes `.`/`..` so upward workspace walks never see them. + if let Some(dir) = &args.chdir { + cwd = cwd.join(dir).clean(); + if !cwd.as_path().is_dir() { + return Err(Error::UserMessage(format!("directory not found: {dir}").into())); + } + } + // Handle --version flag (Category B: delegates to JS) if args.version { return commands::version::execute(cwd).await; diff --git a/crates/vite_global_cli/src/command_picker.rs b/crates/vite_global_cli/src/command_picker.rs index dc31289b9c..540faef750 100644 --- a/crates/vite_global_cli/src/command_picker.rs +++ b/crates/vite_global_cli/src/command_picker.rs @@ -1,7 +1,7 @@ //! Interactive top-level command picker for `vp`. use std::{ - io::{self, IsTerminal, Write}, + io::{self, Write}, ops::ControlFlow, }; @@ -114,20 +114,6 @@ const COMMANDS: &[CommandEntry] = &[ }, ]; -const CI_ENV_VARS: &[&str] = &[ - "CI", - "CONTINUOUS_INTEGRATION", - "GITHUB_ACTIONS", - "GITLAB_CI", - "CIRCLECI", - "TRAVIS", - "JENKINS_URL", - "BUILDKITE", - "DRONE", - "CODEBUILD_BUILD_ID", - "TF_BUILD", -]; - pub fn pick_top_level_command_if_interactive( cwd: &AbsolutePath, ) -> io::Result { @@ -144,14 +130,7 @@ pub fn pick_top_level_command_if_interactive( } fn should_enable_picker() -> bool { - std::io::stdin().is_terminal() - && std::io::stdout().is_terminal() - && std::env::var("TERM").map_or(true, |term| term != "dumb") - && !is_ci_environment() -} - -fn is_ci_environment() -> bool { - CI_ENV_VARS.iter().any(|key| std::env::var_os(key).is_some()) + vite_shared::is_interactive_terminal() } fn run_picker(command_order: &[usize]) -> io::Result> { diff --git a/crates/vite_global_cli/src/commands/env/list_remote.rs b/crates/vite_global_cli/src/commands/env/list_remote.rs index a42f160968..fa20b7c21e 100644 --- a/crates/vite_global_cli/src/commands/env/list_remote.rs +++ b/crates/vite_global_cli/src/commands/env/list_remote.rs @@ -117,8 +117,7 @@ fn strip_v(version: &str) -> &str { /// Whether colored output should be emitted on stdout. fn use_color() -> bool { - use std::io::IsTerminal; - std::io::stdout().is_terminal() && std::env::var_os("NO_COLOR").is_none() + vite_shared::is_stdout_terminal() && std::env::var_os("NO_COLOR").is_none() } /// Filter versions based on criteria. diff --git a/crates/vite_global_cli/src/commands/env/pin.rs b/crates/vite_global_cli/src/commands/env/pin.rs index 5f67440423..cd3f76c225 100644 --- a/crates/vite_global_cli/src/commands/env/pin.rs +++ b/crates/vite_global_cli/src/commands/env/pin.rs @@ -7,10 +7,7 @@ //! directory has no package.json. An explicit `--target` flag overrides the selection. //! An existing `engines.node` is never deleted or modified. -use std::{ - io::{IsTerminal, Write}, - process::ExitStatus, -}; +use std::{io::Write, process::ExitStatus}; use vite_js_runtime::NodeProvider; use vite_path::AbsolutePathBuf; @@ -290,7 +287,7 @@ async fn pin_node_version_file( // If a devEngines.runtime range is declared and no longer satisfied, offer to // sync it in interactive terminals and warn otherwise (rfcs/dev-engines.md) - check_dev_engines_sync(cwd, resolved_version, force, std::io::stdin().is_terminal()).await?; + check_dev_engines_sync(cwd, resolved_version, force, vite_shared::is_stdin_terminal()).await?; Ok(true) } diff --git a/crates/vite_global_cli/src/commands/global/install.rs b/crates/vite_global_cli/src/commands/global/install.rs index 0b09e52493..6c0399be4a 100644 --- a/crates/vite_global_cli/src/commands/global/install.rs +++ b/crates/vite_global_cli/src/commands/global/install.rs @@ -3,7 +3,7 @@ use std::{ collections::{HashMap, HashSet}, fs::{File, OpenOptions, TryLockError}, - io::{IsTerminal, Read, Write}, + io::{Read, Write}, process::Stdio, time::Duration, }; @@ -178,7 +178,7 @@ pub async fn install( )); let progress = ProgressBar::new(packages_count as u64); - if std::io::stderr().is_terminal() && std::env::var_os("CI").is_none() { + if vite_shared::is_stderr_terminal() && std::env::var_os("CI").is_none() { let style = ProgressStyle::with_template("{spinner:.cyan} {msg} ({pos}/{len})") .unwrap_or_else(|_| ProgressStyle::default_spinner()) .tick_strings(&["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]); diff --git a/crates/vite_global_cli/src/commands/global/mod.rs b/crates/vite_global_cli/src/commands/global/mod.rs index 57530e8ae5..01eb8ef142 100644 --- a/crates/vite_global_cli/src/commands/global/mod.rs +++ b/crates/vite_global_cli/src/commands/global/mod.rs @@ -1,12 +1,6 @@ //! Managed global package utilities. -use std::{ - collections::HashMap, - fs::File, - io::{IsTerminal, Read}, - process::Stdio, - time::Duration, -}; +use std::{collections::HashMap, fs::File, io::Read, process::Stdio, time::Duration}; use flate2::read::GzDecoder; use futures::{StreamExt, stream::FuturesUnordered}; @@ -96,7 +90,7 @@ pub(crate) async fn latest_package_versions( let mut versions = HashMap::with_capacity(specs.len()); let progress = ProgressBar::new(specs.len() as u64); - if std::io::stderr().is_terminal() && std::env::var_os("CI").is_none() { + if vite_shared::is_stderr_terminal() && std::env::var_os("CI").is_none() { let style = ProgressStyle::with_template("{spinner:.cyan} {msg} ({pos}/{len})") .unwrap_or_else(|_| ProgressStyle::default_spinner()) .tick_strings(&["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]); diff --git a/crates/vite_global_cli/src/commands/implode.rs b/crates/vite_global_cli/src/commands/implode.rs index 39148da71c..0a1cbad8f8 100644 --- a/crates/vite_global_cli/src/commands/implode.rs +++ b/crates/vite_global_cli/src/commands/implode.rs @@ -1,9 +1,6 @@ //! `vp implode` — completely remove vp and all its data from this system. -use std::{ - io::{IsTerminal, Write}, - process::ExitStatus, -}; +use std::{io::Write, process::ExitStatus}; use directories::BaseDirs; use owo_colors::OwoColorize; @@ -126,7 +123,7 @@ fn confirm_implode( home_dir: &AbsolutePathBuf, affected_profiles: &[AffectedProfile], ) -> Result { - if !std::io::stdin().is_terminal() { + if !vite_shared::is_stdin_terminal() { return Err(Error::UserMessage( "Cannot prompt for confirmation: stdin is not a TTY. Use --yes to skip confirmation." .into(), diff --git a/crates/vite_global_cli/src/help.rs b/crates/vite_global_cli/src/help.rs index 6741a3cafe..0f9416a2f2 100644 --- a/crates/vite_global_cli/src/help.rs +++ b/crates/vite_global_cli/src/help.rs @@ -1,6 +1,6 @@ //! Unified help rendering for the global CLI. -use std::{fmt::Write as _, io::IsTerminal}; +use std::fmt::Write as _; use clap::{CommandFactory, error::ErrorKind}; use owo_colors::OwoColorize; @@ -112,7 +112,7 @@ fn write_documentation_footer(output: &mut String, documentation_url: &str) { } pub fn should_style_help() -> bool { - std::io::stdout().is_terminal() + vite_shared::is_stdout_terminal() && std::env::var_os("NO_COLOR").is_none() && std::env::var("CLICOLOR").map_or(true, |value| value != "0") && std::env::var("TERM").map_or(true, |term| term != "dumb") diff --git a/crates/vite_global_cli/src/main.rs b/crates/vite_global_cli/src/main.rs index 1fdd658238..814a51c335 100644 --- a/crates/vite_global_cli/src/main.rs +++ b/crates/vite_global_cli/src/main.rs @@ -24,7 +24,7 @@ mod upgrade_check; use std::{ env, - io::{IsTerminal, Write}, + io::Write, process::{ExitCode, ExitStatus}, }; @@ -165,7 +165,7 @@ fn is_affirmative_response(input: &str) -> bool { } fn should_prompt_for_correction() -> bool { - std::io::stdin().is_terminal() && std::io::stderr().is_terminal() + vite_shared::is_stdin_terminal() && vite_shared::is_stderr_terminal() } fn prompt_to_run_suggested_command(suggestion: &str) -> bool { diff --git a/crates/vite_global_cli/src/shim/dispatch.rs b/crates/vite_global_cli/src/shim/dispatch.rs index 47776f7a31..f2516466eb 100644 --- a/crates/vite_global_cli/src/shim/dispatch.rs +++ b/crates/vite_global_cli/src/shim/dispatch.rs @@ -231,8 +231,6 @@ fn check_npm_global_install_result( node_dir: &AbsolutePath, node_version: &str, ) { - use std::io::IsTerminal; - let Ok(bin_dir) = config::get_bin_dir() else { return }; // Derive bin dir from prefix (Unix: prefix/bin, Windows: prefix itself) @@ -249,7 +247,7 @@ fn check_npm_global_install_result( } } - let is_interactive = std::io::stdin().is_terminal(); + let is_interactive = vite_shared::is_stdin_terminal(); // (bin_name, source_path, package_name) let mut missing_bins: Vec<(String, AbsolutePathBuf, String)> = Vec::new(); let mut managed_conflicts: Vec<(String, String)> = Vec::new(); diff --git a/crates/vite_global_cli/src/upgrade_check.rs b/crates/vite_global_cli/src/upgrade_check.rs index d5fd005279..5d9f330c6a 100644 --- a/crates/vite_global_cli/src/upgrade_check.rs +++ b/crates/vite_global_cli/src/upgrade_check.rs @@ -4,10 +4,7 @@ //! result to `~/.vite-plus/.upgrade-check.json`. Displays a one-line notice on //! stderr when a newer version is available, at most once per 24 hours. -use std::{ - io::IsTerminal, - time::{SystemTime, UNIX_EPOCH}, -}; +use std::time::{SystemTime, UNIX_EPOCH}; use owo_colors::OwoColorize; use serde::{Deserialize, Serialize}; @@ -143,7 +140,7 @@ pub fn display_upgrade_notice(result: &UpgradeCheckResult) { /// Returns `false` for commands excluded by design, quiet modes, and /// machine-readable output flags (--silent, -s, --json, --parseable, --format json). pub fn should_run_for_command(args: &crate::cli::Args) -> bool { - if !cfg!(test) && !std::io::stderr().is_terminal() { + if !cfg!(test) && !vite_shared::is_stderr_terminal() { return false; } diff --git a/crates/vite_install/src/package_manager.rs b/crates/vite_install/src/package_manager.rs index e7fcb975f1..abd7bc6671 100644 --- a/crates/vite_install/src/package_manager.rs +++ b/crates/vite_install/src/package_manager.rs @@ -2,7 +2,7 @@ use std::{ collections::HashMap, env, fmt, fs::{self, File}, - io::{self, BufReader, IsTerminal, Write}, + io::{self, BufReader, Write}, path::Path, }; @@ -1229,26 +1229,7 @@ async fn set_dev_engines_package_manager_field( } pub(crate) use vite_shared::format_path_prepended as format_path_env; - -/// Common CI environment variables -const CI_ENV_VARS: &[&str] = &[ - "CI", - "CONTINUOUS_INTEGRATION", - "GITHUB_ACTIONS", - "GITLAB_CI", - "CIRCLECI", - "TRAVIS", - "JENKINS_URL", - "BUILDKITE", - "DRONE", - "CODEBUILD_BUILD_ID", // AWS CodeBuild - "TF_BUILD", // Azure Pipelines -]; - -/// Check if running in a CI environment -fn is_ci_environment() -> bool { - CI_ENV_VARS.iter().any(|key| env::var(key).is_ok()) -} +use vite_shared::is_ci_environment; /// Interactive menu for selecting a package manager with keyboard navigation fn interactive_package_manager_menu() -> Result { @@ -1404,7 +1385,7 @@ fn prompt_package_manager_selection() -> Result { } // Check if stdin is a TTY (terminal) - if not, use default - if !io::stdin().is_terminal() { + if !vite_shared::is_stdin_terminal() { tracing::info!("Non-interactive environment detected. Using default package manager: pnpm"); return Ok(PackageManagerType::Pnpm); } diff --git a/crates/vite_js_runtime/src/download.rs b/crates/vite_js_runtime/src/download.rs index 5f28bf6f45..21b3949734 100644 --- a/crates/vite_js_runtime/src/download.rs +++ b/crates/vite_js_runtime/src/download.rs @@ -3,7 +3,7 @@ //! This module provides platform-agnostic utilities for downloading, //! verifying, and extracting runtime archives. -use std::{fs::File, io::IsTerminal, time::Duration}; +use std::{fs::File, time::Duration}; use backon::{ExponentialBuilder, Retryable}; use futures_util::StreamExt; @@ -45,7 +45,7 @@ pub async fn download_file( // across retry attempts; its position is reset at the start of every // attempt so a retried download doesn't double-count bytes. let is_ci = vite_shared::EnvConfig::get().is_ci; - let progress = if std::io::stderr().is_terminal() && !is_ci { + let progress = if vite_shared::is_stderr_terminal() && !is_ci { let pb = ProgressBar::new_spinner(); pb.set_style( ProgressStyle::default_spinner() diff --git a/crates/vite_setup/src/install.rs b/crates/vite_setup/src/install.rs index 879af4f4a5..ba20638f39 100644 --- a/crates/vite_setup/src/install.rs +++ b/crates/vite_setup/src/install.rs @@ -5,7 +5,7 @@ use std::{ env, - io::{Cursor, IsTerminal, Read as _, Write as _}, + io::{Cursor, Read as _, Write as _}, path::Path, process::{self, Output}, time::{SystemTime, UNIX_EPOCH}, @@ -132,7 +132,7 @@ fn is_affirmative_response(input: &str) -> bool { } fn should_prompt_release_age_override(silent: bool) -> bool { - !silent && std::io::stdin().is_terminal() && std::io::stderr().is_terminal() + !silent && vite_shared::is_stdin_terminal() && vite_shared::is_stderr_terminal() } fn prompt_release_age_override(version: &str) -> bool { diff --git a/crates/vite_shared/Cargo.toml b/crates/vite_shared/Cargo.toml index b117cb3487..58cd50b7ef 100644 --- a/crates/vite_shared/Cargo.toml +++ b/crates/vite_shared/Cargo.toml @@ -18,6 +18,7 @@ supports-color = "3" tracing = { workspace = true } tracing-subscriber = { workspace = true } vite_path = { workspace = true } +vite_powershell = { workspace = true } vite_str = { workspace = true } which = { workspace = true } diff --git a/crates/vite_shared/src/header.rs b/crates/vite_shared/src/header.rs index cf4163f0a1..f4ec220b32 100644 --- a/crates/vite_shared/src/header.rs +++ b/crates/vite_shared/src/header.rs @@ -8,10 +8,7 @@ //! - Stream-based response parsing (modelled after `terminal-colorsaurus`) //! - Gradient/fade generation and RGB ANSI coloring -use std::{ - io::IsTerminal, - sync::{LazyLock, OnceLock}, -}; +use std::sync::{LazyLock, OnceLock}; #[cfg(unix)] use std::{ io::Write, @@ -62,13 +59,11 @@ fn fg_rgb(color: Rgb) -> String { } fn should_colorize() -> bool { - let stdout = std::io::stdout(); - stdout.is_terminal() && on(Stream::Stdout).is_some() + crate::is_stdout_terminal() && on(Stream::Stdout).is_some() } fn supports_true_color() -> bool { - let stdout = std::io::stdout(); - stdout.is_terminal() && on(Stream::Stdout).is_some_and(|color| color.has_16m) + crate::is_stdout_terminal() && on(Stream::Stdout).is_some_and(|color| color.has_16m) } fn lerp(a: f64, b: f64, t: f64) -> f64 { @@ -190,7 +185,7 @@ fn parse_osc4_rgb(buffer: &str, index: u8) -> Option { fn is_osc_query_unsupported() -> bool { static UNSUPPORTED: OnceLock = OnceLock::new(); *UNSUPPORTED.get_or_init(|| { - if !std::io::stdout().is_terminal() || !std::io::stdin().is_terminal() { + if !crate::is_stdout_terminal() || !crate::is_stdin_terminal() { return true; } @@ -547,7 +542,7 @@ pub fn vite_plus_header() -> String { /// which is where `vp check --fix` typically runs. #[must_use] pub fn should_print_header() -> bool { - if !std::io::stdout().is_terminal() { + if !crate::is_stdout_terminal() { return false; } if std::env::var_os("GIT_INDEX_FILE").is_some() { diff --git a/crates/vite_shared/src/interactivity.rs b/crates/vite_shared/src/interactivity.rs new file mode 100644 index 0000000000..fbb17c1c4a --- /dev/null +++ b/crates/vite_shared/src/interactivity.rs @@ -0,0 +1,54 @@ +//! Shared CI-environment and interactive-terminal detection. + +pub use vite_powershell::is_stdin_terminal; + +/// Common CI environment variables. +const CI_ENV_VARS: &[&str] = &[ + "CI", + "CONTINUOUS_INTEGRATION", + "GITHUB_ACTIONS", + "GITLAB_CI", + "CIRCLECI", + "TRAVIS", + "JENKINS_URL", + "BUILDKITE", + "DRONE", + "CODEBUILD_BUILD_ID", // AWS CodeBuild + "TF_BUILD", // Azure Pipelines +]; + +/// Check if running in a CI environment. +pub fn is_ci_environment() -> bool { + CI_ENV_VARS.iter().any(|key| std::env::var_os(key).is_some()) +} + +/// Memoized `stdout` terminal check; the fd's TTY-ness cannot change +/// within a process. +#[expect(clippy::disallowed_methods, reason = "the memoizing wrapper itself")] +pub fn is_stdout_terminal() -> bool { + use std::{io::IsTerminal, sync::LazyLock}; + static IS_TTY: LazyLock = LazyLock::new(|| std::io::stdout().is_terminal()); + *IS_TTY +} + +/// Memoized `stderr` terminal check; the fd's TTY-ness cannot change +/// within a process. +#[expect(clippy::disallowed_methods, reason = "the memoizing wrapper itself")] +pub fn is_stderr_terminal() -> bool { + use std::{io::IsTerminal, sync::LazyLock}; + static IS_TTY: LazyLock = LazyLock::new(|| std::io::stderr().is_terminal()); + *IS_TTY +} + +/// True when vp can show interactive prompts: stdin and stdout are terminals, +/// the terminal is capable, and this is not a CI environment. +/// +/// The CI check is not redundant with the TTY checks: some CI systems run +/// commands in a PTY (Buildkite does by default), where an interactive prompt +/// would hang the job. +pub fn is_interactive_terminal() -> bool { + is_stdin_terminal() + && is_stdout_terminal() + && std::env::var("TERM").map_or(true, |term| term != "dumb") + && !is_ci_environment() +} diff --git a/crates/vite_shared/src/lib.rs b/crates/vite_shared/src/lib.rs index 7ef476143f..972a942cbe 100644 --- a/crates/vite_shared/src/lib.rs +++ b/crates/vite_shared/src/lib.rs @@ -13,6 +13,7 @@ mod error; pub mod header; mod home; mod http; +mod interactivity; mod json_edit; pub mod output; mod package_json; @@ -25,6 +26,10 @@ pub use env_config::{EnvConfig, TestEnvGuard}; pub use error::format_error_chain; pub use home::get_vp_home; pub use http::shared_http_client; +pub use interactivity::{ + is_ci_environment, is_interactive_terminal, is_stderr_terminal, is_stdin_terminal, + is_stdout_terminal, +}; pub use json_edit::{JsonStyle, edit_json_object, insert_after}; pub use package_json::{ DevEngineDependency, DevEngineField, DevEngines, Engines, OnFail, PackageJson, dev_engine_entry, diff --git a/crates/vite_static_config/src/lib.rs b/crates/vite_static_config/src/lib.rs index 29d65539e0..d5633752cd 100644 --- a/crates/vite_static_config/src/lib.rs +++ b/crates/vite_static_config/src/lib.rs @@ -87,6 +87,11 @@ const CONFIG_FILE_NAMES: &[&str] = &[ "vite.config.cts", ]; +/// Returns true when `dir` directly contains a Vite config file. +pub fn has_config_file(dir: &AbsolutePath) -> bool { + resolve_config_path(dir).is_some() +} + /// Resolve the vite config file path in the given directory. /// /// Tries each config file name in priority order and returns the first one that exists. diff --git a/docs/config/index.md b/docs/config/index.md index d7f1b25543..d54665244c 100644 --- a/docs/config/index.md +++ b/docs/config/index.md @@ -33,3 +33,16 @@ Vite+ extends the basic Vite configuration with these additions: - [`test`](/config/test) for Vitest - [`pack`](/config/pack) for tsdown - [`staged`](/config/staged) for staged-file checks +- [`defaultPackage`](#defaultpackage) for the default target of bare app commands at a workspace root + +## defaultPackage + +Default target directory for `vp dev` / `vp build` / `vp preview` / `vp pack` when they are invoked bare in the directory containing the config, an implicit [`vp -C `](/guide/monorepo#app-commands): + +```ts [vite.config.ts] +export default { + defaultPackage: './frontend', +}; +``` + +The value must be a static string literal: vp reads it without executing the config, so it also works at repository roots without a vite-plus install (for example a Laravel or Rails repo whose Vite app lives in `frontend/`). An explicit `-C` or positional target always wins over the config. diff --git a/docs/guide/monorepo.md b/docs/guide/monorepo.md index def5b9aa08..766f62f885 100644 --- a/docs/guide/monorepo.md +++ b/docs/guide/monorepo.md @@ -145,16 +145,78 @@ This keeps the behavior centralized while letting each team or package own the p ## App Commands -The root `vite.config.ts` is most valuable for shared linting, formatting, staged checks, and task definitions. For project-specific development, build, and test behavior, use the setup that best matches each app: +The root `vite.config.ts` is most valuable for shared linting, formatting, staged checks, and task definitions. Development, build, preview, and packaging still act on a single app, so Vite+ makes the built-in commands monorepo-aware instead of forcing you to `cd` between packages. -- Pass a folder to built-in Vite commands when you want to target one app: +### Running at the workspace root + +`vp dev`, `vp build`, `vp preview`, and `vp pack` never silently act on the workspace root, which usually has no app of its own. Run them at the top of the monorepo and Vite+ works out which app you mean. + +When exactly one package looks like an app, vp runs it and shows you the direct command for next time: + +``` +$ vp dev +Selected package: web (apps/web) +Tip: run this directly with `vp -C apps/web dev` + + VITE+ v0.2.2 + + ➜ Local: http://localhost:5173/ + ➜ Network: use --host to expose +``` + +When several packages could be the target, vp lists them with ready-to-copy commands instead of guessing: + +``` +$ vp build +error: `vp build` at the workspace root needs a target package. + + Packages in this workspace: + admin apps/admin + web apps/web + @shop/ui packages/ui + + Pass a directory: vp -C apps/admin build + Or run every package's build script: vp run -r build +``` + +Packages that look runnable for the command (an `index.html` or `vite.config.*` for `dev` / `build` / `preview`, a library entry for `pack`) are listed first. + +### Targeting a package with `-C` + +The global `-C` flag runs any command as if you had `cd`'d into a package. It works with every vp command and is identical to `cd && vp `: ```bash -vp dev apps/web -vp build apps/web +vp -C apps/web dev +vp -C apps/web build +vp -C packages/ui pack +``` + +Passing a folder as a positional (`vp dev apps/web`) still works, but keeps upstream Vite semantics: it sets Vite's `root` option without changing the working directory, so `process.cwd()` reads in configs and plugins resolve from where you ran vp. Prefer `-C` when the package should behave as if you had `cd`'d into it. + +### A fixed default with `defaultPackage` + +To always target one directory and skip the resolution above, set [`defaultPackage`](/config/#defaultpackage) in the root config: + +```ts [vite.config.ts] +export default { + defaultPackage: './apps/web', +}; ``` -- Keep package-specific scripts in each package when the command differs per app: +``` +$ vp dev +note: vp dev: using ./apps/web (defaultPackage) + + VITE+ v0.2.2 + + ➜ Local: http://localhost:5173/ +``` + +This is the right choice for framework monorepos that are not JavaScript workspaces, such as a Laravel or Rails app with a `frontend/` directory: there is no package list to resolve, so `defaultPackage` points vp straight at the app. Because vp reads it without executing the config, it works even when `vite-plus` is installed only inside that subdirectory. + +### Package scripts and workspace-wide tasks + +Keep package-specific scripts in each package when the command differs per app: ```json [apps/api/package.json] { @@ -165,7 +227,7 @@ vp build apps/web } ``` -- Run scripts across the workspace with `vp run`: +Run scripts across the whole workspace with `vp run`: ```bash vp run -r build diff --git a/packages/cli/binding/src/check/analysis.rs b/packages/cli/binding/src/check/analysis.rs index e02d26fb54..da42c7f2d1 100644 --- a/packages/cli/binding/src/check/analysis.rs +++ b/packages/cli/binding/src/check/analysis.rs @@ -1,5 +1,3 @@ -use std::io::IsTerminal; - use owo_colors::OwoColorize; use vite_shared::output; @@ -141,7 +139,7 @@ pub(super) fn print_stdout_block(block: &str) { pub(super) fn print_summary_line(message: &str) { output::raw(""); - if std::io::stdout().is_terminal() && message.contains('`') { + if vite_shared::is_stdout_terminal() && message.contains('`') { let mut formatted = String::with_capacity(message.len()); let mut segments = message.split('`'); if let Some(first) = segments.next() { diff --git a/packages/cli/binding/src/cli/app_target.rs b/packages/cli/binding/src/cli/app_target.rs new file mode 100644 index 0000000000..001461793f --- /dev/null +++ b/packages/cli/binding/src/cli/app_target.rs @@ -0,0 +1,202 @@ +//! Target elicitation for bare app commands at a workspace root. +//! +//! A bare `vp dev`/`build`/`preview`/`pack` at a workspace root has no target +//! and would silently run against the root. Resolution order (rfcs/cwd-flag.md): +//! explicit `-C` and positional targets are handled before this code and skip +//! elicitation entirely; then `defaultPackage` from the config in the +//! invocation directory, then the workspace package listing (interactive +//! picker planned once `vite_select` supports a custom prompt), then exit 1. + +use vite_error::Error; +use vite_path::AbsolutePathBuf; +use vite_shared::output; +use vite_task::ExitStatus; +use vite_workspace::WorkspaceFile; + +use super::types::SynthesizableSubcommand; + +/// Where a bare app command should run. +pub(super) enum AppTarget { + /// No elicitation applies; run in the invocation directory as today. + CurrentDir, + /// Run as if invoked in this directory (implicit `-C`). + Dir(AbsolutePathBuf), + /// Elicitation printed its output and decided the exit code. + Exit(ExitStatus), +} + +struct PackageRow { + name: String, + path: String, + absolute: AbsolutePathBuf, + runnable: bool, +} + +/// App commands are the single-target subcommands; everything else never +/// goes through elicitation. +fn app_command_parts(subcommand: &SynthesizableSubcommand) -> Option<(&'static str, &[String])> { + match subcommand { + SynthesizableSubcommand::Dev { args } => Some(("dev", args)), + SynthesizableSubcommand::Build { args } => Some(("build", args)), + SynthesizableSubcommand::Preview { args } => Some(("preview", args)), + SynthesizableSubcommand::Pack { args } => Some(("pack", args)), + _ => None, + } +} + +/// Bare = no positional target and no help-like flag. A non-flag token may be +/// a flag value (`--port 3000`), so any non-flag argument conservatively +/// disables elicitation; help/version requests are answered by the underlying +/// tool and must never be redirected. +fn is_bare(args: &[String]) -> bool { + args.iter().all(|arg| { + arg.starts_with('-') && !matches!(arg.as_str(), "-h" | "--help" | "-V" | "--version") + }) +} + +/// Heuristic ranking signal: does `dir` look runnable for `command`? +/// Used for ordering and single-candidate auto-selection, never for hiding. +fn looks_runnable(dir: &AbsolutePathBuf, command: &str) -> bool { + let has_vite_config = vite_static_config::has_config_file(dir); + match command { + "pack" => has_vite_config || dir.as_path().join("src/index.ts").is_file(), + _ => has_vite_config || dir.as_path().join("index.html").is_file(), + } +} + +/// `defaultPackage` from the `vite.config.*` in `cwd`, read via static +/// extraction so it works at roots without a vite-plus install (non-workspace +/// framework repos). The value must be a static string literal. +fn resolve_default_package(command: &str, cwd: &AbsolutePathBuf) -> Option { + let fail = |msg: &str| { + output::error(msg); + Some(AppTarget::Exit(ExitStatus(1))) + }; + match vite_static_config::resolve_static_config(cwd).get("defaultPackage") { + Some(vite_static_config::FieldValue::Json(serde_json::Value::String(dir))) => { + let target = cwd.join(&dir).clean(); + if !target.as_path().is_dir() { + return fail(&format!("defaultPackage points to a missing directory: {dir}")); + } + output::note(&format!("vp {command}: using {dir} (defaultPackage)")); + Some(AppTarget::Dir(target)) + } + Some(vite_static_config::FieldValue::Json(other)) => { + fail(&format!("defaultPackage must be a string of a directory, got: {other}")) + } + Some(vite_static_config::FieldValue::NonStatic) => fail( + "defaultPackage in vite.config.ts must be a static string literal so vp can read it without executing the config", + ), + None => None, + } +} + +pub(super) fn resolve_app_target( + subcommand: &SynthesizableSubcommand, + cwd: &AbsolutePathBuf, +) -> Result { + let Some((command, args)) = app_command_parts(subcommand) else { + return Ok(AppTarget::CurrentDir); + }; + if !is_bare(args) { + return Ok(AppTarget::CurrentDir); + } + + // `defaultPackage` comes before any workspace lookup: the non-workspace + // framework shape (a Laravel-style root with a vite.config.ts pointer and + // no package.json up-tree) has no workspace metadata at all. + if let Some(target) = resolve_default_package(command, cwd) { + return Ok(target); + } + + // The package listing needs workspace metadata; anything unresolvable + // keeps today's behavior (the caller surfaces its own workspace errors). + let Ok((workspace_root, rel_from_root)) = vite_workspace::find_workspace_root(cwd) else { + return Ok(AppTarget::CurrentDir); + }; + if !rel_from_root.as_str().is_empty() + || matches!(workspace_root.workspace_file, WorkspaceFile::NonWorkspacePackage(_)) + { + return Ok(AppTarget::CurrentDir); + } + + let graph = + vite_workspace::load_package_graph(&workspace_root).map_err(|e| Error::Anyhow(e.into()))?; + let mut rows: Vec = graph + .node_weights() + .filter(|info| !info.path.as_str().is_empty()) + .map(|info| { + let absolute = info.absolute_path.to_absolute_path_buf(); + PackageRow { + name: info.package_json.name.to_string(), + path: info.path.as_str().to_string(), + runnable: looks_runnable(&absolute, command), + absolute, + } + }) + .collect(); + if rows.is_empty() { + return Ok(AppTarget::CurrentDir); + } + rows.sort_by(|a, b| (!a.runnable, a.path.as_str()).cmp(&(!b.runnable, b.path.as_str()))); + + // With exactly one likely-runnable package (rows are sorted runnable + // first), an interactive terminal auto-selects it (the degenerate picker). + let single_runnable = rows[0].runnable && rows.get(1).is_none_or(|row| !row.runnable); + if single_runnable && vite_shared::is_interactive_terminal() { + let row = &rows[0]; + println!("Selected package: {} ({})", row.name, row.path); + println!("Tip: run this directly with `vp -C {} {command}`", row.path); + return Ok(AppTarget::Dir(row.absolute.clone())); + } + + output::error(&format!("`vp {command}` at the workspace root needs a target package.")); + output::raw_stderr(""); + output::raw_stderr(" Packages in this workspace:"); + let name_width = rows.iter().map(|row| row.name.len()).max().unwrap_or(0); + for row in &rows { + output::raw_stderr(&format!(" {:>(); + assert!(is_bare(&to_args(&[]))); + assert!(is_bare(&to_args(&["--watch"]))); + assert!(is_bare(&to_args(&["-w", "--minify"]))); + // A positional target disables elicitation. + assert!(!is_bare(&to_args(&["apps/web"]))); + // A flag value is indistinguishable from a positional without knowing + // the tool's flag arity, so it conservatively counts as non-bare. + assert!(!is_bare(&to_args(&["--port", "3000"]))); + // Help/version requests go to the underlying tool, never elicitation. + assert!(!is_bare(&to_args(&["--help"]))); + assert!(!is_bare(&to_args(&["-h"]))); + assert!(!is_bare(&to_args(&["--watch", "--version"]))); + } + + #[test] + fn only_app_commands_elicit() { + let args = vec![]; + for (subcommand, expected) in [ + (SynthesizableSubcommand::Dev { args: args.clone() }, Some("dev")), + (SynthesizableSubcommand::Build { args: args.clone() }, Some("build")), + (SynthesizableSubcommand::Preview { args: args.clone() }, Some("preview")), + (SynthesizableSubcommand::Pack { args: args.clone() }, Some("pack")), + (SynthesizableSubcommand::Lint { args: args.clone() }, None), + (SynthesizableSubcommand::Test { args: args.clone() }, None), + ] { + assert_eq!(app_command_parts(&subcommand).map(|(name, _)| name), expected); + } + } +} diff --git a/packages/cli/binding/src/cli/execution.rs b/packages/cli/binding/src/cli/execution.rs index 5a5811b23d..9e32e411d5 100644 --- a/packages/cli/binding/src/cli/execution.rs +++ b/packages/cli/binding/src/cli/execution.rs @@ -1,4 +1,4 @@ -use std::{borrow::Cow, ffi::OsStr, io::IsTerminal, process::Stdio, sync::Arc}; +use std::{borrow::Cow, ffi::OsStr, process::Stdio, sync::Arc}; use rustc_hash::FxHashMap; use vite_error::Error; @@ -127,7 +127,7 @@ pub(crate) async fn resolve_and_capture_output( resolve_and_build_command(resolver, subcommand, resolved_vite_config, envs, cwd).await?; cmd.stdout(Stdio::piped()); cmd.stderr(Stdio::piped()); - if force_color_if_terminal && std::io::stdout().is_terminal() { + if force_color_if_terminal && vite_shared::is_stdout_terminal() { cmd.env("FORCE_COLOR", "1"); } diff --git a/packages/cli/binding/src/cli/mod.rs b/packages/cli/binding/src/cli/mod.rs index 5033a24339..de0c501139 100644 --- a/packages/cli/binding/src/cli/mod.rs +++ b/packages/cli/binding/src/cli/mod.rs @@ -3,6 +3,7 @@ //! This module contains all the CLI-related code. //! It handles argument parsing, command dispatching, and orchestration of the task execution. +mod app_target; mod execution; mod handler; mod help; @@ -46,6 +47,18 @@ async fn execute_direct_subcommand( cwd: &AbsolutePathBuf, options: Option, ) -> Result { + // A bare app command at a workspace root resolves its target first + // (defaultPackage, package listing); the command then runs as if invoked + // in the resolved directory (rfcs/cwd-flag.md). + let target = app_target::resolve_app_target(&subcommand, cwd)?; + if let app_target::AppTarget::Exit(status) = target { + return Ok(status); + } + let cwd = match &target { + app_target::AppTarget::Dir(dir) => dir, + _ => cwd, + }; + let (workspace_root, _) = vite_workspace::find_workspace_root(cwd)?; let workspace_path: Arc = workspace_root.path.into(); diff --git a/packages/cli/snap-tests-global/cli-helper-message/snap.txt b/packages/cli/snap-tests-global/cli-helper-message/snap.txt index 70c760db91..06797a92ab 100644 --- a/packages/cli/snap-tests-global/cli-helper-message/snap.txt +++ b/packages/cli/snap-tests-global/cli-helper-message/snap.txt @@ -51,6 +51,7 @@ Documentation: https://viteplus.dev/guide/ Options: -V, --version Print version + -C Run as if vp was started in instead of the current working directory -h, --help Print help > vp -V # show version diff --git a/packages/cli/snap-tests/command-app-root-listing/package.json b/packages/cli/snap-tests/command-app-root-listing/package.json new file mode 100644 index 0000000000..e63823dcc9 --- /dev/null +++ b/packages/cli/snap-tests/command-app-root-listing/package.json @@ -0,0 +1,8 @@ +{ + "name": "command-app-root-listing", + "version": "1.0.0", + "workspaces": [ + "packages/*" + ], + "type": "module" +} diff --git a/packages/cli/snap-tests/command-app-root-listing/packages/lib/package.json b/packages/cli/snap-tests/command-app-root-listing/packages/lib/package.json new file mode 100644 index 0000000000..bc55518964 --- /dev/null +++ b/packages/cli/snap-tests/command-app-root-listing/packages/lib/package.json @@ -0,0 +1,6 @@ +{ + "name": "lib", + "version": "1.0.0", + "type": "module", + "main": "src/index.ts" +} diff --git a/packages/cli/snap-tests/command-app-root-listing/packages/lib/src/index.ts b/packages/cli/snap-tests/command-app-root-listing/packages/lib/src/index.ts new file mode 100644 index 0000000000..7b8c293a75 --- /dev/null +++ b/packages/cli/snap-tests/command-app-root-listing/packages/lib/src/index.ts @@ -0,0 +1 @@ +export const lib = true; diff --git a/packages/cli/snap-tests/command-app-root-listing/packages/web/index.html b/packages/cli/snap-tests/command-app-root-listing/packages/web/index.html new file mode 100644 index 0000000000..b61cdc6f1d --- /dev/null +++ b/packages/cli/snap-tests/command-app-root-listing/packages/web/index.html @@ -0,0 +1,6 @@ + + + +

web app

+ + diff --git a/packages/cli/snap-tests/command-app-root-listing/packages/web/package.json b/packages/cli/snap-tests/command-app-root-listing/packages/web/package.json new file mode 100644 index 0000000000..886a9e5f15 --- /dev/null +++ b/packages/cli/snap-tests/command-app-root-listing/packages/web/package.json @@ -0,0 +1,5 @@ +{ + "name": "web", + "version": "1.0.0", + "type": "module" +} diff --git a/packages/cli/snap-tests/command-app-root-listing/snap.txt b/packages/cli/snap-tests/command-app-root-listing/snap.txt new file mode 100644 index 0000000000..c4d62a280f --- /dev/null +++ b/packages/cli/snap-tests/command-app-root-listing/snap.txt @@ -0,0 +1,19 @@ +[1]> vp build # bare build at the workspace root lists packages instead of building the root +error: `vp build` at the workspace root needs a target package. + + Packages in this workspace: + web packages/web + lib packages/lib + + Pass a directory: vp -C packages/web build + Or run every package's build script: vp run -r build + +[1]> vp dev # bare dev at the root no longer starts a server against the root +error: `vp dev` at the workspace root needs a target package. + + Packages in this workspace: + web packages/web + lib packages/lib + + Pass a directory: vp -C packages/web dev + Or run every package's dev script: vp run -r dev diff --git a/packages/cli/snap-tests/command-app-root-listing/steps.json b/packages/cli/snap-tests/command-app-root-listing/steps.json new file mode 100644 index 0000000000..228092b98d --- /dev/null +++ b/packages/cli/snap-tests/command-app-root-listing/steps.json @@ -0,0 +1,6 @@ +{ + "commands": [ + "vp build # bare build at the workspace root lists packages instead of building the root", + "vp dev # bare dev at the root no longer starts a server against the root" + ] +} diff --git a/packages/cli/snap-tests/command-cwd-flag/package.json b/packages/cli/snap-tests/command-cwd-flag/package.json new file mode 100644 index 0000000000..1fff4a5751 --- /dev/null +++ b/packages/cli/snap-tests/command-cwd-flag/package.json @@ -0,0 +1,8 @@ +{ + "name": "command-cwd-flag", + "version": "1.0.0", + "workspaces": [ + "packages/*" + ], + "type": "module" +} diff --git a/packages/cli/snap-tests/command-cwd-flag/packages/hello/package.json b/packages/cli/snap-tests/command-cwd-flag/packages/hello/package.json new file mode 100644 index 0000000000..c765a5d476 --- /dev/null +++ b/packages/cli/snap-tests/command-cwd-flag/packages/hello/package.json @@ -0,0 +1,9 @@ +{ + "name": "hello", + "version": "1.0.0", + "type": "module", + "main": "src/index.ts", + "scripts": { + "where": "node -e \"console.log('cwd base: ' + require('node:path').basename(process.cwd()))\"" + } +} diff --git a/packages/cli/snap-tests/command-cwd-flag/packages/hello/src/index.ts b/packages/cli/snap-tests/command-cwd-flag/packages/hello/src/index.ts new file mode 100644 index 0000000000..905c7a9bbb --- /dev/null +++ b/packages/cli/snap-tests/command-cwd-flag/packages/hello/src/index.ts @@ -0,0 +1,3 @@ +export function hello(name: string): string { + return `hello ${name}`; +} diff --git a/packages/cli/snap-tests/command-cwd-flag/snap.txt b/packages/cli/snap-tests/command-cwd-flag/snap.txt new file mode 100644 index 0000000000..7dfde5f689 --- /dev/null +++ b/packages/cli/snap-tests/command-cwd-flag/snap.txt @@ -0,0 +1,40 @@ +> vp -C packages/hello pack # -C packs the package from the workspace root +ℹ entry: src/index.ts +ℹ Build start +ℹ dist/index.mjs kB │ gzip: kB +ℹ 1 files, total: kB +✔ Build complete in ms + +> ls packages/hello/dist # output lands in the target package +index.mjs + +> rm -rf packages/hello/dist # reset so both forms produce identical output +> cd packages/hello && vp pack # the cd form is equivalent +ℹ entry: src/index.ts +ℹ Build start +ℹ dist/index.mjs kB │ gzip: kB +ℹ 1 files, total: kB +✔ Build complete in ms + +> vp -C packages/hello run where # -C applies to vp run as well +~/packages/hello$ node -e "console.log('cwd base: ' + require('node:path').basename(process.cwd()))" ⊘ cache disabled +cwd base: hello + + +> cd packages/hello && vp run where # equivalent cd form for run +~/packages/hello$ node -e "console.log('cwd base: ' + require('node:path').basename(process.cwd()))" ⊘ cache disabled +cwd base: hello + + +[1]> vp -C packages/missing build # missing directory errors +error: directory not found: packages/missing + +> vp pack packages/hello # positional stays a tsdown entry resolved from the invocation directory +ℹ entry: packages/hello +ℹ Build start +ℹ dist/hello.mjs kB │ gzip: kB +ℹ 1 files, total: kB +✔ Build complete in ms + +> ls dist # upstream semantics: output lands at the invocation directory, not in the package +hello.mjs diff --git a/packages/cli/snap-tests/command-cwd-flag/steps.json b/packages/cli/snap-tests/command-cwd-flag/steps.json new file mode 100644 index 0000000000..de417eae1f --- /dev/null +++ b/packages/cli/snap-tests/command-cwd-flag/steps.json @@ -0,0 +1,16 @@ +{ + "commands": [ + "vp -C packages/hello pack # -C packs the package from the workspace root", + "ls packages/hello/dist # output lands in the target package", + { + "command": "rm -rf packages/hello/dist # reset so both forms produce identical output", + "ignoreOutput": true + }, + "cd packages/hello && vp pack # the cd form is equivalent", + "vp -C packages/hello run where # -C applies to vp run as well", + "cd packages/hello && vp run where # equivalent cd form for run", + "vp -C packages/missing build # missing directory errors", + "vp pack packages/hello # positional stays a tsdown entry resolved from the invocation directory", + "ls dist # upstream semantics: output lands at the invocation directory, not in the package" + ] +} diff --git a/packages/cli/snap-tests/command-default-package-missing/package.json b/packages/cli/snap-tests/command-default-package-missing/package.json new file mode 100644 index 0000000000..fb8928c6d7 --- /dev/null +++ b/packages/cli/snap-tests/command-default-package-missing/package.json @@ -0,0 +1,5 @@ +{ + "name": "command-default-package-missing", + "version": "1.0.0", + "type": "module" +} diff --git a/packages/cli/snap-tests/command-default-package-missing/snap.txt b/packages/cli/snap-tests/command-default-package-missing/snap.txt new file mode 100644 index 0000000000..c9757b7117 --- /dev/null +++ b/packages/cli/snap-tests/command-default-package-missing/snap.txt @@ -0,0 +1,2 @@ +[1]> vp build # defaultPackage pointing at a missing directory errors +error: defaultPackage points to a missing directory: ./packages/nope diff --git a/packages/cli/snap-tests/command-default-package-missing/steps.json b/packages/cli/snap-tests/command-default-package-missing/steps.json new file mode 100644 index 0000000000..7624bca898 --- /dev/null +++ b/packages/cli/snap-tests/command-default-package-missing/steps.json @@ -0,0 +1,3 @@ +{ + "commands": ["vp build # defaultPackage pointing at a missing directory errors"] +} diff --git a/packages/cli/snap-tests/command-default-package-missing/vite.config.ts b/packages/cli/snap-tests/command-default-package-missing/vite.config.ts new file mode 100644 index 0000000000..8204c22024 --- /dev/null +++ b/packages/cli/snap-tests/command-default-package-missing/vite.config.ts @@ -0,0 +1,3 @@ +export default { + defaultPackage: './packages/nope', +}; diff --git a/packages/cli/snap-tests/command-default-package/package.json b/packages/cli/snap-tests/command-default-package/package.json new file mode 100644 index 0000000000..f633b65741 --- /dev/null +++ b/packages/cli/snap-tests/command-default-package/package.json @@ -0,0 +1,8 @@ +{ + "name": "command-default-package", + "version": "1.0.0", + "workspaces": [ + "packages/*" + ], + "type": "module" +} diff --git a/packages/cli/snap-tests/command-default-package/packages/hello/package.json b/packages/cli/snap-tests/command-default-package/packages/hello/package.json new file mode 100644 index 0000000000..5ff9801f10 --- /dev/null +++ b/packages/cli/snap-tests/command-default-package/packages/hello/package.json @@ -0,0 +1,6 @@ +{ + "name": "hello", + "version": "1.0.0", + "type": "module", + "main": "src/index.ts" +} diff --git a/packages/cli/snap-tests/command-default-package/packages/hello/src/index.ts b/packages/cli/snap-tests/command-default-package/packages/hello/src/index.ts new file mode 100644 index 0000000000..905c7a9bbb --- /dev/null +++ b/packages/cli/snap-tests/command-default-package/packages/hello/src/index.ts @@ -0,0 +1,3 @@ +export function hello(name: string): string { + return `hello ${name}`; +} diff --git a/packages/cli/snap-tests/command-default-package/snap.txt b/packages/cli/snap-tests/command-default-package/snap.txt new file mode 100644 index 0000000000..a3519bf807 --- /dev/null +++ b/packages/cli/snap-tests/command-default-package/snap.txt @@ -0,0 +1,10 @@ +> vp pack # bare pack at the root follows defaultPackage +note: vp pack: using ./packages/hello (defaultPackage) +ℹ entry: src/index.ts +ℹ Build start +ℹ dist/index.mjs kB │ gzip: kB +ℹ 1 files, total: kB +✔ Build complete in ms + +> ls packages/hello/dist # output lands in the configured package +index.mjs diff --git a/packages/cli/snap-tests/command-default-package/steps.json b/packages/cli/snap-tests/command-default-package/steps.json new file mode 100644 index 0000000000..1c13e7a826 --- /dev/null +++ b/packages/cli/snap-tests/command-default-package/steps.json @@ -0,0 +1,6 @@ +{ + "commands": [ + "vp pack # bare pack at the root follows defaultPackage", + "ls packages/hello/dist # output lands in the configured package" + ] +} diff --git a/packages/cli/snap-tests/command-default-package/vite.config.ts b/packages/cli/snap-tests/command-default-package/vite.config.ts new file mode 100644 index 0000000000..dcfe02f744 --- /dev/null +++ b/packages/cli/snap-tests/command-default-package/vite.config.ts @@ -0,0 +1,3 @@ +export default { + defaultPackage: './packages/hello', +}; diff --git a/packages/cli/src/bin.ts b/packages/cli/src/bin.ts index ab86d07e83..e3b782e18c 100644 --- a/packages/cli/src/bin.ts +++ b/packages/cli/src/bin.ts @@ -10,6 +10,7 @@ * If no local installation is found, this global dist/bin.js is used as fallback. */ +import fs from 'node:fs'; import path from 'node:path'; import { run } from '../binding/index.js'; @@ -38,6 +39,28 @@ function getErrorMessage(err: unknown): string { // Parse command line arguments let args = process.argv.slice(2); +// Global `-C ` flag: run as if vp was started in . The global Rust +// CLI parses this itself and spawns bin.js with the target cwd already set; +// this branch covers direct local-bin invocations (`pnpm exec vp -C ...`). +// Accepts `-C dir`, `-Cdir`, and `-C=dir`, matching the clap grammar. +if (args[0]?.startsWith('-C')) { + const inline = args[0].length > 2; + const dir = inline ? args[0].slice(args[0][2] === '=' ? 3 : 2) : args[1]; + if (!dir) { + errorMsg('-C requires a directory argument'); + process.exit(1); + } + const target = path.resolve(dir); + const stat = fs.statSync(target, { throwIfNoEntry: false }); + if (!stat?.isDirectory()) { + errorMsg(`directory not found: ${dir}`); + process.exit(1); + } + process.chdir(target); + args = args.slice(inline ? 1 : 2); + process.argv = process.argv.slice(0, 2).concat(args); +} + // Transform `vp help [command]` into `vp [command] --help` if (args[0] === 'help' && args[1]) { args = [args[1], '--help', ...args.slice(2)]; diff --git a/packages/cli/src/define-config.ts b/packages/cli/src/define-config.ts index 9b3065b723..e67bc84f76 100644 --- a/packages/cli/src/define-config.ts +++ b/packages/cli/src/define-config.ts @@ -53,6 +53,15 @@ declare module '@voidzero-dev/vite-plus-core' { pack?: PackUserConfig | PackUserConfig[]; + /** + * Default target directory for `vp dev` / `build` / `preview` / `pack` + * when invoked bare in the directory containing this config (an implicit + * `vp -C `). Relative to the config file's directory. Must be a + * static string literal: vp reads it without executing the config, so it + * also works at roots without a vite-plus install. + */ + defaultPackage?: string; + run?: RunConfig; staged?: StagedConfig; diff --git a/rfcs/cwd-flag.md b/rfcs/cwd-flag.md new file mode 100644 index 0000000000..9b69124230 --- /dev/null +++ b/rfcs/cwd-flag.md @@ -0,0 +1,371 @@ +# RFC: Global `-C` Flag for Working-Directory Switching + +## Summary + +Add a global `-C ` flag to vp, then use it to fix the app-command experience in monorepos. Everything is additive and backward compatible: + +1. **`-C ` global flag** (the feature): for every vp command, `vp -C ` behaves exactly like `cd && vp `, following the `git -C` / `make -C` convention: the first-class "run there" form vp currently lacks. Positional semantics stay untouched: `vp dev ` keeps upstream Vite semantics (`root` only), and `vp pack` positionals stay tsdown entries. +2. **App-command UX built on `-C`**: running `vp dev` / `vp build` / `vp preview` / `vp pack` bare at a workspace root elicits the missing target instead of silently running against the root: an interactive fuzzy package picker in a TTY, a `defaultPackage` config for repos with one blessed target, and a clear listing plus exit 1 when non-interactive. All three are defined as an implicit `-C `. + +In the common flows users never type `-C`: bare `vp dev` at the root goes through the picker or `defaultPackage`, and inside a package it runs there as today. `-C` is the explicit, teachable form underneath. The commands stay singular: `vp dev` still starts exactly one Vite dev server in one directory. Running a task across many packages at once remains the job of `vp run` (`-r`, `--filter`). + +## Motivation + +### Current Pain Points + +**1. vp has no first-class "run this command in that directory" form.** + +For `dev`/`build`/`preview`, the positional is forwarded verbatim to Vite's `[root]`, which re-bases config lookup and `.env` loading, but `process.cwd()` of the Vite process stays at the invocation directory. Any cwd-relative read in a config or plugin diverges even though `root` points at the right app: + +```ts +// apps/admin/vite.config.ts +const cert = fs.readFileSync(path.resolve('certs/dev.pem')); // cwd-relative +``` + +``` +$ cd apps/admin && vp dev # cwd = apps/admin, cert found + + VITE+ v0.2.2 + + ➜ Local: http://localhost:5173/ + +$ vp dev apps/admin # root is right, cwd is still the repo root +failed to load config from /acme/apps/admin/vite.config.ts +error when starting dev server: +Error: ENOENT: no such file or directory, open '/acme/certs/dev.pem' +``` + +For `pack`, directories do not work at all: the positional means entry files/globs (`packages/cli/src/pack-bin.ts`) and config always resolves from `process.cwd()`: + +``` +$ vp pack packages/ui +ℹ entry: packages/ui +ℹ Build start +error: Build failed with 1 error: + +[UNRESOLVED_ENTRY] Cannot resolve entry module packages/ui. +``` + +So the only form that works reliably, uniformly, for every command, is `cd && vp `, and vp offers no flag equivalent of it. + +**2. At a monorepo root, the app commands are silently wrong.** + +The workspace root usually has no app, but `vp dev` happily starts a server pointed at it: + +``` +$ vp dev + + VITE+ v0.2.2 + + ➜ Local: http://localhost:5173/ # opens to a 404, no index.html here +``` + +Nothing errors, nothing guides the user toward the right invocation, and the server exposes the whole repository tree. Fixing this requires eliciting a target, and eliciting a target requires a well-defined primitive to expand to. `-C` is that primitive. + +All of the failures above are reproducible with `vite-plus@0.2.2`: https://github.com/why-reproductions-are-required/vite-plus-monorepo-app-commands-repro + +## Proposed UX + +Example workspace used throughout: + +``` +acme/ +├── pnpm-workspace.yaml +├── vite.config.ts +├── apps/web (Vite app) +├── apps/admin (Vite app) +├── packages/ui (library) +└── packages/utils (library) +``` + +### 1. `-C`: run any vp command in another directory + +These do the same thing, byte for byte: + +```bash +vp -C apps/admin dev +cd apps/admin && vp dev +``` + +It is not limited to the app commands: + +```bash +vp -C apps/web test +vp -C apps/web run build +``` + +Args after the subcommand pass through unchanged: + +``` +$ vp -C apps/admin dev --port 4000 + + VITE+ v0.2.2 + + ➜ Local: http://localhost:4000/ +``` + +And `-C` gives pack its missing directory form: + +``` +$ vp -C packages/ui pack +ℹ entry: src/index.ts +ℹ Build start +ℹ dist/index.mjs 0.10 kB │ gzip: 0.11 kB +✔ Build complete in 9ms +``` + +`vp dev apps/admin` (the positional) is untouched: `root` is set, cwd is not, so the pain point 1 pitfall remains on that form (see Decisions). + +### 2. `vp dev` at the workspace root (interactive terminal) + +Same look and keybindings as the `vp run` task selector, listing packages instead of tasks: + +``` +$ vp dev +Select a package to dev (↑/↓, Enter to run, type to search): + + › web apps/web + admin apps/admin + ui packages/ui + utils packages/utils +``` + +Typing filters fuzzily, with the query shown inline: + +``` +Select a package to dev (↑/↓, Enter to run, type to search): adm + + › admin apps/admin +``` + +Enter confirms, prints the teaching hint once, then runs as an implicit `-C`: + +``` +Selected package: admin (apps/admin) +Tip: run this directly with `vp -C apps/admin dev` + + VITE+ v0.2.2 + + ➜ Local: http://localhost:5173/ + ➜ Network: use --host to expose +``` + +Escape clears the search, Ctrl+C cancels with exit code 130 and runs nothing (matching the task picker). `vp build`, `vp preview`, and `vp pack` at the root look the same, with `Select a package to build` / `preview` / `pack`. + +### 3. Non-interactive at the root (CI, piped output, scripts) + +No picker can appear, so the command fails fast with the same information the picker would have shown: + +``` +$ vp build +✗ `vp build` at the workspace root needs a target package. + + Packages in this workspace: + web apps/web + admin apps/admin + ui packages/ui + utils packages/utils + + Pass a directory: vp -C apps/web build + Or run every package's build script: vp run -r build + +$ echo $? +1 +``` + +### 4. With `defaultPackage` configured + +The motivating repo shape is a framework monorepo where the Vite app lives in a subdirectory of a repo that is not a JS workspace at all, for example a Laravel, Rails, or Go server with a `frontend/` directory: + +``` +shop/ +├── app/ (PHP / Ruby / Go) +├── routes/ +├── composer.json +├── vite.config.ts (root config below) +└── frontend/ (the Vite app) +``` + +There is no `pnpm-workspace.yaml` or `workspaces` field to enumerate, so the picker cannot serve this shape. `defaultPackage` can: + +```ts +// vp reads this key via static extraction and never executes this file, so +// the missing vite-plus install at this root is fine. Vite never loads this +// config either; at this root it is purely a pointer for vp. +export default { + defaultPackage: './frontend', +}; +``` + +Bare app commands at the root now behave as `vp -C ./frontend `, with one line of output so it never feels magical: + +``` +$ vp dev +vp dev: using ./frontend (defaultPackage) + + VITE+ v0.2.2 + + ➜ Local: http://localhost:5173/ +``` + +An explicit `-C` still wins: `vp -C apps/admin dev` ignores `defaultPackage`. + +### 5. Inside a sub-package: nothing changes + +``` +$ cd apps/web +$ vp dev + + VITE+ v0.2.2 + + ➜ Local: http://localhost:5173/ +``` + +No picker ever appears below the root. + +## Command Syntax + +``` +vp [-C ] [args...] +``` + +### The `-C ` global flag + +- A vp-global flag, parsed before the subcommand like `git -C` / `make -C`, never forwarded to the underlying tool. It works with every vp command. +- Semantics: run the command exactly as if invoked in ``. The directory is resolved against the invocation cwd; a missing directory errors with `directory not found`. +- The name follows pnpm: its global `-C ` is documented as "Run as if pnpm was started in `` instead of the current working directory", which is this flag's semantics verbatim. Short form only in v1 (git style); pnpm's `--dir` long alias can be added compatibly later if wanted. +- Because it sits before the subcommand, it cannot collide with Vite or tsdown flags, present or future. The subcommands themselves gain zero flags. + +### Positionals and forwarded args: unchanged + +Everything after the subcommand is forwarded verbatim, exactly as today. `vp dev ` keeps upstream Vite semantics (positional = `root` option), `vp pack` positionals stay tsdown entries, and relative option values keep resolving against the process cwd (the invocation directory, or `` under `-C`). There is no directory-vs-entry disambiguation anywhere. + +Rejected alternatives: repurposing the app-command positional to mean "run there" (breaks Vite CLI parity; see Decisions), a per-command picker-forcing flag, and `-F`-style name filters (`-F` already has other meanings on `pack` and `run`/`exec`). + +## Behavior + +### Target directory resolution + +An app command invocation is **bare** when it has no `-C` and no positional target (no Vite `[root]`, no pack entries); flags alone keep it bare. For `vp dev` / `build` / `preview` / `pack`, the target directory is resolved in this order: + +1. **`-C `**: run there. Never triggers the picker. +2. **Positional target present**: forward as today, upstream semantics, vp does not interfere. +3. **`defaultPackage`**, when bare in the directory containing the root config (a workspace root, or the root of a non-workspace repo): implicit `-C`, print a one-line note. +4. **Interactive picker**, when bare at the workspace root in an interactive TTY (and not CI): pick, print hint, run as implicit `-C`. +5. **Non-interactive and bare at the workspace root**: print the package list and the `-C` hint, exit 1. +6. **Anywhere else**: current behavior, run in the current directory. + +"Workspace root" means the current directory's package is the workspace root package, as determined by `vite_workspace::find_workspace_root` (already called on every invocation in `packages/cli/binding/src/cli/mod.rs`). + +### Equivalence invariant + +For every vp command: + +``` +vp -C [args...] === cd && vp [args...] +``` + +The child's spawn cwd is ``, so config lookup, `.env` loading, `process.cwd()` reads in configs and plugins, and relative CLI args all behave as if the user had `cd`'d. The Rust layers never mutate their own cwd; the one exception is the local `vp` bin, which applies `-C` by changing its process cwd at startup before any dispatch, indistinguishable from having been started in ``. + +The global binary also resolves the local `vite-plus` install from ``, matching `cd` exactly; through the package's own `vp` bin the executing CLI is already chosen, so there the invariant assumes a single Vite+ version per workspace (the supported monorepo model). + +### Entry points and version assumption + +- `-C` is parsed by both the global binary and the local bin; the picker and `defaultPackage` live in the local CLI's NAPI binding (`execute_direct_subcommand`), which every entry point executes. Bare `vp dev` at a root is primarily a global-CLI experience, but a root-level `"dev": "vp dev"` script flows through the same logic. +- Pre-1.0, both the global CLI and any local install are assumed to ship this feature; no version negotiation with older CLIs is specified. In the non-workspace shape the root has no local install, so the bundled CLI executes end to end, which is equivalent under this assumption. + +### Picker contents + +- One row per workspace package: name plus relative path. Nothing is filtered out; packages that look runnable for the command (`vite.config.*` or `index.html` for `dev`/`build`/`preview`, a pack config or library entry for `pack`) rank first, then by path, so apps surface at the top while everything stays searchable. +- Fuzzy search over name and path via `vite_select::fuzzy_match`, paging identical to the task picker. +- A runnable workspace root appears as a `(workspace root)` entry, keeping today's "run at root" behavior one keystroke away. +- With exactly one likely-runnable package, the picker auto-selects it, printing only the `Selected package:` line and the tip. + +### `defaultPackage` config + +```ts +export default defineConfig({ + // Relative to the config file's directory. Used by vp dev/build/preview/pack + // when invoked bare next to this config: an implicit -C. + defaultPackage: './frontend', +}); +``` + +- Type: `string`, a single directory. A per-command map can come later if real demand appears. +- Consulted when a bare app command runs in the directory containing the root config: a workspace root, or a non-workspace repo root. The non-workspace shape has no package list, so `defaultPackage` is the only mechanism that covers it. An explicit `-C` always wins. +- A missing directory errors: `defaultPackage points to a missing directory: ./frontend`. +- Read via static extraction (`vite_static_config` + the loader in `packages/cli/binding/src/cli/handler.rs`), like `run` config. At a non-workspace root there is no install to execute the config, so the file must work unexecuted: a plain default-export object with a static string value. If extraction fails and no local install can execute the config, vp errors and names the offending construct. + +## Decisions + +### Vite CLI parity preserved; `-C` carries the `cd` semantics + +The core tension: parity with `vite ` (positional sets `root` only, cwd untouched) and parity with `cd && vp dev` cannot both hold on the same positional. An earlier draft repurposed the positional and accepted a permanent divergence from the upstream CLI. This RFC keeps the positional fully Vite-compatible and puts the `cd` semantics on a new, explicitly named channel instead. Nothing existing changes meaning, pack needs no directory-vs-entry heuristic, and the primitive generalizes to every vp command instead of four. + +The accepted cost: two ways to pass a directory with different semantics. Mitigation: users rarely type either (bare `vp dev` plus picker or `defaultPackage` covers the common flows), and every hint, error, and doc teaches only `-C`. + +Mechanism: `process.chdir()` in the CLI process was rejected as a global mutation that leaks into everything sharing the process. vp is a launcher: the NAPI binding always spawns the tool as a fresh child (`packages/cli/binding/src/cli/execution.rs`), so the child's spawn cwd is free to set, with no upstream change. + +### Root-only interactivity + +Below the root the cwd already identifies the project, so prompting would be noise. At the root the command is ambiguous and silently wrong today; that is where a prompt earns its keep. Unlike bare `vp run`'s informational listing, the app commands exit 1 when non-interactive, because building or serving the wrong directory is worse than failing loudly. + +### Elicitation scope + +`-C` is global and works with every command. The elicitation behaviors (picker, `defaultPackage`, root error) apply only to the single-target app commands, because only they are ambiguous at the root. Tree-scoped commands (`test`, `lint`, `fmt`, `check`) mean "the whole repo" there, which is their desired behavior. Workspace-state commands (`install`, `add`, `outdated`, ...) have the root as their natural home. Orchestrators (`run`, `exec`) own their selection models and remain the way to run one task across many packages. A future command joins the elicitation set exactly when its subject is one package directory. + +## Implementation Architecture + +All changes live in the Rust layers; no upstream Vite or tsdown changes are required. + +- `crates/vite_global_cli/src/cli.rs`: parse the global `-C `; resolve the local install from `` and delegate with `` as the effective cwd. +- `packages/cli/binding/src/cli/types.rs` / `mod.rs`: parse `-C` on the local bin path; in `execute_direct_subcommand`, add the bare-invocation resolution order (workspace-root detection already happens here). +- `packages/cli/binding/src/cli/execution.rs`: spawn the child with cwd set to the target directory. +- Picker: reuse `vite_select` and `vite_workspace`, both already dependencies via the `vite_task` crates. +- `defaultPackage`: extend the `VitePlusConfigLoader` static extraction the same way `run` config is loaded, and add `defaultPackage?: string` to `packages/cli/src/define-config.ts`. +- `packages/cli/src/pack-bin.ts` needs no change: positional handling is untouched and `-C` never reaches it. +- Docs: a `-C` entry in the global CLI docs, `docs/guide/monorepo.md` "App Commands", and a `docs/config/` page for the new key. + +## Compatibility + +Every existing invocation is unchanged. The only behavior change is the bare app command at a workspace root, which goes from "silently serve or build the root" to picker / config / clear error. A runnable root stays available as a picker entry, and `defaultPackage: '.'` restores the old behavior unconditionally. + +## Snap Tests + +Non-interactive branches are covered by snap tests: + +- `vp -C build` / `vp -C pack` / `vp -C run `, plus `-C` with a missing directory. +- Parity regression: `vp dev ` still forwards the positional as Vite `root` with cwd untouched. +- Bare app commands at a workspace root without a TTY: package listing and exit code. +- `defaultPackage`: happy path and missing-directory error. +- Equivalence checks: `vp -C build` and `cd && vp build` produce the same output in a fixture whose config reads `process.cwd()`. + +The interactive picker gets pty snapshot coverage in the `vite_task` repo style (`task_select` fixtures) if the picker lands near `vite_select`, or manual verification via tmux-driven interactive runs otherwise. + +## Open Questions + +1. Does ranking plus search suffice, or is outright filtering of non-runnable packages ever wanted? +2. Add a `VP_DEFAULT_PACKAGE` env override later? Env companions are an established pattern (`NX_DEFAULT_PROJECT`); deferred from v1. +3. Should `vp test` join the elicitation set? Probably not: Vitest already has first-class `projects` semantics at the root (`-C` works with it regardless). +4. Exact non-interactive gate: the `vp run` picker's TTY check plus the `CI` check used by the global command picker? +5. Should `vp dev ` print a one-line tip pointing at `vp -C dev`, or would that be noise on a fully supported upstream form? + +## Appendix: Naming Survey for `defaultPackage` + +How comparable tools name "the member a root-level command targets when none is specified": + +| Tool | Field | Notes | +| -------------------------- | ------------------------------------ | ---------------------------------------------------- | +| Ionic CLI | `defaultProject` | active; root config with a `projects` map | +| Nx | `defaultProject` | deprecated in favor of `NX_DEFAULT_PROJECT` env var | +| Angular CLI | `defaultProject` | deprecated in favor of cwd inference | +| Cargo | `workspace.default-members` | plural: root `cargo build` builds all listed members | +| Salesforce DX | `default: true` on the member | marker pattern; needs member enumeration | +| Vercel / Netlify / Amplify | `rootDirectory` / `base` / `appRoot` | per-app deploy config, not a default among many | +| GitHub Actions | `defaults.run.working-directory` | names the mechanism (cwd) | + +The pattern is `default` plus the tool's own noun for the unit: Angular, Nx, and Ionic say "project", Cargo says "members", Salesforce says "package directories". vp's noun is "package" (the picker, `vp run` docs, `vite_workspace`, pnpm vocabulary), hence `defaultPackage`. + +Rejected: `defaultProject` (collides with Vitest `test.projects`, and the picker says "package"), `defaultWorkspace` ("workspace" means the whole monorepo in vp/pnpm vocabulary), `defaultMembers` (plural, implies running in many packages; meaningless without a workspace), `appRoot`/`rootDirectory`/`base` (collide with Vite's `root`/`base` options), member markers (need enumeration, impossible without workspace metadata). The Angular and Nx deprecations do not transfer: cwd inference is built into the resolution order, and per-environment flexibility is open question 2. + +The `-C` scheme does not change this conclusion. Tools with `-C`-style flags (git, make, tar, ninja, terraform, pnpm, yarn, bun) ship the flag with no config-file default at all, and tools that do have a directory config name it after the mechanism precisely because it applies to everything they run (just's `set working-directory`, GitHub Actions' `defaults.run.working-directory`, per-task `cwd` in vp's own `run.tasks`). `defaultPackage` is neither: it selects a member, only for the app commands, only when bare at the root. A mechanism name like `defaultCwd` or `defaultDir` would promise vp-wide effect it does not have; the member-selection name matches its member-selection scope.