extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2024-12-24 16:09:11 +01:00
Code Issues Packages Projects Releases Wiki Activity
442faa5576
nushell/crates/nu_plugin_formats
History
Devyn Cairns 01d30a416b
Change PluginCommand API to be more like Command (#12279) 
# 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 😄
2024-03-27 11:59:57 +01:00
..
src Change PluginCommand API to be more like Command (#12279) 2024-03-27 11:59:57 +01:00
Cargo.toml Bump ical from 0.10.0 to 0.11.0 (#12303) 2024-03-27 14:44:33 +08:00
README.md Move some from xxx commands to plugin (#7942) 2023-02-13 12:42:08 +00:00

README.md

nu_plugin_formats

A nushell plugin to convert data to nushell tables.

support commands:

  1. from eml - original ported from nushell core.
  2. from ics - original ported from nushell core.
  3. from ini - original ported from nushell core.
  4. from vcf - original ported from nushell core.

Prerequisite

nushell, It's a nushell plugin, so you need it.

Usage

  1. compile the binary: cargo build
  2. register plugin(assume it's compiled in ./target/debug/):
register ./target/debug/nu_plugin_formats