mirror of
https://github.com/nushell/nushell.git
synced 2025-04-10 22:18:17 +02:00
# Description This allows plugins to report their version (and potentially other metadata in the future). The version is shown in `plugin list` and in `version`. The metadata is stored in the registry file, and reflects whatever was retrieved on `plugin add`, not necessarily the running binary. This can help you to diagnose if there's some kind of mismatch with what you expect. We could potentially use this functionality to show a warning or error if a plugin being run does not have the same version as what was in the cache file, suggesting `plugin add` be run again, but I haven't done that at this point. It is optional, and it requires the plugin author to make some code changes if they want to provide it, since I can't automatically determine the version of the calling crate or anything tricky like that to do it. Example: ``` > plugin list | select name version is_running pid ╭───┬────────────────┬─────────┬────────────┬─────╮ │ # │ name │ version │ is_running │ pid │ ├───┼────────────────┼─────────┼────────────┼─────┤ │ 0 │ example │ 0.93.1 │ false │ │ │ 1 │ gstat │ 0.93.1 │ false │ │ │ 2 │ inc │ 0.93.1 │ false │ │ │ 3 │ python_example │ 0.1.0 │ false │ │ ╰───┴────────────────┴─────────┴────────────┴─────╯ ``` cc @maxim-uvarov (he asked for it) # User-Facing Changes - `plugin list` gets a `version` column - `version` shows plugin versions when available - plugin authors *should* add `fn metadata()` to their `impl Plugin`, but don't have to # Tests + Formatting Tested the low level stuff and also the `plugin list` column. # After Submitting - [ ] update plugin guide docs - [ ] update plugin protocol docs (`Metadata` call & response) - [ ] update plugin template (`fn metadata()` should be easy) - [ ] release notes
47 lines
1.3 KiB
Rust
47 lines
1.3 KiB
Rust
use crate::GStat;
|
|
use nu_plugin::{EngineInterface, EvaluatedCall, Plugin, PluginCommand, SimplePluginCommand};
|
|
use nu_protocol::{Category, LabeledError, Signature, Spanned, SyntaxShape, Value};
|
|
|
|
pub struct GStatPlugin;
|
|
|
|
impl Plugin for GStatPlugin {
|
|
fn version(&self) -> String {
|
|
env!("CARGO_PKG_VERSION").into()
|
|
}
|
|
|
|
fn commands(&self) -> Vec<Box<dyn PluginCommand<Plugin = Self>>> {
|
|
vec![Box::new(GStat)]
|
|
}
|
|
}
|
|
|
|
impl SimplePluginCommand for GStat {
|
|
type Plugin = GStatPlugin;
|
|
|
|
fn name(&self) -> &str {
|
|
"gstat"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Get the git status of a repo"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(PluginCommand::name(self))
|
|
.optional("path", SyntaxShape::Filepath, "path to repo")
|
|
.category(Category::Custom("prompt".to_string()))
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &GStatPlugin,
|
|
engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: &Value,
|
|
) -> Result<Value, LabeledError> {
|
|
let repo_path: Option<Spanned<String>> = call.opt(0)?;
|
|
// eprintln!("input value: {:#?}", &input);
|
|
let current_dir = engine.get_current_dir()?;
|
|
self.gstat(input, ¤t_dir, repo_path, call.head)
|
|
}
|
|
}
|