-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Proposed plugin RPC spec #24
Conversation
// "content" or "data" for now | ||
Kind string | ||
// "text", "plugin_a", etc. | ||
Name string |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it might be good to add another string field here -- a namespace field. Using namespaced plugin names will allow users to use plugins from various providers. So the fully qualified plugin name would be <namespace>/<type>.<name>
(see an example in #5). For our plugins the namespace can be blackstork
.
The namespace only affects installation of the plugins, but not parsing / execution of the templates
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done! This comment reminded me of an unspoken terminology choice I made. Since type
is a reserved name in golang
and also there are already a lot of different "types" floating around I started referring to the content
or data
as "block/plugin kinds" to separate them a bit from every other meaning of "type" I have to work with. It's pretty easy to find-and-replace "Kind" to "Type" if it's objectionable, but I kinda like the term "plugin kind" here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sounds good!
If there are no further suggestions we can merge it! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good!
Hello! This is a proposed interface for the plugin system. Let's discuss and settle on this, it will allow some work in parallel since I kinda blocked everyone's work with my parser rewrite 😅