mirror of
https://github.com/nushell/nushell.git
synced 2025-05-08 17:02:59 +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
59 lines
1.7 KiB
Rust
59 lines
1.7 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, SimplePluginCommand};
|
|
use nu_protocol::{Category, LabeledError, Signature, Value};
|
|
|
|
use crate::ExamplePlugin;
|
|
|
|
pub struct DisableGc;
|
|
|
|
impl SimplePluginCommand for DisableGc {
|
|
type Plugin = ExamplePlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"example disable-gc"
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Disable the plugin garbage collector for `example`"
|
|
}
|
|
|
|
fn extra_description(&self) -> &str {
|
|
"\
|
|
Plugins are garbage collected by default after a period of inactivity. This
|
|
behavior is configurable with `$env.config.plugin_gc.default`, or to change it
|
|
specifically for the example plugin, use
|
|
`$env.config.plugin_gc.plugins.example`.
|
|
|
|
This command demonstrates how plugins can control this behavior and disable GC
|
|
temporarily if they need to. It is still possible to stop the plugin explicitly
|
|
using `plugin stop example`."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name())
|
|
.switch("reset", "Turn the garbage collector back on", None)
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["example", "gc", "plugin_gc", "garbage"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &ExamplePlugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
_input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
let disabled = !call.has_flag("reset")?;
|
|
engine.set_gc_disabled(disabled)?;
|
|
Ok(Value::string(
|
|
format!(
|
|
"The plugin garbage collector for `example` is now *{}*.",
|
|
if disabled { "disabled" } else { "enabled" }
|
|
),
|
|
call.head,
|
|
))
|
|
}
|
|
}
|