mirror of
https://github.com/nushell/nushell.git
synced 2025-04-25 13:48:19 +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
91 lines
2.8 KiB
Rust
91 lines
2.8 KiB
Rust
use std::sync::atomic;
|
|
|
|
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{
|
|
engine::Closure, LabeledError, ShellError, Signature, Spanned, SyntaxShape, Type, Value,
|
|
};
|
|
|
|
use crate::{handle_custom_value::HandleCustomValue, CustomValuePlugin};
|
|
|
|
pub struct HandleUpdate;
|
|
|
|
impl SimplePluginCommand for HandleUpdate {
|
|
type Plugin = CustomValuePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"custom-value handle update"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_type(
|
|
Type::Custom("HandleCustomValue".into()),
|
|
Type::Custom("HandleCustomValue".into()),
|
|
)
|
|
.required(
|
|
"closure",
|
|
SyntaxShape::Closure(Some(vec![SyntaxShape::Any])),
|
|
"the closure to run on the value",
|
|
)
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Update the value in a handle and return a new handle with the result"
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
plugin: &Self::Plugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
let closure: Spanned<Closure> = call.req(0)?;
|
|
|
|
if let Some(handle) = input
|
|
.as_custom_value()?
|
|
.as_any()
|
|
.downcast_ref::<HandleCustomValue>()
|
|
{
|
|
// Find the handle
|
|
let value = plugin
|
|
.handles
|
|
.lock()
|
|
.map_err(|err| LabeledError::new(err.to_string()))?
|
|
.get(&handle.0)
|
|
.cloned();
|
|
|
|
if let Some(value) = value {
|
|
// Call the closure with the value
|
|
let new_value = engine.eval_closure(&closure, vec![value.clone()], Some(value))?;
|
|
|
|
// Generate an id and store in the plugin.
|
|
let new_id = plugin.counter.fetch_add(1, atomic::Ordering::Relaxed);
|
|
|
|
plugin
|
|
.handles
|
|
.lock()
|
|
.map_err(|err| LabeledError::new(err.to_string()))?
|
|
.insert(new_id, new_value);
|
|
|
|
Ok(Value::custom(
|
|
Box::new(HandleCustomValue(new_id)),
|
|
call.head,
|
|
))
|
|
} else {
|
|
Err(LabeledError::new("Handle expired")
|
|
.with_label("this handle is no longer valid", input.span())
|
|
.with_help("the plugin may have exited, or there was a bug"))
|
|
}
|
|
} else {
|
|
Err(ShellError::UnsupportedInput {
|
|
msg: "requires HandleCustomValue".into(),
|
|
input: format!("got {}", input.get_type()),
|
|
msg_span: call.head,
|
|
input_span: input.span(),
|
|
}
|
|
.into())
|
|
}
|
|
}
|
|
}
|