-
Notifications
You must be signed in to change notification settings - Fork 8.1k
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
add links to plugin manifest file format. add naming conventions #51280
Changes from 5 commits
bfa2ecd
e7b203f
d90c7e8
0db99cb
38ace7a
5cb0b9a
a62baaa
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -93,7 +93,7 @@ export type PluginOpaqueId = symbol; | |
*/ | ||
export interface PluginManifest { | ||
/** | ||
* Identifier of the plugin. | ||
* Identifier of the plugin. Must be a string in snake_case. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. looks like a convention for legacy plugins There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The downside is then the access path looks weird. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. created a separate issue #52190 to discuss |
||
*/ | ||
readonly id: PluginName; | ||
|
||
|
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.
Not sure about this. want to hear your opinion.
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 definitely makes sense. We might even want to check it during plugin discovery and throw if that's not the case.
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.
We can try and see if it breaks something. There is a problem that we enforce snake_case in the directory name and now this requirement leaks to
id
. Although it seems to be a convention for the legacy plugins #51280 (comment)