Skip to content

Commit

Permalink
fix(embedded): Be consistent with existing style when sanitizing
Browse files Browse the repository at this point in the history
  • Loading branch information
@epage
epage committed Jun 13, 2023
1 parent 35a8065 commit 436af9b
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 21 deletions.
20 changes: 16 additions & 4 deletions src/cargo/util/toml/embedded.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,13 @@ fn write(
.file_stem()
.ok_or_else(|| anyhow::format_err!("no file name"))?
.to_string_lossy();
let separator = '_';
let separator = if file_name.contains('_') {
'_'
} else {
// Since embedded manifests only support `[[bin]]`s, prefer arrow-case as that is the
// more common convention for CLIs
'-'
};
let name = sanitize_package_name(file_name.as_ref(), separator);

let mut workspace_root = target_dir.to_owned();
Expand Down Expand Up @@ -140,7 +146,13 @@ fn expand_manifest_(script: &RawScript, config: &Config) -> CargoResult<toml::Ta
.file_stem()
.ok_or_else(|| anyhow::format_err!("no file name"))?
.to_string_lossy();
let separator = '_';
let separator = if file_name.contains('_') {
'_'
} else {
// Since embedded manifests only support `[[bin]]`s, prefer arrow-case as that is the
// more common convention for CLIs
'-'
};
let name = sanitize_package_name(file_name.as_ref(), separator);
let hash = hash(script);
let bin_name = format!("{name}{separator}{hash}");
Expand Down Expand Up @@ -449,7 +461,7 @@ mod test_expand {
fn test_default() {
snapbox::assert_eq(
r#"[[bin]]
name = "test_a472c7a31645d310613df407eab80844346938a3b8fe4f392cae059cb181aa85"
name = "test-a472c7a31645d310613df407eab80844346938a3b8fe4f392cae059cb181aa85"
path = "/home/me/test.rs"
[package]
Expand All @@ -471,7 +483,7 @@ strip = true
fn test_dependencies() {
snapbox::assert_eq(
r#"[[bin]]
name = "test_3a1fa07700654ea2e893f70bb422efa7884eb1021ccacabc5466efe545da8a0b"
name = "test-3a1fa07700654ea2e893f70bb422efa7884eb1021ccacabc5466efe545da8a0b"
path = "/home/me/test.rs"
[dependencies]
Expand Down
34 changes: 17 additions & 17 deletions tests/testsuite/script.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ args: []
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] echo v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/echo)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/echo/target/debug/echo_[..]`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/echo/target/debug/echo-[..]`
",
)
.run();
Expand All @@ -59,7 +59,7 @@ args: []
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] echo v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/echo)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/echo/target/debug/echo_[..]`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/echo/target/debug/echo-[..]`
",
)
.run();
Expand Down Expand Up @@ -113,7 +113,7 @@ args: []
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] echo v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/echo)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/echo/target/debug/echo_[..]`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/echo/target/debug/echo-[..]`
",
)
.run();
Expand Down Expand Up @@ -205,7 +205,7 @@ fn main() {
"\
[COMPILING] script v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/script)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..]`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..]`
",
)
.run();
Expand Down Expand Up @@ -237,7 +237,7 @@ fn main() {
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] script v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/script)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..]`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..]`
",
)
.run();
Expand Down Expand Up @@ -266,7 +266,7 @@ fn main() {
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] script v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/script)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..]`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..]`
",
)
.run();
Expand All @@ -282,7 +282,7 @@ fn main() {
"\
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..]`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..]`
",
)
.run();
Expand All @@ -300,7 +300,7 @@ fn main() {
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] script v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/script)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..]`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..]`
",
)
.run();
Expand Down Expand Up @@ -329,7 +329,7 @@ fn main() {
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] script v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/script)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..]`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..]`
",
)
.run();
Expand All @@ -354,7 +354,7 @@ args: ["-NotAnArg"]
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] script v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/script)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..] -NotAnArg`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..] -NotAnArg`
",
)
.run();
Expand All @@ -379,7 +379,7 @@ args: ["-NotAnArg"]
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] script v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/script)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..] -NotAnArg`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..] -NotAnArg`
",
)
.run();
Expand All @@ -404,7 +404,7 @@ args: ["--help"]
[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] script v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/script)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..] --help`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..] --help`
",
)
.run();
Expand All @@ -426,15 +426,15 @@ args: []
)
.with_stderr(
r#"[WARNING] `package.edition` is unspecifiead, defaulting to `2021`
[COMPILING] s-h_w_c_ v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/s-h_w_c_)
[COMPILING] s-h-w-c- v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/s-h-w-c-)
[WARNING] crate `s_h_w_c__[..]` should have a snake case name
|
= help: convert the identifier to snake case: `s_h_w_c_[..]`
= note: `#[warn(non_snake_case)]` on by default
[WARNING] `s-h_w_c_` (bin "s-h_w_c__[..]") generated 1 warning
[WARNING] `s-h-w-c-` (bin "s-h-w-c--[..]") generated 1 warning
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/s-h_w_c_/target/debug/s-h_w_c__[..]`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/s-h-w-c-/target/debug/s-h-w-c--[..]`
"#,
)
.run();
Expand Down Expand Up @@ -472,7 +472,7 @@ fn main() {
[COMPILING] script v1.0.0
[COMPILING] script v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/script)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..] --help`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..] --help`
",
)
.run();
Expand Down Expand Up @@ -509,7 +509,7 @@ fn main() {
[COMPILING] bar v0.0.1 ([ROOT]/foo/bar)
[COMPILING] script v0.0.0 ([ROOT]/home/.cargo/eval/target/eval/[..]/script)
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]s
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script_[..] --help`
[RUNNING] `[ROOT]/home/.cargo/eval/target/eval/[..]/script/target/debug/script-[..] --help`
",
)
.run();
Expand Down

0 comments on commit 436af9b

Please sign in to comment.