Skip to content

Commit 9733561

Browse files
borsbors
committed
Auto merge of #7056 - ehuss:default-run-stabilize, r=alexcrichton
Stabilize default-run This stabilizes the default-run feature. I've included some error message changes. If `default-run` specifies an unknown binary, it now tells you that the `default-run` field is incorrect and which manifest it is located in, instead of just saying "could not determine which binary to run". I also consolidated some of the suggestion code so it is not repeated all over. Closes #7032
2 parents 142603a + 7d7fe67 commit 9733561

20 files changed

+131
-225
lines changed

‎src/bin/cargo/main.rs

+4-21
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ use std::fs;
1010
use std::path::{Path, PathBuf};
1111

1212
use cargo::core::shell::Shell;
13-
use cargo::util::{self, command_prelude, lev_distance, CargoResult, CliResult, Config};
13+
use cargo::util::{self, closest_msg, command_prelude, CargoResult, CliResult, Config};
1414
use cargo::util::{CliError, ProcessError};
1515

1616
mod cli;
@@ -113,18 +113,6 @@ fn list_commands(config: &Config) -> BTreeSet<CommandInfo> {
113113
commands
114114
}
115115

116-
fn find_closest(config: &Config, cmd: &str) -> Option<String> {
117-
let cmds = list_commands(config);
118-
// Only consider candidates with a lev_distance of 3 or less so we don't
119-
// suggest out-of-the-blue options.
120-
cmds.into_iter()
121-
.map(|c| c.name())
122-
.map(|c| (lev_distance(&c, cmd), c))
123-
.filter(|&(d, _)| d < 4)
124-
.min_by_key(|a| a.0)
125-
.map(|slot| slot.1)
126-
}
127-
128116
fn execute_external_subcommand(config: &Config, cmd: &str, args: &[&str]) -> CliResult {
129117
let command_exe = format!("cargo-{}{}", cmd, env::consts::EXE_SUFFIX);
130118
let path = search_directories(config)
@@ -134,14 +122,9 @@ fn execute_external_subcommand(config: &Config, cmd: &str, args: &[&str]) -> Cli
134122
let command = match path {
135123
Some(command) => command,
136124
None => {
137-
let err = match find_closest(config, cmd) {
138-
Some(closest) => failure::format_err!(
139-
"no such subcommand: `{}`\n\n\tDid you mean `{}`?\n",
140-
cmd,
141-
closest
142-
),
143-
None => failure::format_err!("no such subcommand: `{}`", cmd),
144-
};
125+
let cmds = list_commands(config);
126+
let did_you_mean = closest_msg(cmd, cmds.iter(), |c| c.name());
127+
let err = failure::format_err!("no such subcommand: `{}`{}", cmd, did_you_mean);
145128
return Err(CliError::new(err, 101));
146129
}
147130
};

‎src/cargo/core/features.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ features! {
196196
[unstable] namespaced_features: bool,
197197

198198
// "default-run" manifest option,
199-
[unstable] default_run: bool,
199+
[stable] default_run: bool,
200200

201201
// Declarative build scripts.
202202
[unstable] metabuild: bool,

‎src/cargo/core/manifest.rs

-6
Original file line numberDiff line numberDiff line change
@@ -518,12 +518,6 @@ impl Manifest {
518518
})?;
519519
}
520520

521-
if self.default_run.is_some() {
522-
self.features
523-
.require(Feature::default_run())
524-
.chain_err(|| failure::format_err!("the `default-run` manifest key is unstable"))?;
525-
}
526-
527521
Ok(())
528522
}
529523

‎src/cargo/core/package.rs

+1-16
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ use crate::ops;
2525
use crate::util::config::PackageCacheLock;
2626
use crate::util::errors::{CargoResult, CargoResultExt, HttpNot200};
2727
use crate::util::network::Retry;
28-
use crate::util::{self, internal, lev_distance, Config, Progress, ProgressStyle};
28+
use crate::util::{self, internal, Config, Progress, ProgressStyle};
2929

3030
/// Information about a package that is available somewhere in the file system.
3131
///
@@ -193,21 +193,6 @@ impl Package {
193193
self.targets().iter().any(|t| t.is_custom_build())
194194
}
195195

