mirror of
https://github.com/nushell/nushell.git
synced 2025-07-18 07:04:48 +02:00
95b78eee25
# Description
The meaning of the word usage is specific to describing how a command
function is *used* and not a synonym for general description. Usage can
be used to describe the SYNOPSIS or EXAMPLES sections of a man page
where the permitted argument combinations are shown or example *uses*
are given.
Let's not confuse people and call it what it is a description.
Our `help` command already creates its own *Usage* section based on the
available arguments and doesn't refer to the description with usage.
# User-Facing Changes
`help commands` and `scope commands` will now use `description` or
`extra_description`
`usage`-> `description`
`extra_usage` -> `extra_description`
Breaking change in the plugin protocol:
In the signature record communicated with the engine.
`usage`-> `description`
`extra_usage` -> `extra_description`
The same rename also takes place for the methods on
`SimplePluginCommand` and `PluginCommand`
# Tests + Formatting
- Updated plugin protocol specific changes
# After Submitting
- [ ] update plugin protocol doc
111 lines
2.9 KiB
Rust
111 lines
2.9 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
#[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),
|
|
(Type::Duration, Type::Duration),
|
|
(
|
|
Type::List(Box::new(Type::Number)),
|
|
Type::List(Box::new(Type::Number)),
|
|
),
|
|
(
|
|
Type::List(Box::new(Type::Duration)),
|
|
Type::List(Box::new(Type::Duration)),
|
|
),
|
|
])
|
|
.allow_variants_without_examples(true)
|
|
.category(Category::Math)
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Returns the absolute value of a number."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["absolute", "modulus", "positive", "distance"]
|
|
}
|
|
|
|
fn is_const(&self) -> bool {
|
|
true
|
|
}
|
|
|
|
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.signals())
|
|
}
|
|
|
|
fn run_const(
|
|
&self,
|
|
working_set: &StateWorkingSet,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
input.map(
|
|
move |value| abs_helper(value, head),
|
|
working_set.permanent().signals(),
|
|
)
|
|
}
|
|
|
|
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(
|
|
vec![
|
|
Value::test_int(50),
|
|
Value::test_float(100.0),
|
|
Value::test_int(25),
|
|
],
|
|
Span::test_data(),
|
|
)),
|
|
}]
|
|
}
|
|
}
|
|
|
|
fn abs_helper(val: Value, head: Span) -> Value {
|
|
let span = val.span();
|
|
match val {
|
|
Value::Int { val, .. } => Value::int(val.abs(), span),
|
|
Value::Float { val, .. } => Value::float(val.abs(), span),
|
|
Value::Duration { val, .. } => Value::duration(val.abs(), span),
|
|
Value::Error { .. } => val,
|
|
other => Value::error(
|
|
ShellError::OnlySupportsThisInputType {
|
|
exp_input_type: "numeric".into(),
|
|
wrong_type: other.get_type().to_string(),
|
|
dst_span: head,
|
|
src_span: other.span(),
|
|
},
|
|
head,
|
|
),
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|