mirror of
https://github.com/nushell/nushell
synced 2025-01-28 12:55:40 +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
47 lines
1.2 KiB
Rust
47 lines
1.2 KiB
Rust
use std::sync::atomic;
|
|
|
|
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{LabeledError, Signature, Type, Value};
|
|
|
|
use crate::{handle_custom_value::HandleCustomValue, CustomValuePlugin};
|
|
|
|
pub struct HandleMake;
|
|
|
|
impl SimplePluginCommand for HandleMake {
|
|
type Plugin = CustomValuePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"custom-value handle make"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.input_output_type(Type::Any, Type::Custom("HandleCustomValue".into()))
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Store a value in plugin memory and return a handle to it"
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
plugin: &Self::Plugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
// 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, input.clone());
|
|
|
|
Ok(Value::custom(
|
|
Box::new(HandleCustomValue(new_id)),
|
|
call.head,
|
|
))
|
|
}
|
|
}
|