This repository has been archived by the owner on Mar 13, 2024. It is now read-only.
MM-10926: updated plugin registry documentation #1452
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
registerPlugin, to avoid encouraging direct manipulation of the window.plugins global. rninitialize, to match the use of unregister (vs. deregister) elsewhere.
lieut-data
commented
Jul 16, 2018
| // | ||
| // During the beta, plugins manipulated the global window.plugins data structure directly. This | ||
| // remains possible, but is officially deprecated and may be removed in a future release. | ||
| function registerPlugin(id, plugin) { |
There was a problem hiding this comment.
As discussed on pre-release.
| plugin.uninitialize(); | ||
|
|
||
| // Support the deprecated deinitialize callback from the plugins beta. | ||
| } else if (plugin && plugin.deinitialize) { |
There was a problem hiding this comment.
Supporting deinitialize, but we've converged on un elsewhere so this made sense for consistency.
| @@ -35,32 +35,32 @@ export default class PluginRegistry { | |||
|
|
|||
| // Register a component at the root of the channel view of the app. | |||
| // Accepts a React component. Returns a unique identifier. | |||
| registerRootComponent = (component) => { | |||
| registerRootComponent(component) { | |||
There was a problem hiding this comment.
Binding the functions using arrow functions wasn't necessary, since we weren't using these callbacks out of context (e.g. as an event handler). This change allows me to use esprima to parse out this file and generate automated documentation.
crspeller
approved these changes
Jul 17, 2018
fincha
pushed a commit
to fincha/mattermost-webapp
that referenced
this pull request
Oct 21, 2018
* MM-10926: avoid arrow functions on registry to work with esprima * MM-10926: introduce registerPlugin and uninitialize registerPlugin, to avoid encouraging direct manipulation of the window.plugins global. rninitialize, to match the use of unregister (vs. deregister) elsewhere.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
This set of changes supports the automatic extraction of the plugin registry for documentation purposes.
Ticket Link
https://mattermost.atlassian.net/browse/MM-10926
Checklist
make check-styleto check for style errors (required for all pull requests)make testto ensure unit and component tests passed