forked from extern/nushell
99076af18b
# Description _(Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes.)_ I opened this PR to unify the run command method. It's mainly to improve consistency across the tree. # 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.
71 lines
1.8 KiB
Rust
71 lines
1.8 KiB
Rust
use crate::math::reducers::{reducer_for, Reduce};
|
|
use crate::math::utils::run_with_function;
|
|
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 sum"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("math sum")
|
|
.input_output_types(vec![(Type::List(Box::new(Type::Number)), Type::Number)])
|
|
.category(Category::Math)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Returns the sum of a list of numbers or of each column in a table"
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["plus", "add", "total", "+"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
run_with_function(call, input, summation)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Sum a list of numbers",
|
|
example: "[1 2 3] | math sum",
|
|
result: Some(Value::test_int(6)),
|
|
},
|
|
Example {
|
|
description: "Get the disk usage for the current directory",
|
|
example: "ls | get size | math sum",
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
}
|
|
|
|
pub fn summation(values: &[Value], span: Span, head: &Span) -> Result<Value, ShellError> {
|
|
let sum_func = reducer_for(Reduce::Summation);
|
|
sum_func(Value::nothing(*head), values.to_vec(), span, *head)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|