mirror of https://github.com/nushell/nushell synced 2024-11-15 01:17:07 +00:00

History

Devyn Cairns 91d44f15c1 Allow plugins to report their own version and store it in the registry (#12883 ) # 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		2024-06-21 06:27:09 -05:00
..
src	Allow plugins to report their own version and store it in the registry (#12883 )	2024-06-21 06:27:09 -05:00
Cargo.toml	Bump git2 from 0.18.3 to 0.19.0 (#13179 )	2024-06-19 01:09:25 +00:00
README.md	remove the `--encoding` option from `register` in the examples (#8038 )	2023-02-11 13:13:40 +00:00

README.md

Git stat plugin for Nushell

Note: this requires Nushell 0.60 or later

To install:

> cargo install --path .

To register (from inside Nushell):

> register <path to installed plugin>