Change PluginCommand API to be more like Command #12279
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Looks great! |
|
This makes the plugins look pretty familiar. Thanks! |
fdncred
added
pr:breaking-change
|
@devyn i'm thinking we should probably land this if you can fix the conflicts. |
- 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 This should help with splitting core commands into plugins, but also offers a nicer interface in my opinion.
devyn
force-pushed
the
make-plugincommand-more-like-command
branch
from
7d3d126
to
7187425
Compare
|
I'm always creating my own conflicts, aren't I 馃ぃ |
sholderbach
approved these changes
Mar 27, 2024
sholderbach
pushed a commit
that referenced
this pull request
Mar 28, 2024
# Description I broke this, I think in #12279, because I forgot a `#[cfg(plugin)]`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is something that was discussed in the core team meeting last Wednesday. @ayax79 is building
nu-plugin-polarswith 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 theCommandAPI 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 datasignature()up intoname(),usage(),extra_usage(),search_terms(),examples()signature()returnsnu_protocol::Signatureexamples()returnsVec<nu_protocol::Example>PluginSignatureandPluginExampleno longer need to be used by plugin developersUser-Facing Changes
Breaking API for plugins yet again 馃槃
Tests + Formatting
toolkit fmttoolkit clippytoolkit testtoolkit test stdlibAfter Submitting