forked from extern/nushell
a5c604c283
# Description Working on uniformizing the ending messages regarding methods usage() and extra_usage(). This is related to the issue https://github.com/nushell/nushell/issues/5066 after discussing it with @jntrnr # User-Facing Changes None. # 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.
92 lines
2.3 KiB
Rust
92 lines
2.3 KiB
Rust
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{Category, Example, PipelineData, ShellError, Signature, Span, Type, Value};
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"math abs"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("math abs")
|
|
.input_output_types(vec![(Type::Number, Type::Number)])
|
|
.vectorizes_over_list(true)
|
|
.category(Category::Math)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Returns the absolute value of a number."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["absolute", "modulus", "positive", "distance"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
input.map(
|
|
move |value| abs_helper(value, head),
|
|
engine_state.ctrlc.clone(),
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Compute absolute value of each number in a list of numbers",
|
|
example: "[-50 -100.0 25] | math abs",
|
|
result: Some(Value::List {
|
|
vals: vec![
|
|
Value::test_int(50),
|
|
Value::test_float(100.0),
|
|
Value::test_int(25),
|
|
],
|
|
span: Span::test_data(),
|
|
}),
|
|
}]
|
|
}
|
|
}
|
|
|
|
fn abs_helper(val: Value, head: Span) -> Value {
|
|
match val {
|
|
Value::Int { val, span } => Value::int(val.abs(), span),
|
|
Value::Float { val, span } => Value::Float {
|
|
val: val.abs(),
|
|
span,
|
|
},
|
|
Value::Duration { val, span } => Value::Duration {
|
|
val: val.abs(),
|
|
span,
|
|
},
|
|
Value::Error { .. } => val,
|
|
other => Value::Error {
|
|
error: ShellError::OnlySupportsThisInputType(
|
|
"numeric".into(),
|
|
other.get_type().to_string(),
|
|
head,
|
|
other.expect_span(),
|
|
),
|
|
},
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|