Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"name": "command-global-npm-alias"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[[case]]
name = "command_global_npm_alias"
vp = "global"
skip-platforms = ["windows"]
steps = [
{ argv = ["vp", "install", "-g", "testnpm2-alias@npm:testnpm2@1.0.0"], comment = "should prepare a version-pinned npm alias", snapshot = false },
{ argv = ["vp", "list", "-g"], comment = "should list the alias with its aliased package" },
{ argv = ["vp", "outdated", "testnpm2-alias", "-g", "--format", "json"], comment = "should resolve versions of the aliased package", continue-on-failure = true },
{ tty = false, argv = ["vp", "update", "-g"], comment = "should keep a pinned alias in place" },
{ tty = false, argv = ["vp", "update", "-g", "testnpm2-alias", "--latest"], comment = "should update the aliased package instead of a package named after the alias" },
{ argv = ["vpt", "grep-file", "$VP_HOME/packages/testnpm2-alias.json", 'versionSpec": "npm:testnpm2"'], comment = "should keep the alias after --latest drops the pin" },
{ argv = ["vp", "list", "-g"] },
]
after = [
{ argv = ["vp", "remove", "-g", "testnpm2-alias"], continue-on-failure = true },
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# command_global_npm_alias

## `vp install -g testnpm2-alias@npm:testnpm2@1.0.0`

should prepare a version-pinned npm alias


## `vp list -g`

should list the alias with its aliased package

```
Package Node version Binaries
--- --- ---
testnpm2-alias@npm:testnpm2@1.0.0 <version>
```

## `vp outdated testnpm2-alias -g --format json`

should resolve versions of the aliased package

**Exit code:** 1

```
{
"testnpm2-alias": {
"current": "testnpm2@1.0.0",
"wanted": "testnpm2@1.0.0",
"latest": "testnpm2@1.0.1",
"dependent": "global",
"location": "<home>/.vite-plus/packages/testnpm2-alias/<uuid>/lib/node_modules/testnpm2-alias"
}
}
```

## `vp update -g`

should keep a pinned alias in place

```
All global packages are up to date.
```

## `vp update -g testnpm2-alias --latest`

should update the aliased package instead of a package named after the alias

```
info: Updating 1 global package with Node.js <version>
Updated testnpm2-alias to 1.0.1
```

## `vpt grep-file $VP_HOME/packages/testnpm2-alias.json 'versionSpec": "npm:testnpm2"'`

should keep the alias after --latest drops the pin

```
<home>/.vite-plus/packages/testnpm2-alias.json: found "versionSpec\": \"npm:testnpm2\""
```

## `vp list -g`

```
Package Node version Binaries
--- --- ---
testnpm2-alias@npm:testnpm2@1.0.1 <version>
```
22 changes: 15 additions & 7 deletions crates/vp_global_cli/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -888,13 +888,17 @@ async fn managed_update(
current_node_version = get_current_node_version().await?;

for metadata in &all {
if latest && metadata.version_spec.is_some() {
spec_rewrites.push((metadata.name.clone(), None, metadata.name.clone()));
if latest && metadata.version_spec != metadata.latest_version_spec() {
spec_rewrites.push((
metadata.name.clone(),
metadata.latest_version_spec(),
metadata.latest_spec(),
));
}
if !is_same_node_version(&metadata.platform.node, &current_node_version) {
node_mismatches.push(NodeMismatchPackage {
name: metadata.name.clone(),
spec: if latest { metadata.name.clone() } else { metadata.update_spec() },
spec: if latest { metadata.latest_spec() } else { metadata.update_spec() },
installed_node: metadata.platform.node.clone(),
});
}
Expand Down Expand Up @@ -922,17 +926,21 @@ async fn managed_update(
if new_spec != metadata.version_spec {
spec_rewrites.push((package_name.clone(), new_spec, package.clone()));
}
} else if latest && metadata.version_spec.is_some() {
} else if latest && metadata.version_spec != metadata.latest_version_spec() {
// `--latest` applies to bare names only; explicit specs win.
spec_rewrites.push((package_name.clone(), None, package_name.clone()));
spec_rewrites.push((
package_name.clone(),
metadata.latest_version_spec(),
metadata.latest_spec(),
));
}
if !is_same_node_version(&metadata.platform.node, &current_node_version) {
// Match the spec `get_outdated_packages` resolves for this
// package, so the dedup against outdated results holds.
let spec = if version_spec.is_some() {
package.clone()
} else if latest {
package_name.clone()
metadata.latest_spec()
} else {
metadata.update_spec()
};
Expand Down Expand Up @@ -971,7 +979,7 @@ async fn managed_update(
// A newer `latest` alone (e.g. a version-pinned package) is not
// updatable; only a newer wanted version is.
.filter(|package| package.wanted != package.current)
.map(|package| package.spec.unwrap_or(package.name)),
.map(|package| package.spec),
);

let outdated_specs = to_update.iter().map(String::as_str).collect::<HashSet<_>>();
Expand Down
46 changes: 43 additions & 3 deletions crates/vp_global_cli/src/commands/env/package_metadata.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use uuid::{Uuid, Version};
use vt_path::AbsolutePathBuf;

use super::config::get_packages_dir;
use crate::error::Error;
use crate::{commands::global, error::Error};

// This is legacy, for old Vite+ version's compatibility
const LEGACY_INSTALL_ID_PREFIX: char = '#';
Expand Down Expand Up @@ -42,8 +42,9 @@ pub struct PackageMetadata {
#[serde(default)]
pub js_bins: HashSet<String>,
/// Version spec the package was installed with (a dist-tag like
/// `nightly`, a range, or an exact version), so `vp update -g` keeps
/// resolving within it. `None` means the implicit `latest` tag.
/// `nightly`, a range, an exact version, or an npm alias like
/// `npm:other@^1`), so `vp update -g` keeps resolving within it.
/// `None` means the implicit `latest` tag.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub version_spec: Option<String>,
/// Package manager used for installation (npm, yarn, pnpm)
Expand Down Expand Up @@ -96,6 +97,25 @@ impl PackageMetadata {
}
}

/// Registry package installed under this name, when it is an npm alias.
pub fn alias_target(&self) -> Option<String> {
self.version_spec.as_deref().and_then(global::alias_target)
}

/// Version spec that remains once `--latest` drops the recorded one:
/// an npm alias keeps its target, everything else falls back to `latest`.
pub fn latest_version_spec(&self) -> Option<String> {
self.alias_target().map(|target| format!("npm:{target}"))
}

/// Registry spec for the `latest` dist-tag of the installed package.
pub fn latest_spec(&self) -> String {
match self.latest_version_spec() {
Some(spec) => format!("{}@{spec}", self.name),
None => self.name.clone(),
}
}

/// Check if a binary requires Node.js to run.
pub fn is_js_binary(&self, bin_name: &str) -> bool {
self.js_bins.contains(bin_name)
Expand Down Expand Up @@ -293,6 +313,26 @@ mod tests {

metadata.version_spec = Some("^1.0.0".to_string());
assert_eq!(metadata.update_spec(), "some-pkg@^1.0.0");
assert_eq!(metadata.latest_spec(), "some-pkg");
}

#[test]
fn test_npm_alias_specs_keep_the_alias_target() {
let mut metadata = PackageMetadata::new(
"typescript".to_string(),
"1.5.0".to_string(),
"22.0.0".to_string(),
None,
vec![],
HashSet::new(),
"npm".to_string(),
);
metadata.version_spec = Some("npm:cowsay@^1.5".to_string());

assert_eq!(metadata.alias_target().as_deref(), Some("cowsay"));
assert_eq!(metadata.update_spec(), "typescript@npm:cowsay@^1.5");
assert_eq!(metadata.latest_version_spec().as_deref(), Some("npm:cowsay"));
assert_eq!(metadata.latest_spec(), "typescript@npm:cowsay");
}

#[test]
Expand Down
70 changes: 66 additions & 4 deletions crates/vp_global_cli/src/commands/global/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,13 @@ impl NpmRegistry {
}

async fn latest_package_version(&self, package_spec: &str) -> Result<String, Error> {
let output = npm_view(&self.npm_path, &self.node_bin_dir, package_spec, "version").await?;
let output = npm_view(
&self.npm_path,
&self.node_bin_dir,
&registry_query_spec(package_spec),
"version",
)
.await?;

parse_npm_view_version(&output)
}
Expand Down Expand Up @@ -170,14 +176,23 @@ pub(crate) fn parse_package_spec(spec: &str) -> Result<(String, Option<String>),

/// Return the version part of a registry package spec that update flows
/// should keep resolving within: a dist-tag (e.g. `nightly` in
/// `some-pkg@nightly`), a range, or an exact version. The implicit `latest`
/// tag and non-registry version parts (URLs, aliases) yield `None`.
/// `some-pkg@nightly`), a range, an exact version, or an npm alias
/// (`npm:other` / `npm:other@^1`). The implicit `latest` tag and other
/// non-registry version parts (URLs, git, tarballs) yield `None`.
pub(crate) fn update_version_spec(spec: &str) -> Option<String> {
if is_local_package_spec(spec) {
return None;
}
let (_, version_spec) = parse_package_spec(spec).ok()?;
let version_spec = version_spec?;
// Keep the alias so updates reinstall the aliased package, not one named after the alias.
if let Some(target) = version_spec.strip_prefix("npm:") {
let target_name = alias_target(&version_spec)?;
return Some(match update_version_spec(target) {
Some(target_spec) => format!("npm:{target_name}@{target_spec}"),
None => format!("npm:{target_name}"),
});
}
if version_spec.is_empty()
|| version_spec == "latest"
|| version_spec.contains(':')
Expand All @@ -193,6 +208,26 @@ pub(crate) fn update_version_spec(spec: &str) -> Option<String> {
}
}

/// Package name behind an npm alias version part (`npm:<target>[@<spec>]`).
pub(crate) fn alias_target(version_spec: &str) -> Option<String> {
let target = version_spec.strip_prefix("npm:")?;
if is_local_package_spec(target) {
return None;
}
parse_package_spec(target).ok().map(|(name, _)| name).filter(|name| !name.is_empty())
}

/// `npm view` rejects alias specs, so query the aliased package itself.
fn registry_query_spec(spec: &str) -> String {
if !is_local_package_spec(spec)
&& let Ok((_, Some(version_spec))) = parse_package_spec(spec)
&& let Some(target) = version_spec.strip_prefix("npm:")
{
return target.to_string();
}
spec.to_string()
}

fn resolve_local_package_path(spec: &str) -> Result<AbsolutePathBuf, Error> {
let path_spec = spec.strip_prefix("file:").unwrap_or(spec);
let path = std::path::Path::new(path_spec);
Expand Down Expand Up @@ -371,10 +406,37 @@ mod tests {
fn update_version_spec_ignores_non_registry_specs() {
assert_eq!(update_version_spec("./local-pkg"), None);
assert_eq!(update_version_spec("file:../pkg"), None);
assert_eq!(update_version_spec("some-pkg@npm:other@1.0.0"), None);
assert_eq!(update_version_spec("some-pkg@github:user/repo"), None);
assert_eq!(update_version_spec("some-pkg@archive.tgz"), None);
assert_eq!(update_version_spec("some-pkg@archive.tar.gz"), None);
assert_eq!(update_version_spec("some-pkg@archive.tar"), None);
}

#[test]
fn update_version_spec_keeps_npm_aliases() {
assert_eq!(update_version_spec("typescript@npm:cowsay"), Some("npm:cowsay".to_string()));
assert_eq!(
update_version_spec("typescript@npm:cowsay@latest"),
Some("npm:cowsay".to_string())
);
assert_eq!(
update_version_spec("typescript@npm:cowsay@^1.5"),
Some("npm:cowsay@^1.5".to_string())
);
assert_eq!(
update_version_spec("@scope/alias@npm:@types/node@20"),
Some("npm:@types/node@20".to_string())
);
assert_eq!(update_version_spec("some-pkg@npm:"), None);
assert_eq!(update_version_spec("some-pkg@npm:./local"), None);
}

#[test]
fn registry_query_spec_resolves_npm_aliases() {
assert_eq!(registry_query_spec("typescript@npm:cowsay"), "cowsay");
assert_eq!(registry_query_spec("typescript@npm:cowsay@^1.5"), "cowsay@^1.5");
assert_eq!(registry_query_spec("@scope/alias@npm:@types/node@20"), "@types/node@20");
assert_eq!(registry_query_spec("typescript@^5"), "typescript@^5");
assert_eq!(registry_query_spec("typescript"), "typescript");
}
}
Loading
Loading