mirror of
https://github.com/nushell/nushell.git
synced 2025-04-29 23:54:26 +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
89 lines
2.1 KiB
Rust
89 lines
2.1 KiB
Rust
use crate::CustomValuePlugin;
|
|
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{
|
|
record, Category, CustomValue, LabeledError, ShellError, Signature, Span, SyntaxShape, Value,
|
|
};
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
#[derive(Clone, Debug, Serialize, Deserialize)]
|
|
pub struct DropCheckValue {
|
|
pub(crate) msg: String,
|
|
}
|
|
|
|
impl DropCheckValue {
|
|
pub(crate) fn new(msg: String) -> DropCheckValue {
|
|
DropCheckValue { msg }
|
|
}
|
|
|
|
pub(crate) fn into_value(self, span: Span) -> Value {
|
|
Value::custom(Box::new(self), span)
|
|
}
|
|
|
|
pub(crate) fn notify(&self) {
|
|
eprintln!("DropCheckValue was dropped: {}", self.msg);
|
|
}
|
|
}
|
|
|
|
#[typetag::serde]
|
|
impl CustomValue for DropCheckValue {
|
|
fn clone_value(&self, span: Span) -> Value {
|
|
self.clone().into_value(span)
|
|
}
|
|
|
|
fn type_name(&self) -> String {
|
|
"DropCheckValue".into()
|
|
}
|
|
|
|
fn to_base_value(&self, span: Span) -> Result<Value, ShellError> {
|
|
Ok(Value::record(
|
|
record! {
|
|
"msg" => Value::string(&self.msg, span)
|
|
},
|
|
span,
|
|
))
|
|
}
|
|
|
|
fn as_any(&self) -> &dyn std::any::Any {
|
|
self
|
|
}
|
|
|
|
fn as_mut_any(&mut self) -> &mut dyn std::any::Any {
|
|
self
|
|
}
|
|
|
|
fn notify_plugin_on_drop(&self) -> bool {
|
|
// This is what causes Nushell to let us know when the value is dropped
|
|
true
|
|
}
|
|
}
|
|
|
|
pub struct DropCheck;
|
|
|
|
impl SimplePluginCommand for DropCheck {
|
|
type Plugin = CustomValuePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"custom-value drop-check"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Generates a custom value that prints a message when dropped"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.required("msg", SyntaxShape::String, "the message to print on drop")
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &Self::Plugin,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
Ok(DropCheckValue::new(call.req(0)?).into_value(call.head))
|
|
}
|
|
}
|