196-
pub fn find_closest_target(
197-
&self,
198-
target: &str,
199-
is_expected_kind: fn(&Target) -> bool,
200-
) -> Option<&Target> {
201-
let targets = self.targets();
202-
203-
let matches = targets
204-
.iter()
205-
.filter(|t| is_expected_kind(t))
206-
.map(|t| (lev_distance(target, t.name()), t))
207-
.filter(|&(d, _)| d < 4);
208-
matches.min_by_key(|t| t.0).map(|t| t.1)
209-
}
210-
211196
pub fn map_source(self, to_replace: SourceId, replace_with: SourceId) -> Package {
212197
Package {
213198
manifest: self.manifest.map_source(to_replace, replace_with),

‎src/cargo/core/profiles.rs

+7-19
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ use crate::core::compiler::CompileMode;
77
use crate::core::interning::InternedString;
88
use crate::core::{Features, PackageId, PackageIdSpec, PackageSet, Shell};
99
use crate::util::errors::CargoResultExt;
10-
use crate::util::lev_distance::lev_distance;
1110
use crate::util::toml::{ProfilePackageSpec, StringOrBool, TomlProfile, TomlProfiles, U32OrBool};
12-
use crate::util::{CargoResult, Config};
11+
use crate::util::{closest_msg, CargoResult, Config};
1312

1413
/// Collection of all user profiles.
1514
#[derive(Clone, Debug)]
@@ -290,23 +289,12 @@ impl ProfileMaker {
290289
})
291290
.collect();
292291
if name_matches.is_empty() {
293-
let suggestion = packages
294-
.package_ids()
295-
.map(|p| (lev_distance(&*spec.name(), &p.name()), p.name()))
296-
.filter(|&(d, _)| d < 4)
297-
.min_by_key(|p| p.0)
298-
.map(|p| p.1);
299-
match suggestion {
300-
Some(p) => shell.warn(format!(
301-
"profile override spec `{}` did not match any packages\n\n\
302-
Did you mean `{}`?",
303-
spec, p
304-
))?,
305-
None => shell.warn(format!(
306-
"profile override spec `{}` did not match any packages",
307-
spec
308-
))?,
309-
}
292+
let suggestion =
293+
closest_msg(&spec.name(), packages.package_ids(), |p| p.name().as_str());
294+
shell.warn(format!(
295+
"profile override spec `{}` did not match any packages{}",
296+
spec, suggestion
297+
))?;
310298
} else {
311299
shell.warn(format!(
312300
"version or URL in profile override spec `{}` does not \

‎src/cargo/ops/cargo_compile.rs

+13-21
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ use crate::core::{Package, Target};
3535
use crate::core::{PackageId, PackageIdSpec, TargetKind, Workspace};
3636
use crate::ops;
3737
use crate::util::config::Config;
38-
use crate::util::{lev_distance, profile, CargoResult};
38+
use crate::util::{closest_msg, profile, CargoResult};
3939

4040
/// Contains information about how a package should be compiled.
4141
#[derive(Debug)]
@@ -906,26 +906,18 @@ fn find_named_targets<'a>(
906906
let filter = |t: &Target| t.name() == target_name && is_expected_kind(t);
907907
let proposals = filter_targets(packages, filter, true, mode);
908908
if proposals.is_empty() {
909-
let suggestion = packages
910-
.iter()
911-
.flat_map(|pkg| {
912-
pkg.targets()
913-
.iter()
914-
.filter(|target| is_expected_kind(target))
915-
})
916-
.map(|target| (lev_distance(target_name, target.name()), target))
917-
.filter(|&(d, _)| d < 4)
918-
.min_by_key(|t| t.0)
919-
.map(|t| t.1);
920-
match suggestion {
921-
Some(s) => failure::bail!(
922-
"no {} target named `{}`\n\nDid you mean `{}`?",
923-
target_desc,
924-
target_name,
925-
s.name()
926-
),
927-
None => failure::bail!("no {} target named `{}`", target_desc, target_name),
928-
}
909+
let targets = packages.iter().flat_map(|pkg| {
910+
pkg.targets()
911+
.iter()
912+
.filter(|target| is_expected_kind(target))
913+
});
914+
let suggestion = closest_msg(target_name, targets, |t| t.name());
915+
failure::bail!(
916+
"no {} target named `{}`{}",
917+
target_desc,
918+
target_name,
919+
suggestion
920+
);
929921
}
930922
Ok(proposals)
931923
}

‎src/cargo/ops/cargo_run.rs

+8-17
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use std::ffi::OsString;
22
use std::iter;
33
use std::path::Path;
44

5-
use crate::core::{nightly_features_allowed, TargetKind, Workspace};
5+
use crate::core::{TargetKind, Workspace};
66
use crate::ops;
77
use crate::util::{CargoResult, ProcessError};
88

@@ -55,22 +55,13 @@ pub fn run(
5555
.into_iter()
5656
.map(|(_pkg, target)| target.name())
5757
.collect();
58-
if nightly_features_allowed() {
59-
failure::bail!(
60-
"`cargo run` could not determine which binary to run. \
61-
Use the `--bin` option to specify a binary, \
62-
or (on nightly) the `default-run` manifest key.\n\
63-
available binaries: {}",
64-
names.join(", ")
65-
)
66-
} else {
67-
failure::bail!(
68-
"`cargo run` requires that a package only have one \
69-
executable; use the `--bin` option to specify which one \
70-
to run\navailable binaries: {}",
71-
names.join(", ")
72-
)
73-
}
58+
failure::bail!(
59+
"`cargo run` could not determine which binary to run. \
60+
Use the `--bin` option to specify a binary, \
61+
or the `default-run` manifest key.\n\
62+
available binaries: {}",
63+
names.join(", ")
64+
)
7465
} else {
7566
failure::bail!(
7667
"`cargo run` can run at most one executable, but \

‎src/cargo/util/command_prelude.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -514,10 +514,10 @@ pub enum CommandInfo {
514514
}
515515

516516
impl CommandInfo {
517-
pub fn name(&self) -> String {
517+
pub fn name(&self) -> &str {
518518
match self {
519-
CommandInfo::BuiltIn { name, .. } => name.to_string(),
520-
CommandInfo::External { name, .. } => name.to_string(),
519+
CommandInfo::BuiltIn { name, .. } => &name,
520+
CommandInfo::External { name, .. } => &name,
521521
}
522522
}
523523
}

‎src/cargo/util/lev_distance.rs

+28
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,34 @@ pub fn lev_distance(me: &str, t: &str) -> usize {
3333
dcol[t_last + 1]
3434
}
3535

36+
/// Find the closest element from `iter` matching `choice`. The `key` callback
37+
/// is used to select a `&str` from the iterator to compare against `choice`.
38+
pub fn closest<'a, T>(
39+
choice: &str,
40+
iter: impl Iterator<Item = T>,
41+
key: impl Fn(&T) -> &'a str,
42+
) -> Option<T> {
43+
// Only consider candidates with a lev_distance of 3 or less so we don't
44+
// suggest out-of-the-blue options.
45+
iter.map(|e| (lev_distance(choice, key(&e)), e))
46+
.filter(|&(d, _)| d < 4)
47+
.min_by_key(|t| t.0)
48+
.map(|t| t.1)
49+
}
50+
51+
/// Version of `closest` that returns a common "suggestion" that can be tacked
52+
/// onto the end of an error message.
53+
pub fn closest_msg<'a, T>(
54+
choice: &str,
55+
iter: impl Iterator<Item = T>,
56+
key: impl Fn(&T) -> &'a str,
57+
) -> String {
58+
match closest(choice, iter, &key) {
59+
Some(e) => format!("\n\n\tDid you mean `{}`?", key(&e)),
60+
None => String::new(),
61+
}
62+
}
63+
3664
#[test]
3765
fn test_lev_distance() {
3866
use std::char::{from_u32, MAX};

‎src/cargo/util/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pub use self::graph::Graph;
1212
pub use self::hex::{hash_u64, short_hash, to_hex};
1313
pub use self::into_url::IntoUrl;
1414
pub use self::into_url_with_base::IntoUrlWithBase;
15-
pub use self::lev_distance::lev_distance;
15+
pub use self::lev_distance::{closest, closest_msg, lev_distance};
1616
pub use self::lockserver::{LockServer, LockServerClient, LockServerStarted};
1717
pub use self::paths::{bytes2path, dylib_path, join_paths, path2bytes};
1818
pub use self::paths::{dylib_path_envvar, normalize_path};

‎src/cargo/util/toml/mod.rs

+13-2
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,7 @@ use crate::core::{Edition, EitherManifest, Feature, Features, VirtualManifest};
2121
use crate::core::{GitReference, PackageIdSpec, SourceId, WorkspaceConfig, WorkspaceRootConfig};
2222
use crate::sources::{CRATES_IO_INDEX, CRATES_IO_REGISTRY};
2323
use crate::util::errors::{CargoResult, CargoResultExt, ManifestError};
24-
use crate::util::paths;
25-
use crate::util::{self, validate_package_name, Config, IntoUrl};
24+
use crate::util::{self, paths, validate_package_name, Config, IntoUrl};
2625

2726
mod targets;
2827
use self::targets::targets;
@@ -1052,6 +1051,18 @@ impl TomlManifest {
10521051
)
10531052
}
10541053

1054+
if let Some(run) = &project.default_run {
1055+
if !targets
1056+
.iter()
1057+
.filter(|t| t.is_bin())
1058+
.any(|t| t.name() == run)
1059+
{
1060+
let suggestion =
1061+
util::closest_msg(&run, targets.iter().filter(|t| t.is_bin()), |t| t.name());
1062+
bail!("default-run target `{}` not found{}", run, suggestion);
1063+
}
1064+
}
1065+
10551066
let custom_metadata = project.metadata.clone();
10561067
let mut manifest = Manifest::new(
10571068
summary,

‎src/doc/man/cargo-run.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ include::options-package.adoc[]
2929

3030
When no target selection options are given, `cargo run` will run the binary
3131
target. If there are multiple binary targets, you must pass a target flag to
32-
choose one.
32+
choose one. Or, the `default-run` field may be specified in the `[package]`
33+
section of `Cargo.toml` to choose the name of the binary to run by default.
3334

3435
*--bin* _NAME_::
3536
Run the specified binary.

‎src/doc/man/generated/cargo-run.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ <h3 id="cargo_run_target_selection">Target Selection</h3>
4848
<div class="paragraph">
4949
<p>When no target selection options are given, <code>cargo run</code> will run the binary
5050
target. If there are multiple binary targets, you must pass a target flag to
51-
choose one.</p>
51+
choose one. Or, the <code>default-run</code> field may be specified in the <code>[package]</code>
52+
section of <code>Cargo.toml</code> to choose the name of the binary to run by default.</p>
5253
</div>
5354
<div class="dlist">
5455
<dl>

0 commit comments

Comments
 (0)