Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(embedded): Align package name sanitization with cargo-new #12255

Merged
merged 5 commits into from
Jun 17, 2023
Merged

fix(embedded): Align package name sanitization with cargo-new #12255

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b116864
fix(embedded): Be consistent with existing style when sanitizing
epage Jun 13, 2023
5fd3d2d
refactor(embedded): Centralize package name rules
epage Jun 13, 2023
8186282
fix(embedded): Sanitize like we validate package names
epage Jun 12, 2023
f4abdbe
fix(embedded): Extend sanitization rules to cover cargo-new validation
epage Jun 13, 2023
667ff78
refactor(embedded): Centralize placeholder
epage Jun 17, 2023
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
Prev Previous commit
refactor(embedded): Centralize placeholder 
This was originally split out because before #12269, it was needed
elsewhere.
  • Loading branch information
@epage
epage committed Jun 17, 2023
commit 667ff78d69256fa1cbaef619a60a46457fe25177
28 changes: 11 additions & 17 deletions src/cargo/util/toml/embedded.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,14 +80,7 @@ fn write(
.file_stem()
.ok_or_else(|| anyhow::format_err!("no file name"))?
.to_string_lossy();
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_name(file_name.as_ref(), separator);
let name = sanitize_name(file_name.as_ref());

let mut workspace_root = target_dir.to_owned();
workspace_root.push("eval");
Expand Down Expand Up @@ -147,14 +140,7 @@ 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 = 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_name(file_name.as_ref(), separator);
let name = sanitize_name(file_name.as_ref());
let bin_name = name.clone();
package
.entry("name".to_owned())
Expand Down Expand Up @@ -207,7 +193,15 @@ fn expand_manifest_(script: &RawScript, config: &Config) -> CargoResult<toml::Ta
}

/// Ensure the package name matches the validation from `ops::cargo_new::check_name`
fn sanitize_name(name: &str, placeholder: char) -> String {
fn sanitize_name(name: &str) -> String {
let placeholder = if name.contains('_') {
'_'
} else {
// Since embedded manifests only support `[[bin]]`s, prefer arrow-case as that is the
// more common convention for CLIs
'-'
};

let mut name = restricted_names::sanitize_package_name(name, placeholder);

loop {
Expand Down