mirror of
https://github.com/nushell/nushell.git
synced 2025-07-15 22:05:51 +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
51 lines
1.3 KiB
Rust
51 lines
1.3 KiB
Rust
use std::sync::mpsc;
|
|
|
|
use nu_plugin::{EngineInterface, EvaluatedCall, PluginCommand};
|
|
use nu_protocol::{Category, LabeledError, PipelineData, Signature};
|
|
|
|
use crate::ExamplePlugin;
|
|
|
|
/// `example ctrlc`
|
|
pub struct Ctrlc;
|
|
|
|
impl PluginCommand for Ctrlc {
|
|
type Plugin = ExamplePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"example ctrlc"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Example command that demonstrates registering an interrupt signal handler"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name()).category(Category::Experimental)
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["example"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &ExamplePlugin,
|
|
engine: &EngineInterface,
|
|
_call: &EvaluatedCall,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
let (sender, receiver) = mpsc::channel::<()>();
|
|
let _guard = engine.register_signal_handler(Box::new(move |_| {
|
|
let _ = sender.send(());
|
|
}));
|
|
|
|
eprintln!("interrupt status: {:?}", engine.signals().interrupted());
|
|
eprintln!("waiting for interrupt signal...");
|
|
receiver.recv().expect("handler went away");
|
|
eprintln!("interrupt status: {:?}", engine.signals().interrupted());
|
|
eprintln!("peace.");
|
|
|
|
Ok(PipelineData::Empty)
|
|
}
|
|
}
|