openscd / open-scd-core

Apache License 2.0
5 stars 8 forks source link

Documentation how to use development version in plugin #94

Open danyill opened 1 year ago

danyill commented 1 year ago

I want to use the latest, bleeding-edge version of open-scd-core in my plugin.

I would be pleased if there were documentation on how to do this, either from CI or when using a local clone/build process and it could be added to the README.

danyill commented 1 year ago

I learned thanks to Jakob and Christian that one way to do this is via the CI build.

The plugins JSON can be passed as a URI encoded parameter, e.g.

plugins={
  "menu": 
  [
    {"name": "Open File", "translations": {"de": "Datei öffnen"}, "icon": "folder_open", "active": true, "src": "https://openscd.github.io/oscd-open/oscd-open.js"}, 
    {"name": "Save File", "translations": {"de": "Datei speichern"}, "icon": "save", "active": true, "src": "https://openscd.github.io/oscd-save/oscd-save.js"}
  ],
  "editor": 
  [
    {"name": "Subscriber Later Binding", "translations": {"de": "Späte Bindung des Abonnenten", "pt": "Associação Tardia de Assinante"}, "icon": "link", "active": true, "requireDoc": true, "src": "https://danyill.github.io/oscd-subscriber-later-binding/oscd-subscriber-later-binding.js"}
  ]
}

console.log(`https://openscd.github.io/open-scd/?plugins=${encodeURI(JSON.stringify(plugins))}`)

I would also like to know how to do this locally.