mirror of
https://github.com/cargo-bins/cargo-binstall.git
synced 2025-04-21 13:08:42 +00:00
Merge pull request #210 from NobodyXu/feature/crate-version
Feature: Support specifing versions via `crate_name@req`
This commit is contained in:
commit
a672f00575
4 changed files with 79 additions and 41 deletions
|
@ -147,8 +147,7 @@ pub enum BinstallError {
|
||||||
///
|
///
|
||||||
/// This may be the case when using the `--version` option.
|
/// This may be the case when using the `--version` option.
|
||||||
///
|
///
|
||||||
/// Note that using `--version 1.2.3` is interpreted as the requirement `^1.2.3` as per
|
/// Note that using `--version 1.2.3` is interpreted as the requirement `=1.2.3`.
|
||||||
/// Cargo.toml rules. If you want the exact version 1.2.3, use `--version '=1.2.3'`.
|
|
||||||
///
|
///
|
||||||
/// - Code: `binstall::version::mismatch`
|
/// - Code: `binstall::version::mismatch`
|
||||||
/// - Exit: 82
|
/// - Exit: 82
|
||||||
|
@ -167,21 +166,15 @@ pub enum BinstallError {
|
||||||
v: semver::Version,
|
v: semver::Version,
|
||||||
},
|
},
|
||||||
|
|
||||||
/// Warning: The resolved version may not be what was meant.
|
/// This occurs when you specified `--version` while also using
|
||||||
///
|
/// form `$crate_name@$ver` tp specify version requirements.
|
||||||
/// This occurs when using the `--version` option with a bare version, like `--version 1.2.3`.
|
#[error("duplicate version requirements")]
|
||||||
/// That is parsed as the semver requirement `^1.2.3`, but the user may have expected that to
|
|
||||||
/// be an exact version (which should be specified with `--version '=1.2.3'`.
|
|
||||||
///
|
|
||||||
/// - Code: `binstall::version::warning`
|
|
||||||
/// - Exit: none (runtime warning only)
|
|
||||||
#[error("version semantic mismatch: {ver} <> {req}")]
|
|
||||||
#[diagnostic(
|
#[diagnostic(
|
||||||
severity(warning),
|
severity(error),
|
||||||
code(binstall::version::warning),
|
code(binstall::version::requirement),
|
||||||
help("You specified `--version {req}` but the package resolved that to '{ver}'.\nUse `--version '={req}'` if you want an exact match.")
|
help("Remove the `--version req` or simply use `$crate_name`")
|
||||||
)]
|
)]
|
||||||
VersionWarning { ver: String, req: String },
|
DuplicateVersionReq,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl BinstallError {
|
impl BinstallError {
|
||||||
|
@ -208,7 +201,7 @@ impl BinstallError {
|
||||||
VersionReq { .. } => 81,
|
VersionReq { .. } => 81,
|
||||||
VersionMismatch { .. } => 82,
|
VersionMismatch { .. } => 82,
|
||||||
VersionUnavailable { .. } => 83,
|
VersionUnavailable { .. } => 83,
|
||||||
VersionWarning { .. } => unimplemented!("BUG: warnings do not terminate"),
|
DuplicateVersionReq => 84,
|
||||||
};
|
};
|
||||||
|
|
||||||
// reserved codes
|
// reserved codes
|
||||||
|
|
|
@ -34,6 +34,9 @@ pub use path_ext::*;
|
||||||
mod tls_version;
|
mod tls_version;
|
||||||
pub use tls_version::TLSVersion;
|
pub use tls_version::TLSVersion;
|
||||||
|
|
||||||
|
mod crate_name;
|
||||||
|
pub use crate_name::CrateName;
|
||||||
|
|
||||||
/// Load binstall metadata from the crate `Cargo.toml` at the provided path
|
/// Load binstall metadata from the crate `Cargo.toml` at the provided path
|
||||||
pub fn load_manifest_path<P: AsRef<Path>>(
|
pub fn load_manifest_path<P: AsRef<Path>>(
|
||||||
manifest_path: P,
|
manifest_path: P,
|
||||||
|
|
39
src/helpers/crate_name.rs
Normal file
39
src/helpers/crate_name.rs
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
use std::convert::Infallible;
|
||||||
|
use std::fmt;
|
||||||
|
use std::str::FromStr;
|
||||||
|
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct CrateName {
|
||||||
|
pub name: String,
|
||||||
|
pub version: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Display for CrateName {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
write!(f, "{}", self.name)?;
|
||||||
|
|
||||||
|
if let Some(version) = &self.version {
|
||||||
|
write!(f, "@{version}")?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FromStr for CrateName {
|
||||||
|
type Err = Infallible;
|
||||||
|
|
||||||
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||||
|
Ok(if let Some((name, version)) = s.split_once('@') {
|
||||||
|
CrateName {
|
||||||
|
name: name.to_string(),
|
||||||
|
version: Some(version.to_string()),
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
CrateName {
|
||||||
|
name: s.to_string(),
|
||||||
|
version: None,
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
53
src/main.rs
53
src/main.rs
|
@ -3,7 +3,6 @@ use std::{
|
||||||
ffi::OsString,
|
ffi::OsString,
|
||||||
path::{Path, PathBuf},
|
path::{Path, PathBuf},
|
||||||
process::{ExitCode, Termination},
|
process::{ExitCode, Termination},
|
||||||
str::FromStr,
|
|
||||||
time::{Duration, Instant},
|
time::{Duration, Instant},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
@ -36,14 +35,14 @@ struct Options {
|
||||||
///
|
///
|
||||||
/// This must be a crates.io package name.
|
/// This must be a crates.io package name.
|
||||||
#[clap(value_name = "crate")]
|
#[clap(value_name = "crate")]
|
||||||
name: String,
|
crate_name: CrateName,
|
||||||
|
|
||||||
/// Semver filter to select the package version to install.
|
/// Semver filter to select the package version to install.
|
||||||
///
|
///
|
||||||
/// This is in Cargo.toml dependencies format: `--version 1.2.3` is equivalent to
|
/// This is in Cargo.toml dependencies format: `--version 1.2.3` is equivalent to
|
||||||
/// `--version "^1.2.3"`. Use `=1.2.3` to install a specific version.
|
/// `--version "^1.2.3"`. Use `=1.2.3` to install a specific version.
|
||||||
#[clap(long, default_value = "*")]
|
#[clap(long)]
|
||||||
version: String,
|
version: Option<String>,
|
||||||
|
|
||||||
/// Override binary target set.
|
/// Override binary target set.
|
||||||
///
|
///
|
||||||
|
@ -237,34 +236,34 @@ async fn entry() -> Result<()> {
|
||||||
.map_err(BinstallError::from)
|
.map_err(BinstallError::from)
|
||||||
.wrap_err("Creating a temporary directory failed.")?;
|
.wrap_err("Creating a temporary directory failed.")?;
|
||||||
|
|
||||||
info!("Installing package: '{}'", opts.name);
|
info!("Installing package: '{}'", opts.crate_name);
|
||||||
|
|
||||||
|
let mut version = match (&opts.crate_name.version, &opts.version) {
|
||||||
|
(Some(version), None) => version.to_string(),
|
||||||
|
(None, Some(version)) => version.to_string(),
|
||||||
|
(Some(_), Some(_)) => Err(BinstallError::DuplicateVersionReq)?,
|
||||||
|
(None, None) => "*".to_string(),
|
||||||
|
};
|
||||||
|
|
||||||
|
if version
|
||||||
|
.chars()
|
||||||
|
.next()
|
||||||
|
.map(|ch| ch.is_ascii_digit())
|
||||||
|
.unwrap_or(false)
|
||||||
|
{
|
||||||
|
version.insert(0, '=');
|
||||||
|
}
|
||||||
|
|
||||||
// Fetch crate via crates.io, git, or use a local manifest path
|
// Fetch crate via crates.io, git, or use a local manifest path
|
||||||
// TODO: work out which of these to do based on `opts.name`
|
// TODO: work out which of these to do based on `opts.name`
|
||||||
// TODO: support git-based fetches (whole repo name rather than just crate name)
|
// TODO: support git-based fetches (whole repo name rather than just crate name)
|
||||||
let manifest = match opts.manifest_path.clone() {
|
let manifest = match opts.manifest_path.clone() {
|
||||||
Some(manifest_path) => load_manifest_path(manifest_path.join("Cargo.toml"))?,
|
Some(manifest_path) => load_manifest_path(manifest_path.join("Cargo.toml"))?,
|
||||||
None => fetch_crate_cratesio(&client, &opts.name, &opts.version).await?,
|
None => fetch_crate_cratesio(&client, &opts.crate_name.name, &version).await?,
|
||||||
};
|
};
|
||||||
|
|
||||||
let package = manifest.package.unwrap();
|
let package = manifest.package.unwrap();
|
||||||
|
|
||||||
let is_plain_version = semver::Version::from_str(&opts.version).is_ok();
|
|
||||||
if is_plain_version && package.version != opts.version {
|
|
||||||
warn!("Warning!");
|
|
||||||
eprintln!(
|
|
||||||
"{:?}",
|
|
||||||
miette::Report::new(BinstallError::VersionWarning {
|
|
||||||
ver: package.version.clone(),
|
|
||||||
req: opts.version.clone()
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
if !opts.dry_run {
|
|
||||||
uithread.confirm().await?;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let (mut meta, binaries) = (
|
let (mut meta, binaries) = (
|
||||||
package
|
package
|
||||||
.metadata
|
.metadata
|
||||||
|
@ -312,7 +311,9 @@ async fn entry() -> Result<()> {
|
||||||
meta.merge(&cli_overrides);
|
meta.merge(&cli_overrides);
|
||||||
|
|
||||||
// Generate temporary binary path
|
// Generate temporary binary path
|
||||||
let bin_path = temp_dir.path().join(format!("bin-{}", opts.name));
|
let bin_path = temp_dir
|
||||||
|
.path()
|
||||||
|
.join(format!("bin-{}", opts.crate_name.name));
|
||||||
debug!("Using temporary binary path: {}", bin_path.display());
|
debug!("Using temporary binary path: {}", bin_path.display());
|
||||||
|
|
||||||
let bin_files = collect_bin_files(
|
let bin_files = collect_bin_files(
|
||||||
|
@ -363,6 +364,7 @@ async fn entry() -> Result<()> {
|
||||||
opts,
|
opts,
|
||||||
package,
|
package,
|
||||||
temp_dir,
|
temp_dir,
|
||||||
|
version,
|
||||||
&bin_path,
|
&bin_path,
|
||||||
&bin_files,
|
&bin_files,
|
||||||
)
|
)
|
||||||
|
@ -438,6 +440,7 @@ async fn install_from_package(
|
||||||
opts: Options,
|
opts: Options,
|
||||||
package: Package<Meta>,
|
package: Package<Meta>,
|
||||||
temp_dir: TempDir,
|
temp_dir: TempDir,
|
||||||
|
version: String,
|
||||||
bin_path: &Path,
|
bin_path: &Path,
|
||||||
bin_files: &[bins::BinFile],
|
bin_files: &[bins::BinFile],
|
||||||
) -> Result<()> {
|
) -> Result<()> {
|
||||||
|
@ -478,7 +481,7 @@ async fn install_from_package(
|
||||||
}
|
}
|
||||||
|
|
||||||
let cvs = metafiles::CrateVersionSource {
|
let cvs = metafiles::CrateVersionSource {
|
||||||
name: opts.name,
|
name: opts.crate_name.name,
|
||||||
version: package.version.parse().into_diagnostic()?,
|
version: package.version.parse().into_diagnostic()?,
|
||||||
source: metafiles::Source::Registry(
|
source: metafiles::Source::Registry(
|
||||||
url::Url::parse("https://github.com/rust-lang/crates.io-index").unwrap(),
|
url::Url::parse("https://github.com/rust-lang/crates.io-index").unwrap(),
|
||||||
|
@ -521,7 +524,7 @@ async fn install_from_package(
|
||||||
c2.insert(
|
c2.insert(
|
||||||
cvs.clone(),
|
cvs.clone(),
|
||||||
metafiles::v2::CrateInfo {
|
metafiles::v2::CrateInfo {
|
||||||
version_req: Some(opts.version),
|
version_req: Some(version),
|
||||||
bins,
|
bins,
|
||||||
profile: "release".into(),
|
profile: "release".into(),
|
||||||
target: fetcher.target().to_string(),
|
target: fetcher.target().to_string(),
|
||||||
|
|
Loading…
Add table
Reference in a new issue