extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-19 08:41:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document and critically review ShellError variants - Ep. 3 (#8340)

Browse Source 
Continuation of #8229 and #8326

# Description

The `ShellError` enum at the moment is kind of messy. 

Many variants are basic tuple structs where you always have to reference
the implementation with its macro invocation to know which field serves
which purpose.
Furthermore we have both variants that are kind of redundant or either
overly broad to be useful for the user to match on or overly specific
with few uses.

So I set out to start fixing the lacking documentation and naming to
make it feasible to critically review the individual usages and fix
those.
Furthermore we can decide to join or split up variants that don't seem
to be fit for purpose.

# Call to action

**Everyone:** Feel free to add review comments if you spot inconsistent
use of `ShellError` variants.

# User-Facing Changes

(None now, end goal more explicit and consistent error messages)

# Tests + Formatting

(No additional tests needed so far)

# Commits (so far)

- Remove `ShellError::FeatureNotEnabled`
- Name fields on `SE::ExternalNotSupported`
- Name field on `SE::InvalidProbability`
- Name fields on `SE::NushellFailed` variants
- Remove unused `SE::NushellFailedSpannedHelp`
- Name field on `SE::VariableNotFoundAtRuntime`
- Name fields on `SE::EnvVarNotFoundAtRuntime`
- Name fields on `SE::ModuleNotFoundAtRuntime`
- Remove usused `ModuleOrOverlayNotFoundAtRuntime`
- Name fields on `SE::OverlayNotFoundAtRuntime`
- Name field on `SE::NotFound`
This commit is contained in:
Stefan Holderbach
2023-03-06 18:33:09 +01:00
committed by GitHub
parent 4898750fc1
commit 62575c9a4f
72 changed files with 1193 additions and 1048 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
crates/nu-command/src/conversions/into/bool.rs
View File

@@ -134,15 +134,15 @@ fn string_to_boolean(s: &str, span: Span) -> Result<bool, ShellError> {
let val = o.parse::<f64>();
match val {
Ok(f) => Ok(f.abs() >= f64::EPSILON),
Err(_) => Err(ShellError::CantConvert(
"boolean".to_string(),
"string".to_string(),
Err(_) => Err(ShellError::CantConvert {
to_type: "boolean".to_string(),
from_type: "string".to_string(),
span,
Some(
help: Some(
r#"the strings "true" and "false" can be converted into a bool"#
.to_string(),
),
)),
}),
}
}
}

7
crates/nu-command/src/conversions/into/datetime.rs
View File

@@ -307,12 +307,7 @@ fn action(input: &Value, args: &Arguments, head: Span) -> Value {
Ok(d) => Value::Date { val: d, span: head },
Err(reason) => {
Value::Error {
error: ShellError::CantConvert(
format!("could not parse as datetime using format '{}'", dt.0),
reason.to_string(),
head,
Some("you can use `into datetime` without a format string to enable flexible parsing".to_string())
),
error: ShellError::CantConvert { to_type: format!("could not parse as datetime using format '{}'", dt.0), from_type: reason.to_string(), span: head, help: Some("you can use `into datetime` without a format string to enable flexible parsing".to_string()) },
}
}
},

12
crates/nu-command/src/conversions/into/decimal.rs
View File

@@ -88,12 +88,12 @@ fn action(input: &Value, _args: &CellPathOnlyArgs, head: Span) -> Value {
match other.parse::<f64>() {
Ok(x) => Value::float(x, head),
Err(reason) => Value::Error {
error: ShellError::CantConvert(
"float".to_string(),
reason.to_string(),
*span,
None,
),
error: ShellError::CantConvert {
to_type: "float".to_string(),
from_type: reason.to_string(),
span: *span,
help: None,
},
},
}
}

58
crates/nu-command/src/conversions/into/duration.rs
View File

@@ -315,17 +315,17 @@ fn convert_str_from_unit_to_unit(
("yr", "yr") => Ok(val as f64),
("yr", "dec") => Ok(val as f64 / 10.0),
_ => Err(ShellError::CantConvertWithValue(
"string duration".to_string(),
"string duration".to_string(),
to_unit.to_string(),
span,
value_span,
Some(
_ => Err(ShellError::CantConvertWithValue {
to_type: "string duration".to_string(),
from_type: "string duration".to_string(),
details: to_unit.to_string(),
dst_span: span,
src_span: value_span,
help: Some(
"supported units are ns, us, ms, sec, min, hr, day, wk, month, yr and dec"
.to_string(),
),
)),
}),
}
}
@@ -348,16 +348,16 @@ fn string_to_duration(s: &str, span: Span, value_span: Span) -> Result<i64, Shel
}
}
Err(ShellError::CantConvertWithValue(
"duration".to_string(),
"string".to_string(),
s.to_string(),
span,
value_span,
Some(
Err(ShellError::CantConvertWithValue {
to_type: "duration".to_string(),
from_type: "string".to_string(),
details: s.to_string(),
dst_span: span,
src_span: value_span,
help: Some(
"supported units are ns, us, ms, sec, min, hr, day, wk, month, yr and dec".to_string(),
),
))
})
}
fn string_to_unit_duration(
@@ -384,16 +384,16 @@ fn string_to_unit_duration(
}
}
Err(ShellError::CantConvertWithValue(
"duration".to_string(),
"string".to_string(),
s.to_string(),
span,
value_span,
Some(
Err(ShellError::CantConvertWithValue {
to_type: "duration".to_string(),
from_type: "string".to_string(),
details: s.to_string(),
dst_span: span,
src_span: value_span,
help: Some(
"supported units are ns, us, ms, sec, min, hr, day, wk, month, yr and dec".to_string(),
),
))
})
}
fn action(
@@ -468,12 +468,12 @@ fn action(
}
} else {
Value::Error {
error: ShellError::CantConvert(
"string".into(),
"duration".into(),
error: ShellError::CantConvert {
to_type: "string".into(),
from_type: "duration".into(),
span,
None,
),
help: None,
},
}
}
} else {

10
crates/nu-command/src/conversions/into/filesize.rs
View File

@@ -133,12 +133,12 @@ pub fn action(input: &Value, _args: &CellPathOnlyArgs, span: Span) -> Value {
fn int_from_string(a_string: &str, span: Span) -> Result<i64, ShellError> {
match a_string.trim().parse::<bytesize::ByteSize>() {
Ok(n) => Ok(n.0 as i64),
Err(_) => Err(ShellError::CantConvert(
"int".into(),
"string".into(),
Err(_) => Err(ShellError::CantConvert {
to_type: "int".into(),
from_type: "string".into(),
span,
None,
)),
help: None,
}),
}
}

69
crates/nu-command/src/conversions/into/int.rs
View File

@@ -187,12 +187,12 @@ fn action(input: &Value, args: &Arguments, span: Span) -> Value {
Ok(v) => v,
_ => {
return Value::Error {
error: ShellError::CantConvert(
"float".to_string(),
"integer".to_string(),
error: ShellError::CantConvert {
to_type: "float".to_string(),
from_type: "integer".to_string(),
span,
None,
),
help: None,
},
}
}
}
@@ -277,12 +277,12 @@ fn convert_int(input: &Value, head: Span, radix: u32) -> Value {
Ok(n) => return Value::int(n, head),
Err(e) => {
return Value::Error {
error: ShellError::CantConvert(
"string".to_string(),
"int".to_string(),
head,
Some(e.to_string()),
),
error: ShellError::CantConvert {
to_type: "string".to_string(),
from_type: "int".to_string(),
span: head,
help: Some(e.to_string()),
},
}
}
}
@@ -305,7 +305,12 @@ fn convert_int(input: &Value, head: Span, radix: u32) -> Value {
match i64::from_str_radix(i.trim(), radix) {
Ok(n) => Value::int(n, head),
Err(_reason) => Value::Error {
error: ShellError::CantConvert("string".to_string(), "int".to_string(), head, None),
error: ShellError::CantConvert {
to_type: "string".to_string(),
from_type: "int".to_string(),
span: head,
help: None,
},
},
}
}
@@ -317,12 +322,12 @@ fn int_from_string(a_string: &str, span: Span) -> Result<i64, ShellError> {
let num = match i64::from_str_radix(b.trim_start_matches("0b"), 2) {
Ok(n) => n,
Err(_reason) => {
return Err(ShellError::CantConvert(
"int".to_string(),
"string".to_string(),
return Err(ShellError::CantConvert {
to_type: "int".to_string(),
from_type: "string".to_string(),
span,
Some(r#"digits following "0b" can only be 0 or 1"#.to_string()),
))
help: Some(r#"digits following "0b" can only be 0 or 1"#.to_string()),
})
}
};
Ok(num)
@@ -331,15 +336,15 @@ fn int_from_string(a_string: &str, span: Span) -> Result<i64, ShellError> {
let num =
match i64::from_str_radix(h.trim_start_matches("0x"), 16) {
Ok(n) => n,
Err(_reason) => return Err(ShellError::CantConvert(
"int".to_string(),
"string".to_string(),
Err(_reason) => return Err(ShellError::CantConvert {
to_type: "int".to_string(),
from_type: "string".to_string(),
span,
Some(
help: Some(
r#"hexadecimal digits following "0x" should be in 0-9, a-f, or A-F"#
.to_string(),
),
)),
}),
};
Ok(num)
}
@@ -347,12 +352,12 @@ fn int_from_string(a_string: &str, span: Span) -> Result<i64, ShellError> {
let num = match i64::from_str_radix(o.trim_start_matches("0o"), 8) {
Ok(n) => n,
Err(_reason) => {
return Err(ShellError::CantConvert(
"int".to_string(),
"string".to_string(),
return Err(ShellError::CantConvert {
to_type: "int".to_string(),
from_type: "string".to_string(),
span,
Some(r#"octal digits following "0o" should be in 0-7"#.to_string()),
))
help: Some(r#"octal digits following "0o" should be in 0-7"#.to_string()),
})
}
};
Ok(num)
@@ -361,14 +366,14 @@ fn int_from_string(a_string: &str, span: Span) -> Result<i64, ShellError> {
Ok(n) => Ok(n),
Err(_) => match a_string.parse::<f64>() {
Ok(f) => Ok(f as i64),
_ => Err(ShellError::CantConvert(
"int".to_string(),
"string".to_string(),
_ => Err(ShellError::CantConvert {
to_type: "int".to_string(),
from_type: "string".to_string(),
span,
Some(format!(
help: Some(format!(
r#"string "{trimmed}" does not represent a valid integer"#
)),
)),
}),
},
},
}

30
crates/nu-command/src/conversions/into/string.rs
View File

@@ -247,28 +247,28 @@ fn action(input: &Value, args: &Arguments, span: Span) -> Value {
span: _,
} => Value::Error {
// Watch out for CantConvert's argument order
error: ShellError::CantConvert(
"string".into(),
"record".into(),
error: ShellError::CantConvert {
to_type: "string".into(),
from_type: "record".into(),
span,
Some("try using the `to nuon` command".into()),
),
help: Some("try using the `to nuon` command".into()),
},
},
Value::Binary { .. } => Value::Error {
error: ShellError::CantConvert(
"string".into(),
"binary".into(),
error: ShellError::CantConvert {
to_type: "string".into(),
from_type: "binary".into(),
span,
Some("try using the `decode` command".into()),
),
help: Some("try using the `decode` command".into()),
},
},
x => Value::Error {
error: ShellError::CantConvert(
String::from("string"),
x.get_type().to_string(),
error: ShellError::CantConvert {
to_type: String::from("string"),
from_type: x.get_type().to_string(),
span,
None,
),
help: None,
},
},
}
}