Feat: Programatic Plugin Activation #1611
Open
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
trusz
commented
Dec 15, 2024
| @@ -311,57 +181,22 @@ export class OpenSCD extends LitElement { | |||
|
|
|||
| connectedCallback(): void { | |||
| super.connectedCallback(); | |||
| this.loadPlugins() | |||
There was a problem hiding this comment.
initial loading of plugins has been revamped
| return { | ||
| ...plugin, | ||
| content: staticTagHtml`<${tag} | ||
| content: () => { |
There was a problem hiding this comment.
the content is now a function so we regenerate the content if params change
| .doc=${this.doc} | ||
| .docName=${this.docName} | ||
| .editCount=${this.historyState.editCount} | ||
| .plugins=${this.storedPlugins} |
There was a problem hiding this comment.
we pass in the whole plugins config, so plugins can access their own and others plugins' config
| @@ -52,176 +53,45 @@ import { InstalledOfficialPlugin, MenuPosition, PluginKind, Plugin } from "./plu | |||
| import { ConfigurePluginEvent, ConfigurePluginDetail, newConfigurePluginEvent } from './plugin.events.js'; | |||
| import { newLogEvent } from '@openscd/core/foundation/deprecated/history'; | |||
|
|
|||
| // HOSTING INTERFACES | |||
There was a problem hiding this comment.
This has been moved to the end of the file and other stuff got moved to up to promote quicker understanding of the structure and purpose of the file
| @@ -0,0 +1,89 @@ | |||
| import { crossProduct } from '../foundation.js'; | |||
|
trusz
commented
Jan 8, 2025
Comment on lines
+6
to
+13
| { | ||
| name: 'Launcher', | ||
| src: 'http://localhost:50714/index.js', | ||
| icon: 'launch', | ||
| default: true, | ||
| kind: 'editor', | ||
| requireDoc: true, | ||
| }, |
clepski
requested changes
Jan 8, 2025
Comment on lines
+3
to
+6
| function getDataModelChildren(parent: Element): Element[] { | ||
| if (['LDevice', 'Server'].includes(parent.tagName)) | ||
| return Array.from(parent.children).filter( | ||
| child => |
There was a problem hiding this comment.
How is this file related to activating plugins?
| @@ -155,6 +158,7 @@ export class OscdLayout extends LitElement { | |||
| }, | |||
| disabled: (): boolean => !this.historyState.canUndo, | |||
| kind: 'static', | |||
| content: () => html``, | |||
There was a problem hiding this comment.
This is the default for content, so we don't have to set it right?
Comment on lines
+397
to
+425
| // private updatePlugins() { | ||
|
|
||
| // const stored: Plugin[] = this.storedPlugins; | ||
| // const officialStored = stored.filter(p => p.official); | ||
| // const newOfficial: Array<Plugin | InstalledOfficialPlugin> = ( | ||
| // builtinPlugins as Plugin[] | ||
| // ) | ||
| // .concat(this.parsedPlugins) | ||
| // .filter(p => !officialStored.find(o => o.src === p.src)) | ||
| // .map(plugin => { | ||
| // return { | ||
| // src: plugin.src, | ||
| // installed: plugin.default ?? false, | ||
| // official: true as const, | ||
| // }; | ||
| // }); | ||
|
|
||
| // const oldOfficial = officialStored.filter( | ||
| // p => | ||
| // !(builtinPlugins as Plugin[]) | ||
| // .concat(this.parsedPlugins) | ||
| // .find(o => p.src === o.src) | ||
| // ); | ||
| // const newPlugins: Array<Plugin | InstalledOfficialPlugin> = stored.filter( | ||
| // p => !oldOfficial.find(o => p.src === o.src) | ||
| // ); | ||
| // newOfficial.map(p => newPlugins.push(p)); | ||
| // this.storePlugins(newPlugins); | ||
| // } |
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.
The goal of the pull request is to allow plugins to switch to specific plugins.
For this an event was created that accepts the
nameand thesrcof a plugin, as this is how we identify them.Furthermore, an additional event was created to allow plugins to "run" menu plugins.
Because menu plugins render inside the menu sidebar and they are only visible when the sidebar is open we open it too before running the menu plugin to make sure the users see the content. This is somewhat hacky and a better solution should be implemented in the future.