Auto merge of #10650 - epage:install, r=ehuss

feat(install): Support `foo@version` like cargo-add

### What does this PR try to resolve?

This aims to make `cargo install` consistent with
- `cargo add foo@version` from #10472
- pkgid changes in #10582
- `cargo yank foo@version` from #10597

It also offers a shorthand for people installing a specific version.

### How should we test and review this PR?

#10582 acted as the FCP for this, see #10597

Documentation updates are split into their own commit to not clog up browsing the code.

Examine the tests to see if they make sense

### Additional information

While the `foo@vewrsion` syntax is the same, each's semantics are different.  We had decided it was better to have the same syntax with different semantics than having the user worry about what syntax they use where.  In `cargo install`s case, it has an
implicit-but-required `=` operand while `cargo-add` allows any operand.

This doesn't use the full `pkgid` syntax because that allows syntax that
is unsupported here.

This doesn't use `cargo-add`s parser because that is for version reqs.

I held off on reusing the parser from `cargo-yank` because they had
different type system needs and the level of duplication didn't seem
worth it (see Rule of Three).
This commit is contained in:
bors 2022-05-11 03:25:36 +00:00
commit 23ae8a0a0f
7 changed files with 81 additions and 22 deletions

View File

@ -97,10 +97,12 @@ pub fn exec(config: &mut Config, args: &ArgMatches) -> CliResult {
// but not `Config::reload_rooted_at` which is always cwd)
let path = path.map(|p| paths::normalize_path(&p));
let version = args.value_of("version");
let krates = args
.values_of("crate")
.unwrap_or_default()
.collect::<Vec<_>>();
.map(|k| resolve_crate(k, version))
.collect::<crate::CargoResult<Vec<_>>>()?;
let mut from_cwd = false;
@ -129,7 +131,6 @@ pub fn exec(config: &mut Config, args: &ArgMatches) -> CliResult {
SourceId::crates_io(config)?
};
let version = args.value_of("version");
let root = args.value_of("root");
// We only provide workspace information for local crate installation from
@ -166,7 +167,6 @@ pub fn exec(config: &mut Config, args: &ArgMatches) -> CliResult {
krates,
source,
from_cwd,
version,
&compile_opts,
args.is_present("force"),
args.is_present("no-track"),
@ -174,3 +174,21 @@ pub fn exec(config: &mut Config, args: &ArgMatches) -> CliResult {
}
Ok(())
}
fn resolve_crate<'k>(
mut krate: &'k str,
mut version: Option<&'k str>,
) -> crate::CargoResult<(&'k str, Option<&'k str>)> {
if let Some((k, v)) = krate.split_once('@') {
if version.is_some() {
anyhow::bail!("cannot specify both `@{v}` and `--version`");
}
if k.is_empty() {
// by convention, arguments starting with `@` are response files
anyhow::bail!("missing crate name for `@{v}`");
}
krate = k;
version = Some(v);
}
Ok((krate, version))
}

View File

@ -556,10 +556,9 @@ impl<'cfg, 'a> InstallablePackage<'cfg, 'a> {
pub fn install(
config: &Config,
root: Option<&str>,
krates: Vec<&str>,
krates: Vec<(&str, Option<&str>)>,
source_id: SourceId,
from_cwd: bool,
vers: Option<&str>,
opts: &ops::CompileOptions,
force: bool,
no_track: bool,
@ -569,18 +568,13 @@ pub fn install(
let map = SourceConfigMap::new(config)?;
let (installed_anything, scheduled_error) = if krates.len() <= 1 {
let (krate, vers) = krates
.into_iter()
.next()
.map(|(k, v)| (Some(k), v))
.unwrap_or((None, None));
let installable_pkg = InstallablePackage::new(
config,
root,
map,
krates.into_iter().next(),
source_id,
from_cwd,
vers,
opts,
force,
no_track,
true,
config, root, map, krate, source_id, from_cwd, vers, opts, force, no_track, true,
)?;
let mut installed_anything = true;
if let Some(installable_pkg) = installable_pkg {
@ -596,7 +590,7 @@ pub fn install(
let pkgs_to_install: Vec<_> = krates
.into_iter()
.filter_map(|krate| {
.filter_map(|(krate, vers)| {
let root = root.clone();
let map = map.clone();
match InstallablePackage::new(

View File

@ -8,7 +8,7 @@ cargo-install - Build and install a Rust binary
## SYNOPSIS
`cargo install` [_options_] _crate_...\
`cargo install` [_options_] _crate_[@_version_]...\
`cargo install` [_options_] `--path` _path_\
`cargo install` [_options_] `--git` _url_ [_crate_...]\
`cargo install` [_options_] `--list`

View File

@ -4,7 +4,7 @@ NAME
cargo-install - Build and install a Rust binary
SYNOPSIS
cargo install [options] crate...
cargo install [options] crate[@version]...
cargo install [options] --path path
cargo install [options] --git url [crate...]
cargo install [options] --list

View File

@ -8,7 +8,7 @@ cargo-install - Build and install a Rust binary
## SYNOPSIS
`cargo install` [_options_] _crate_...\
`cargo install` [_options_] _crate_[@_version_]...\
`cargo install` [_options_] `--path` _path_\
`cargo install` [_options_] `--git` _url_ [_crate_...]\
`cargo install` [_options_] `--list`

View File

@ -6,7 +6,7 @@
.SH "NAME"
cargo\-install \- Build and install a Rust binary
.SH "SYNOPSIS"
\fBcargo install\fR [\fIoptions\fR] \fIcrate\fR\&...
\fBcargo install\fR [\fIoptions\fR] \fIcrate\fR[@\fIversion\fR]\&...
.br
\fBcargo install\fR [\fIoptions\fR] \fB\-\-path\fR \fIpath\fR
.br

View File

@ -1382,7 +1382,7 @@ fn vers_precise() {
}
#[cargo_test]
fn version_too() {
fn version_precise() {
pkg("foo", "0.1.1");
pkg("foo", "0.1.2");
@ -1391,6 +1391,53 @@ fn version_too() {
.run();
}
#[cargo_test]
fn inline_version_precise() {
pkg("foo", "0.1.1");
pkg("foo", "0.1.2");
cargo_process("install foo@0.1.1")
.with_stderr_contains("[DOWNLOADED] foo v0.1.1 (registry [..])")
.run();
}
#[cargo_test]
fn inline_version_multiple() {
pkg("foo", "0.1.0");
pkg("foo", "0.1.1");
pkg("foo", "0.1.2");
pkg("bar", "0.2.0");
pkg("bar", "0.2.1");
pkg("bar", "0.2.2");
cargo_process("install foo@0.1.1 bar@0.2.1")
.with_stderr_contains("[DOWNLOADED] foo v0.1.1 (registry [..])")
.with_stderr_contains("[DOWNLOADED] bar v0.2.1 (registry [..])")
.run();
}
#[cargo_test]
fn inline_version_without_name() {
pkg("foo", "0.1.1");
pkg("foo", "0.1.2");
cargo_process("install @0.1.1")
.with_status(101)
.with_stderr("error: missing crate name for `@0.1.1`")
.run();
}
#[cargo_test]
fn inline_and_explicit_version() {
pkg("foo", "0.1.1");
pkg("foo", "0.1.2");
cargo_process("install foo@0.1.1 --version 0.1.1")
.with_status(101)
.with_stderr("error: cannot specify both `@0.1.1` and `--version`")
.run();
}
#[cargo_test]
fn not_both_vers_and_version() {
pkg("foo", "0.1.1");