Skip to content

feat: add subscriber plugin #360

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Mar 6, 2025
Merged

feat: add subscriber plugin #360

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2432ef3
feat: add subscriber later binding as submodule
Mar 5, 2025
e6fbc78
docs: update plug-ins.md documentation
Mar 5, 2025
4fca052
remove scl editor submodule
Mar 5, 2025
d75890d
feat: add only the subscriber-later-binding plugin
Mar 5, 2025
58464b9
docs: remove docs
Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@
path = packages/external-plugins/oscd-plugins
url = https://github.com/sprinteins/oscd-plugins
branch = gh-pages
[submodule "packages/external-plugins/scl-editor"]
path = packages/external-plugins/scl-editor
url = https://github.com/danyill/scl-editor
branch = gh-pages
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding the entire scl-editor seems overkill, let us at just the plugin like it is done in the scl-editor distribution, see https://github.com/danyill/scl-editor/blob/main/.gitmodules#L45C1-L48C20

Our build method isn't very smart and mounts the entire external-plugins directory, this would make the image a lot larger than it has to be

8 changes: 8 additions & 0 deletions docs/plug-ins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,14 @@ implemented in these plugins.
> https://sprinteins.github.io/oscd-plugins/documentation/index.js
> ```

### Subscriber (Later Binding)

> <kbd>Editor</kbd> | by [Daniel](https://github.com/danyill) | [Repository](https://github.com/danyill/scl-editor)
>
> ```
> https://danyill.github.io/scl-editor/plugins/oscd-subscriber-later-binding/oscd-subscriber-later-binding.js
> ```

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is summary for plugins in the open-scd ecosystem and it is maintained in the open scd repository. If changes are made to the list, it should be done in the open scd repo.

I would not make any changes to the list, because it is independent of compas open scd and more of a reference list for users.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah you're right about it

## Vendor Specific Plug-ins

These plug-ins are specific to a vendor and can include vendor specific
Expand Down
7 changes: 7 additions & 0 deletions packages/compas-open-scd/public/js/plugins.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,13 @@ export const officialPlugins = [
default: false,
kind: 'editor',
},
{
name: 'Subscribe (Later Binding)',
src: '/external-plugins/scl-editor/plugins/oscd-subscriber-later-binding/oscd-subscriber-later-binding.js',
icon: 'link',
default: false,
kind: 'editor',
},
{
name: 'Open project',
src: '/src/menu/CompasOpen.js',
Expand Down
1 change: 1 addition & 0 deletions packages/external-plugins/scl-editor
Open in desktop
Submodule scl-editor added at fb9a2a
Loading