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

Use int type name consistently (#10579)

Browse Source 
# Description
When referring to the type use `int` consistently. Only when referring
to the concept of integer numbers use `integer`.

- Fix `random integer` to `random int` tests
  - Forgot in #10520
- Use int instead of integer in error messages
- Use int type name in bits commands
- Fix messages in `for` examples
- Use int typename in `into` commands
- Use int typename in rest of commands
- Report errors in `nu-protocol` with int typename

Work for #10332 

# User-Facing Changes
User errorrs should now use `int` so you can easily find the necessary
commands or type annotations.

# Tests + Formatting
Only two tests found that needed updating
This commit is contained in:
Stefan Holderbach
2023-10-03 18:24:32 +02:00
committed by GitHub
parent 2cc4191ec9
commit 7c1487e18d
36 changed files with 77 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
crates/nu-command/src/conversions/into/binary.rs
View File

@ -115,8 +115,7 @@ impl Command for SubCommand {
)),
},
Example {
description:
"convert an integer to a nushell binary primitive with compact enabled",
description: "convert an int to a nushell binary primitive with compact enabled",
example: "10 | into binary --compact",
result: Some(Value::binary(vec![10], Span::test_data())),
},
@ -172,7 +171,7 @@ pub fn action(input: &Value, _args: &Arguments, span: Span) -> Value {
Value::Error { .. } => input.clone(),
other => Value::error(
ShellError::OnlySupportsThisInputType {
exp_input_type: "integer, float, filesize, string, date, duration, binary or bool"
exp_input_type: "int, float, filesize, string, date, duration, binary, or bool"
.into(),
wrong_type: other.get_type().to_string(),
dst_span: span,

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

@ -90,7 +90,7 @@ impl Command for SubCommand {
result: Some(Value::bool(true, span)),
},
Example {
description: "convert integer to boolean",
description: "convert int to boolean",
example: "1 | into bool",
result: Some(Value::bool(true, span)),
},
@ -159,7 +159,7 @@ fn action(input: &Value, _args: &CellPathOnlyArgs, span: Span) -> Value {
Value::Error { .. } => input.clone(),
other => Value::error(
ShellError::OnlySupportsThisInputType {
exp_input_type: "bool, integer, float or string".into(),
exp_input_type: "bool, int, float or string".into(),
wrong_type: other.get_type().to_string(),
dst_span: span,
src_span: other.span(),

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

@ -256,7 +256,7 @@ fn action(input: &Value, args: &Arguments, head: Span) -> Value {
other => {
return Value::error(
ShellError::OnlySupportsThisInputType {
exp_input_type: "string and integer".into(),
exp_input_type: "string and int".into(),
wrong_type: other.get_type().to_string(),
dst_span: head,
src_span: other.span(),

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

@ -138,7 +138,7 @@ fn action(input: &Value, _args: &CellPathOnlyArgs, head: Span) -> Value {
Value::Error { .. } => input.clone(),
other => Value::error(
ShellError::OnlySupportsThisInputType {
exp_input_type: "string, integer or bool".into(),
exp_input_type: "string, int, or bool".into(),
wrong_type: other.get_type().to_string(),
dst_span: head,
src_span: other.span(),

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

@ -136,7 +136,7 @@ pub fn action(input: &Value, _args: &CellPathOnlyArgs, span: Span) -> Value {
Value::Nothing { .. } => Value::filesize(0, value_span),
other => Value::error(
ShellError::OnlySupportsThisInputType {
exp_input_type: "string and integer".into(),
exp_input_type: "string and int".into(),
wrong_type: other.get_type().to_string(),
dst_span: span,
src_span: value_span,

2
crates/nu-command/src/conversions/into/float.rs
View File

@ -121,7 +121,7 @@ fn action(input: &Value, _args: &CellPathOnlyArgs, head: Span) -> Value {
Value::Error { .. } => input.clone(),
other => Value::error(
ShellError::OnlySupportsThisInputType {
exp_input_type: "string, integer or bool".into(),
exp_input_type: "string, int or bool".into(),
wrong_type: other.get_type().to_string(),
dst_span: head,
src_span: other.span(),

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

@ -158,32 +158,32 @@ impl Command for SubCommand {
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Convert string to integer in table",
description: "Convert string to int in table",
example: "[[num]; ['-5'] [4] [1.5]] | into int num",
result: None,
},
Example {
description: "Convert string to integer",
description: "Convert string to int",
example: "'2' | into int",
result: Some(Value::test_int(2)),
},
Example {
description: "Convert float to integer",
description: "Convert float to int",
example: "5.9 | into int",
result: Some(Value::test_int(5)),
},
Example {
description: "Convert decimal string to integer",
description: "Convert decimal string to int",
example: "'5.9' | into int",
result: Some(Value::test_int(5)),
},
Example {
description: "Convert file size to integer",
description: "Convert file size to int",
example: "4KB | into int",
result: Some(Value::test_int(4000)),
},
Example {
description: "Convert bool to integer",
description: "Convert bool to int",
example: "[false, true] | into int",
result: Some(Value::list(
vec![Value::test_int(0), Value::test_int(1)],
@ -191,32 +191,32 @@ impl Command for SubCommand {
)),
},
Example {
description: "Convert date to integer (Unix nanosecond timestamp)",
description: "Convert date to int (Unix nanosecond timestamp)",
example: "1983-04-13T12:09:14.123456789-05:00 | into int",
result: Some(Value::test_int(419101754123456789)),
},
Example {
description: "Convert to integer from binary",
description: "Convert to int from binary data (radix: 2)",
example: "'1101' | into int -r 2",
result: Some(Value::test_int(13)),
},
Example {
description: "Convert to integer from hex",
description: "Convert to int from hex",
example: "'FF' | into int -r 16",
result: Some(Value::test_int(255)),
},
Example {
description: "Convert octal string to integer",
description: "Convert octal string to int",
example: "'0o10132' | into int",
result: Some(Value::test_int(4186)),
},
Example {
description: "Convert 0 padded string to integer",
description: "Convert 0 padded string to int",
example: "'0010132' | into int",
result: Some(Value::test_int(10132)),
},
Example {
description: "Convert 0 padded string to integer with radix",
description: "Convert 0 padded string to int with radix 8",
example: "'0010132' | into int -r 8",
result: Some(Value::test_int(4186)),
},
@ -248,7 +248,7 @@ fn action(input: &Value, args: &Arguments, span: Span) -> Value {
return Value::error(
ShellError::CantConvert {
to_type: "float".to_string(),
from_type: "integer".to_string(),
from_type: "int".to_string(),
span,
help: None,
},
@ -327,7 +327,7 @@ fn action(input: &Value, args: &Arguments, span: Span) -> Value {
Value::Error { .. } => input.clone(),
other => Value::error(
ShellError::OnlySupportsThisInputType {
exp_input_type: "integer, float, filesize, date, string, binary, duration or bool"
exp_input_type: "int, float, filesize, date, string, binary, duration, or bool"
.into(),
wrong_type: other.get_type().to_string(),
dst_span: span,
@ -376,7 +376,7 @@ fn convert_int(input: &Value, head: Span, radix: u32) -> Value {
other => {
return Value::error(
ShellError::OnlySupportsThisInputType {
exp_input_type: "string and integer".into(),
exp_input_type: "string and int".into(),
wrong_type: other.get_type().to_string(),
dst_span: head,
src_span: other.span(),

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

@ -84,7 +84,7 @@ impl Command for SubCommand {
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "convert integer to string and append three decimal places",
description: "convert int to string and append three decimal places",
example: "5 | into string -d 3",
result: Some(Value::test_string("5.000")),
},

8
crates/nu-command/src/filters/append.rs
View File

@ -41,7 +41,7 @@ only unwrap the outer list, and leave the variable's contents untouched."#
vec![
Example {
example: "[0 1 2 3] | append 4",
description: "Append one integer to a list",
description: "Append one int to a list",
result: Some(Value::test_list(vec![
Value::test_int(0),
Value::test_int(1),
@ -70,7 +70,7 @@ only unwrap the outer list, and leave the variable's contents untouched."#
},
Example {
example: "[0 1] | append [2 3 4]",
description: "Append three integer items",
description: "Append three int items",
result: Some(Value::test_list(vec![
Value::test_int(0),
Value::test_int(1),
@ -81,7 +81,7 @@ only unwrap the outer list, and leave the variable's contents untouched."#
},
Example {
example: "[0 1] | append [2 nu 4 shell]",
description: "Append integers and strings",
description: "Append ints and strings",
result: Some(Value::test_list(vec![
Value::test_int(0),
Value::test_int(1),
@ -93,7 +93,7 @@ only unwrap the outer list, and leave the variable's contents untouched."#
},
Example {
example: "[0 1] | append 2..4",
description: "Append a range of integers to a list",
description: "Append a range of ints to a list",
result: Some(Value::test_list(vec![
Value::test_int(0),
Value::test_int(1),

2
crates/nu-command/src/filters/drop/nth.rs
View File

@ -122,7 +122,7 @@ impl Command for DropNth {
if from.is_negative() || to.is_negative() {
let span: Spanned<Range> = call.req(engine_state, stack, 0)?;
return Err(ShellError::TypeMismatch {
err_message: "drop nth accepts only positive integers".to_string(),
err_message: "drop nth accepts only positive ints".to_string(),
span: span.span,
});
}

6
crates/nu-command/src/filters/prepend.rs
View File

@ -62,7 +62,7 @@ only unwrap the outer list, and leave the variable's contents untouched."#
},
Example {
example: "[1 2 3 4] | prepend 0",
description: "Prepend one integer item",
description: "Prepend one int item",
result: Some(Value::test_list(vec![
Value::test_int(0),
Value::test_int(1),
@ -73,7 +73,7 @@ only unwrap the outer list, and leave the variable's contents untouched."#
},
Example {
example: "[2 3 4] | prepend [0 1]",
description: "Prepend two integer items",
description: "Prepend two int items",
result: Some(Value::test_list(vec![
Value::test_int(0),
Value::test_int(1),
@ -84,7 +84,7 @@ only unwrap the outer list, and leave the variable's contents untouched."#
},
Example {
example: "[2 nu 4 shell] | prepend [0 1 rocks]",
description: "Prepend integers and strings",
description: "Prepend ints and strings",
result: Some(Value::test_list(vec![
Value::test_int(0),
Value::test_int(1),

6
crates/nu-command/src/filters/skip/skip_.rs
View File

@ -80,15 +80,13 @@ impl Command for Skip {
match v {
Value::Int { val, .. } => {
val.try_into().map_err(|err| ShellError::TypeMismatch {
err_message: format!(
"Could not convert {val} to unsigned integer: {err}"
),
err_message: format!("Could not convert {val} to unsigned int: {err}"),
span,
})?
}
_ => {
return Err(ShellError::TypeMismatch {
err_message: "expected integer".into(),
err_message: "expected int".into(),
span,
})
}

2
crates/nu-command/src/formats/to/nuon.rs
View File

@ -97,7 +97,7 @@ impl Command for ToNuon {
result: Some(Value::test_string("[1, 2, 3]"))
},
Example {
description: "Outputs a NUON array of integers, with pretty indentation",
description: "Outputs a NUON array of ints, with pretty indentation",
example: "[1 2 3] | to nuon --indent 2",
result: Some(Value::test_string("[\n 1,\n 2,\n 3\n]")),
},

4
crates/nu-command/src/generators/seq_date.rs
View File

@ -283,8 +283,8 @@ pub fn run_seq_dates(
Some(date) => date,
None => {
return Err(ShellError::GenericError(
"integer value too large".to_string(),
"integer value too large".to_string(),
"int value too large".to_string(),
"int value too large".to_string(),
Some(call_span),
None,
Vec::new(),

2
crates/nu-command/src/math/utils.rs
View File

@ -108,7 +108,7 @@ pub fn calculate(
PipelineData::Value(val, ..) => mf(&[val], span, name),
PipelineData::Empty { .. } => Err(ShellError::PipelineEmpty { dst_span: name }),
val => Err(ShellError::UnsupportedInput(
"Only integers, floats, lists, records or ranges are supported".into(),
"Only ints, floats, lists, records, or ranges are supported".into(),
"value originates from here".into(),
name,
// This requires both the ListStream and Empty match arms to be above it.

3
crates/nu-command/src/math/variance.rs
View File

@ -66,8 +66,7 @@ fn sum_of_squares(values: &[Value], span: Span) -> Result<Value, ShellError> {
Value::Int { .. } | Value::Float { .. } => Ok(value),
Value::Error { error, .. } => Err(*error.clone()),
_ => Err(ShellError::UnsupportedInput(
"Attempted to compute the sum of squares of a non-integer, non-float value"
.to_string(),
"Attempted to compute the sum of squares of a non-int, non-float value".to_string(),
"value originates from here".into(),
span,
value.span(),

2
crates/nu-command/src/network/http/client.rs
View File

@ -288,7 +288,7 @@ pub fn request_set_timeout(
let val = timeout.as_i64()?;
if val.is_negative() || val < 1 {
return Err(ShellError::TypeMismatch {
err_message: "Timeout value must be an integer and larger than 0".to_string(),
err_message: "Timeout value must be an int and larger than 0".to_string(),
span: timeout.span(),
});
}

4
crates/nu-command/src/network/url/join.rs
View File

@ -158,7 +158,7 @@ impl UrlComponents {
}),
Err(_) => Err(ShellError::IncompatibleParametersSingle {
msg: String::from(
"Port parameter should represent an unsigned integer",
"Port parameter should represent an unsigned int",
),
span: value_span,
}),
@ -172,7 +172,7 @@ impl UrlComponents {
Value::Error { error, .. } => Err(*error),
other => Err(ShellError::IncompatibleParametersSingle {
msg: String::from(
"Port parameter should be an unsigned integer or a string representing it",
"Port parameter should be an unsigned int or a string representing it",
),
span: other.span(),
}),