mirror of
https://github.com/nushell/nushell.git
synced 2025-03-26 15:26:51 +01: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
72 lines
2.2 KiB
Rust
72 lines
2.2 KiB
Rust
use crate::{second_custom_value::SecondCustomValue, CustomValuePlugin};
|
|
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{Category, Example, LabeledError, Signature, Span, SyntaxShape, Value};
|
|
|
|
pub struct Generate2;
|
|
|
|
impl SimplePluginCommand for Generate2 {
|
|
type Plugin = CustomValuePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"custom-value generate2"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"PluginSignature for a plugin that generates a different custom value"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.optional(
|
|
"closure",
|
|
SyntaxShape::Closure(Some(vec![SyntaxShape::Any])),
|
|
"An optional closure to pass the custom value to",
|
|
)
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
example: "custom-value generate2",
|
|
description: "Generate a new SecondCustomValue",
|
|
result: Some(SecondCustomValue::new("xyz").into_value(Span::test_data())),
|
|
},
|
|
Example {
|
|
example: "custom-value generate2 { print }",
|
|
description: "Generate a new SecondCustomValue and pass it to a closure",
|
|
result: None,
|
|
},
|
|
]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &CustomValuePlugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
let second_custom_value = SecondCustomValue::new("xyz").into_value(call.head);
|
|
// If we were passed a closure, execute that instead
|
|
if let Some(closure) = call.opt(0)? {
|
|
let result = engine.eval_closure(
|
|
&closure,
|
|
vec![second_custom_value.clone()],
|
|
Some(second_custom_value),
|
|
)?;
|
|
Ok(result)
|
|
} else {
|
|
Ok(second_custom_value)
|
|
}
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_examples() -> Result<(), nu_protocol::ShellError> {
|
|
use nu_plugin_test_support::PluginTest;
|
|
|
|
PluginTest::new("custom_values", crate::CustomValuePlugin::new().into())?
|
|
.test_command_examples(&Generate2)
|
|
}
|