Feat: Added ADR

openscd · Aug 14, 2023 · 18d8875 · 18d8875
1 parent 64aaf74
commit 18d8875
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 100 deletions.
diff --git a/doc/0003-ADR-Split-OpenSCD.md b/doc/0003-ADR-Split-OpenSCD.md
@@ -0,0 +1,23 @@
+# OpenSCD Core should support Addons
+
+Date: 2023-06-05
+
+## Status
+
+Accepted
+
+## Context
+The OpenSCD-core package currently consists of the custom WebComponent `open-scd` and the agreed upon API's + custom Events.
+This means that every plugin that uses the API or custom Events from OpenSCD-Core, needs to have `open-scd-core` as a NPM dependency (or copy the needed code for itself).
+
+
+## Decision
+`OpenSCD-Core` should be split up into multiple packages. This way, plugins can directly depend on `OpenSCD-Core` (Which contains the agreed API).
+
+### Solution
+We can split up `OpenSCD-Core` into multiple packages; 1 Package that contains the custom WebComponent `OpenSCD`. 1 Package that contains the agreed API.
+The custom WebComponent is depending on the package that has the agreed API.
+
+All the plugins have a dependency (if needed) on the agreed API.
+
+![Proposal](./openscd-core-split.svg)
diff --git a/doc/openscd-core-split.svg b/doc/openscd-core-split.svg