mirror of
https://github.com/nushell/nushell
synced 2025-01-08 19:29:08 +00:00
7071617f18
# Description
When nushell calls a plugin it now sends a configuration `Value` from
the nushell config under `$env.config.plugins.PLUGIN_SHORT_NAME`. This
allows plugin authors to read configuration provided by plugin users.
The `PLUGIN_SHORT_NAME` must match the registered filename after
`nu_plugin_`. If you register `target/debug/nu_plugin_config` the
`PLUGIN_NAME` will be `config` and the nushell config will loook like:
$env.config = {
# ...
plugins: {
config: [
some
values
]
}
}
Configuration may also use a closure which allows passing values from
`$env` to a plugin:
$env.config = {
# ...
plugins: {
config: {||
$env.some_value
}
}
}
This is a breaking change for the plugin API as the `Plugin::run()`
function now accepts a new configuration argument which is an
`&Option<Value>`. If no configuration was supplied the value is `None`.
Plugins compiled after this change should work with older nushell, and
will behave as if the configuration was not set.
Initially discussed in #10867
# User-Facing Changes
* Plugins can read configuration data stored in `$env.config.plugins`
* The plugin `CallInfo` now includes a `config` entry, existing plugins
will require updates
# Tests + Formatting
- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
- 🟢 `toolkit test`
- 🟢 `toolkit test stdlib`
# After Submitting
- [ ] Update [Creating a plugin (in
Rust)](https://www.nushell.sh/contributor-book/plugins.html#creating-a-plugin-in-rust)
[source](https://github.com/nushell/nushell.github.io/blob/main/contributor-book/plugins.md)
- [ ] Add "Configuration" section to [Plugins
documentation](https://www.nushell.sh/contributor-book/plugins.html)
60 lines
2.4 KiB
Rust
60 lines
2.4 KiB
Rust
mod from;
|
|
|
|
use from::{eml, ics, ini, vcf};
|
|
use nu_plugin::{EvaluatedCall, LabeledError, Plugin};
|
|
use nu_protocol::{Category, PluginSignature, SyntaxShape, Type, Value};
|
|
|
|
pub struct FromCmds;
|
|
|
|
impl Plugin for FromCmds {
|
|
fn signature(&self) -> Vec<PluginSignature> {
|
|
vec![
|
|
PluginSignature::build(eml::CMD_NAME)
|
|
.input_output_types(vec![(Type::String, Type::Record(vec![]))])
|
|
.named(
|
|
"preview-body",
|
|
SyntaxShape::Int,
|
|
"How many bytes of the body to preview",
|
|
Some('b'),
|
|
)
|
|
.usage("Parse text as .eml and create record.")
|
|
.plugin_examples(eml::examples())
|
|
.category(Category::Formats),
|
|
PluginSignature::build(ics::CMD_NAME)
|
|
.input_output_types(vec![(Type::String, Type::Table(vec![]))])
|
|
.usage("Parse text as .ics and create table.")
|
|
.plugin_examples(ics::examples())
|
|
.category(Category::Formats),
|
|
PluginSignature::build(vcf::CMD_NAME)
|
|
.input_output_types(vec![(Type::String, Type::Table(vec![]))])
|
|
.usage("Parse text as .vcf and create table.")
|
|
.plugin_examples(vcf::examples())
|
|
.category(Category::Formats),
|
|
PluginSignature::build(ini::CMD_NAME)
|
|
.input_output_types(vec![(Type::String, Type::Record(vec![]))])
|
|
.usage("Parse text as .ini and create table.")
|
|
.plugin_examples(ini::examples())
|
|
.category(Category::Formats),
|
|
]
|
|
}
|
|
|
|
fn run(
|
|
&mut self,
|
|
name: &str,
|
|
_config: &Option<Value>,
|
|
call: &EvaluatedCall,
|
|
input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
match name {
|
|
eml::CMD_NAME => eml::from_eml_call(call, input),
|
|
ics::CMD_NAME => ics::from_ics_call(call, input),
|
|
vcf::CMD_NAME => vcf::from_vcf_call(call, input),
|
|
ini::CMD_NAME => ini::from_ini_call(call, input),
|
|
_ => Err(LabeledError {
|
|
label: "Plugin call with wrong name signature".into(),
|
|
msg: "the signature used to call the plugin does not match any name in the plugin signature vector".into(),
|
|
span: Some(call.head),
|
|
}),
|
|
}
|
|
}
|
|
}
|