Zum Inhalt springen
Geprüft

Das Plugin-Manifest

Sechs Dateien, die ein Plugin mitliefern kann, jede ein anderer Einstiegspunkt, und das Manifest, das festhält, welche davon existieren.

Das Manifest eines Plugins ist keine Datei, die du schreibst. Es wird von der Plattform in dem Moment berechnet, in dem ein Plugin hochgeladen wird: validate_plugin() sucht auf der Festplatte nach genau sechs Dateinamen, hält fest, welche existieren (und ob jede im Paket-Stammverzeichnis oder unter dist/ gefunden wurde), und speichert das Ergebnis als doc.manifest im Katalogdokument des Plugins. Alles Nachgelagerte, der Loader der Runtime, die Installations-Zustimmungsseite, die Einrichtungsschaltfläche des Dashboards, liest dieses Manifest, statt das Paket selbst zu untersuchen.

Die sechs Dateien

Ein Plugin liefert, was auch immer seine Art davon braucht. plugins/@xuda.io/xuda-ui-plugin-moment/src hat nur index.mjs und runtime.mjs, plugins/@xuda.io/xuda-library-plugin-xlsx hat index.mjs und server.mjs, und plugins/@xuda.io/xuda-dbs-plugin-couchdb hat index.mjs und server.mjs.

Stammverzeichnis oder dist/

validate_plugin() sucht jede Datei zuerst im Paket-Stammverzeichnis, dann unter dist/<file>. Beide Orte erfüllen das Manifest, ein mit Vite gebautes Plugin (die meisten unter plugins/@xuda.io/) liefert also Quellcode unter src/ und lässt seinen Build die Manifest-Dateien nach dist/ schreiben.

CSS lädt nur aus dist

runtime.css (und jedes andere Manifest-CSS) wird nur übernommen, wenn die zugehörige .mjs unter dist/ gefunden wurde, nie aus dem Paket-Stammverzeichnis. Die Runtime prüft manifest[resource].dist && manifest[resource].css, bevor sie das Stylesheet holt, daher besteht ein Plugin mit einer runtime.mjs und einer style.css im Stammverzeichnis die Validierung (exist: true bei beiden), aber die Runtime lädt das CSS nie. Liefere über dist/ aus, wenn das Stylesheet des Plugins tatsächlich geladen werden soll.

Wofür das Manifest verwendet wird

  • Ein UI-Plugin laden. Die Runtime weigert sich, ein UI-Plugin überhaupt auszuführen, wenn das Manifest nicht sowohl runtime.mjs als auch index.mjs als vorhanden zeigt. Dann importiert sie index.mjs für properties, löst den Wert jeder Eigenschaft (einschließlich xu-exp:-Ausdrucksbindungen) anhand der Attribute des Elements auf, importiert runtime.mjs und ruft fn auf.
  • Die Installations-Zustimmungsseite. Das Vorhandensein im Manifest wird direkt zu den Sätzen, die ein Benutzer vor dem Installieren liest: Liefert ein Plugin server.mjs, steht dort "Runs its own code on Xuda servers, inside your project", liefert es runtime.mjs, steht dort "Runs its own code inside your published app, in the browser of everyone who uses it". studio.mjs und setup.mjs bekommen ebenfalls eigene Zeilen.
  • Die Einrichtungsschaltfläche des Dashboards. Der Einrichtungsbildschirm eines Plugins erscheint nur, wenn manifest['index.mjs'].exist wahr ist und dieses Modul nicht leer ist, oder das Plugin eine Abhängigkeit mit eigener Einrichtung hat.