forked from extern/nushell
30f4cc1fef
# Description I'm not sure if this is a good idea or now but I did it to fix #9418. It allows you to pass empty string arguments like this. file named foo.nu ``` def main [--arg: string = dog] { if ($arg | is-empty) { echo "empty string" } else { echo $arg } } ``` `> nu foo.nu --arg ""` or `> nu foo.nu --arg=""` this gives an error `> nu foo.nu --arg` this returns the default argument `> nu foo.nu` closes #9418 # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect -A clippy::result_large_err` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass - `cargo run -- crates/nu-std/tests/run.nu` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. -->
99 lines
2.9 KiB
Rust
99 lines
2.9 KiB
Rust
pub fn escape_quote_string(input: &str) -> String {
|
|
let mut output = String::with_capacity(input.len() + 2);
|
|
output.push('"');
|
|
|
|
for c in input.chars() {
|
|
if c == '"' || c == '\\' {
|
|
output.push('\\');
|
|
}
|
|
output.push(c);
|
|
}
|
|
|
|
output.push('"');
|
|
output
|
|
}
|
|
|
|
// Escape rules:
|
|
// input argument contains ' '(like abc def), we will convert it to `abc def`.
|
|
// input argument contains --version='xx yy', we will convert it to --version=`'xx yy'`
|
|
// input argument contains " or \, we will try to escape input.
|
|
pub fn escape_for_script_arg(input: &str) -> String {
|
|
// handle for flag, maybe we need to escape the value.
|
|
if input.starts_with("--") {
|
|
if let Some((arg_name, arg_val)) = input.split_once('=') {
|
|
// only want to escape arg_val.
|
|
let arg_val = if arg_val.contains(' ') {
|
|
format!("`{arg_val}`")
|
|
} else if arg_val.contains('"') || arg_val.contains('\\') {
|
|
escape_quote_string(arg_val)
|
|
} else if arg_val.is_empty() {
|
|
// return an empty string
|
|
"''".to_string()
|
|
} else {
|
|
arg_val.into()
|
|
};
|
|
return format!("{arg_name}={arg_val}");
|
|
}
|
|
}
|
|
|
|
if input.contains(' ') {
|
|
format!("`{input}`")
|
|
} else if input.contains('"') || input.contains('\\') {
|
|
escape_quote_string(input)
|
|
} else if input.is_empty() {
|
|
// return an empty string
|
|
"''".to_string()
|
|
} else {
|
|
input.to_string()
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::escape_for_script_arg;
|
|
|
|
#[test]
|
|
fn test_not_extra_quote() {
|
|
// check for input arg like this:
|
|
// nu b.nu 8
|
|
assert_eq!(escape_for_script_arg("8"), "8".to_string());
|
|
}
|
|
|
|
#[test]
|
|
fn test_arg_with_flag() {
|
|
// check for input arg like this:
|
|
// nu b.nu linux --version=v5.2
|
|
assert_eq!(escape_for_script_arg("linux"), "linux".to_string());
|
|
assert_eq!(
|
|
escape_for_script_arg("--version=v5.2"),
|
|
"--version=v5.2".to_string()
|
|
);
|
|
|
|
// check for input arg like this:
|
|
// nu b.nu linux --version v5.2
|
|
assert_eq!(escape_for_script_arg("--version"), "--version".to_string());
|
|
assert_eq!(escape_for_script_arg("v5.2"), "v5.2".to_string());
|
|
}
|
|
|
|
#[test]
|
|
fn test_flag_arg_with_values_contains_space() {
|
|
// check for input arg like this:
|
|
// nu b.nu test_ver --version='xx yy' --arch=ghi
|
|
assert_eq!(
|
|
escape_for_script_arg("--version='xx yy'"),
|
|
"--version=`'xx yy'`".to_string()
|
|
);
|
|
assert_eq!(
|
|
escape_for_script_arg("--arch=ghi"),
|
|
"--arch=ghi".to_string()
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_escape() {
|
|
// check for input arg like this:
|
|
// nu b.nu '"'
|
|
assert_eq!(escape_for_script_arg(r#"""#), r#""\"""#.to_string());
|
|
}
|
|
}
|