Tweak "Cannot convert {x} to a string argument" error in run_external (#7434)

# Description

The message arrow is altered to show the external command name in case
it wasn't obvious. (See example for an occasion where it is
non-obvious).

BEFORE:
```
〉else if (2mb) > 4mb
Error: nu:🐚:external_command (link)

  × External command failed
   ╭─[entry #35:1:1]
 1 │ else if (2mb) > 4mb
   ·           ─┬
   ·            ╰── Cannot convert filesize to a string
   ╰────
  help: All arguments to an external command need to be string-compatible
```
AFTER:
```
〉else if (2mb) > 4mb
Error: nu:🐚:external_command (link)

  × External command failed
   ╭─[entry #3:1:1]
 1 │ else if (2mb) > 4mb
   ·           ─┬
   ·            ╰── Cannot convert filesize to a string argument for 'else'
   ╰────
  help: All arguments to an external command need to be string-compatible

```
# User-Facing Changes

See above.

# 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` to check that you're using the standard code
style
- `cargo test --workspace` to check that all tests pass

# 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.
This commit is contained in:
Leon 2022-12-12 02:39:51 +10:00 committed by GitHub
parent 2bacc29d30
commit 9009f68e09
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -58,7 +58,7 @@ impl Command for External {
// Translate environment variables from Values to Strings // Translate environment variables from Values to Strings
let env_vars_str = env_to_strings(engine_state, stack)?; let env_vars_str = env_to_strings(engine_state, stack)?;
fn value_as_spanned(value: Value) -> Result<Spanned<String>, ShellError> { fn value_as_spanned(value: Value, name: &String) -> Result<Spanned<String>, ShellError> {
let span = value.span()?; let span = value.span()?;
value value
@ -66,7 +66,11 @@ impl Command for External {
.map(|item| Spanned { item, span }) .map(|item| Spanned { item, span })
.map_err(|_| { .map_err(|_| {
ShellError::ExternalCommand( ShellError::ExternalCommand(
format!("Cannot convert {} to a string", value.get_type()), format!(
"Cannot convert {} to a string argument for '{}'",
value.get_type(),
name
),
"All arguments to an external command need to be string-compatible".into(), "All arguments to an external command need to be string-compatible".into(),
span, span,
) )
@ -83,13 +87,13 @@ impl Command for External {
// Example: one_arg may be something like ["ls" "-a"] // Example: one_arg may be something like ["ls" "-a"]
// convert it to "ls" "-a" // convert it to "ls" "-a"
for v in vals { for v in vals {
spanned_args.push(value_as_spanned(v)?); spanned_args.push(value_as_spanned(v, &name.item)?);
// for arguments in list, it's always treated as a whole arguments // for arguments in list, it's always treated as a whole arguments
arg_keep_raw.push(true); arg_keep_raw.push(true);
} }
} }
val => { val => {
spanned_args.push(value_as_spanned(val)?); spanned_args.push(value_as_spanned(val, &name.item)?);
match one_arg_expr.expr { match one_arg_expr.expr {
// refer to `parse_dollar_expr` function // refer to `parse_dollar_expr` function
// the expression type of $variable_name, $"($variable_name)" // the expression type of $variable_name, $"($variable_name)"