forked from extern/nushell
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
67 lines
1.9 KiB
Rust
67 lines
1.9 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, PluginCommand};
|
|
use nu_protocol::{
|
|
Category, Example, LabeledError, ListStream, PipelineData, Signals, Signature, SyntaxShape,
|
|
Type, Value,
|
|
};
|
|
|
|
use crate::ExamplePlugin;
|
|
|
|
/// `example seq <first> <last>`
|
|
pub struct Seq;
|
|
|
|
impl PluginCommand for Seq {
|
|
type Plugin = ExamplePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"example seq"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Example stream generator for a list of values"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required("first", SyntaxShape::Int, "first number to generate")
|
|
.required("last", SyntaxShape::Int, "last number to generate")
|
|
.input_output_type(Type::Nothing, Type::List(Type::Int.into()))
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["example"]
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
example: "example seq 1 3",
|
|
description: "generate a sequence from 1 to 3",
|
|
result: Some(Value::test_list(vec![
|
|
Value::test_int(1),
|
|
Value::test_int(2),
|
|
Value::test_int(3),
|
|
])),
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &ExamplePlugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
let head = call.head;
|
|
let first: i64 = call.req(0)?;
|
|
let last: i64 = call.req(1)?;
|
|
let iter = (first..=last).map(move |number| Value::int(number, head));
|
|
Ok(ListStream::new(iter, head, Signals::empty()).into())
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_examples() -> Result<(), nu_protocol::ShellError> {
|
|
use nu_plugin_test_support::PluginTest;
|
|
PluginTest::new("example", ExamplePlugin.into())?.test_command_examples(&Seq)
|
|
}
|