mirror of
https://github.com/nushell/nushell.git
synced 2025-05-08 17:02:59 +00: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
68 lines
1.8 KiB
Rust
68 lines
1.8 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, PluginCommand};
|
|
use nu_protocol::{
|
|
ByteStream, ByteStreamType, Category, Example, LabeledError, PipelineData, Signals, Signature,
|
|
Type, Value,
|
|
};
|
|
|
|
use crate::ExamplePlugin;
|
|
|
|
/// `<list<string>> | example collect-bytes`
|
|
pub struct CollectBytes;
|
|
|
|
impl PluginCommand for CollectBytes {
|
|
type Plugin = ExamplePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"example collect-bytes"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Example transformer to byte stream"
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["example"]
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_types(vec![
|
|
(Type::List(Type::String.into()), Type::String),
|
|
(Type::List(Type::Binary.into()), Type::Binary),
|
|
])
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
example: "[a b] | example collect-bytes",
|
|
description: "collect strings into one stream",
|
|
result: Some(Value::test_string("ab")),
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &ExamplePlugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
Ok(PipelineData::ByteStream(
|
|
ByteStream::from_result_iter(
|
|
input.into_iter().map(Value::coerce_into_binary),
|
|
call.head,
|
|
Signals::empty(),
|
|
ByteStreamType::Unknown,
|
|
),
|
|
None,
|
|
))
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_examples() -> Result<(), nu_protocol::ShellError> {
|
|
use nu_plugin_test_support::PluginTest;
|
|
PluginTest::new("example", ExamplePlugin.into())?.test_command_examples(&CollectBytes)
|
|
}
|