mirror of
https://github.com/nushell/nushell
synced 2024-12-28 14:03:09 +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
90 lines
2.4 KiB
Rust
90 lines
2.4 KiB
Rust
use nu_plugin::*;
|
|
use nu_plugin_test_support::PluginTest;
|
|
use nu_protocol::{
|
|
Example, IntoInterruptiblePipelineData, LabeledError, PipelineData, ShellError, Signals,
|
|
Signature, Span, Type, Value,
|
|
};
|
|
|
|
struct LowercasePlugin;
|
|
struct Lowercase;
|
|
|
|
impl PluginCommand for Lowercase {
|
|
type Plugin = LowercasePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"lowercase"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Convert each string in a stream to lowercase"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name()).input_output_type(
|
|
Type::List(Type::String.into()),
|
|
Type::List(Type::String.into()),
|
|
)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
example: r#"[Hello wORLD] | lowercase"#,
|
|
description: "Lowercase a list of strings",
|
|
result: Some(Value::test_list(vec![
|
|
Value::test_string("hello"),
|
|
Value::test_string("world"),
|
|
])),
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &LowercasePlugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
let span = call.head;
|
|
Ok(input.map(
|
|
move |value| {
|
|
value
|
|
.as_str()
|
|
.map(|string| Value::string(string.to_lowercase(), span))
|
|
// Errors in a stream should be returned as values.
|
|
.unwrap_or_else(|err| Value::error(err, span))
|
|
},
|
|
&Signals::empty(),
|
|
)?)
|
|
}
|
|
}
|
|
|
|
impl Plugin for LowercasePlugin {
|
|
fn version(&self) -> String {
|
|
"0.0.0".into()
|
|
}
|
|
|
|
fn commands(&self) -> Vec<Box<dyn PluginCommand<Plugin = Self>>> {
|
|
vec![Box::new(Lowercase)]
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_lowercase_using_eval_with() -> Result<(), ShellError> {
|
|
let result = PluginTest::new("lowercase", LowercasePlugin.into())?.eval_with(
|
|
"lowercase",
|
|
vec![Value::test_string("HeLlO wOrLd")]
|
|
.into_pipeline_data(Span::test_data(), Signals::empty()),
|
|
)?;
|
|
|
|
assert_eq!(
|
|
Value::test_list(vec![Value::test_string("hello world")]),
|
|
result.into_value(Span::test_data())?
|
|
);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
#[test]
|
|
fn test_lowercase_examples() -> Result<(), ShellError> {
|
|
PluginTest::new("lowercase", LowercasePlugin.into())?.test_command_examples(&Lowercase)
|
|
}
|