01d30a416b
# Description
This is something that was discussed in the core team meeting last
Wednesday. @ayax79 is building `nu-plugin-polars` with all of the
dataframe commands into a plugin, and there are a lot of them, so it
would help to make the API more similar. At the same time, I think the
`Command` API is just better anyway. I don't think the difference is
justified, and the types for core commands have the benefit of requiring
less `.into()` because they often don't own their data
- Broke `signature()` up into `name()`, `usage()`, `extra_usage()`,
`search_terms()`, `examples()`
- `signature()` returns `nu_protocol::Signature`
- `examples()` returns `Vec<nu_protocol::Example>`
- `PluginSignature` and `PluginExample` no longer need to be used by
plugin developers
# User-Facing Changes
Breaking API for plugins yet again 😄
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 usage(&self) -> &str {
|
|
"Disable the plugin garbage collector for `example`"
|
|
}
|
|
|
|
fn extra_usage(&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,
|
|
))
|
|
}
|
|
}
|