Manifest pluginu
Šest souborů, které plugin může dodat, každý jiný vstupní bod, a manifest, který zaznamenává, které z nich existují.
Manifest pluginu není soubor, který píšete. Platforma ho vypočítá v okamžiku, kdy se plugin
nahraje: validate_plugin() hledá na disku přesně šest názvů souborů, zaznamená, které existují
(a zda byl každý nalezen v kořeni balíčku, nebo pod dist/), a výsledek uloží jako
doc.manifest do dokumentu katalogu pluginu. Vše navazující, zavaděč runtime, obrazovka
souhlasu s instalací, tlačítko nastavení v nástěnce, čte tento manifest, ne přímo balíček.
Šest souborů
Plugin dodává ty z nich, které jeho druh potřebuje. plugins/@xuda.io/xuda-ui-plugin-moment/src má
jen index.mjs a runtime.mjs; plugins/@xuda.io/xuda-library-plugin-xlsx má index.mjs a
server.mjs; plugins/@xuda.io/xuda-dbs-plugin-couchdb má index.mjs a server.mjs.
Kořen nebo dist/
validate_plugin() hledá každý soubor nejprve v kořeni balíčku, poté v dist/<file>. Kterékoli
umístění manifest splní, takže plugin sestavený přes Vite (většina těch v
plugins/@xuda.io/) dodává zdroj pod src/ a nechá sestavení zapsat soubory manifestu do
dist/.
runtime.css (a jakékoli jiné CSS manifestu) se převezme jen tehdy, když byl odpovídající .mjs
nalezen pod dist/, nikdy z kořene balíčku. Runtime kontroluje
manifest[resource].dist && manifest[resource].css, než stylopis stáhne, takže plugin s runtime.mjs v kořeni
a style.css v kořeni projde validací (exist: true u obou), ale runtime CSS nikdy nenačte. Dodávejte přes
dist/, pokud plugin potřebuje, aby se jeho stylopis skutečně načetl.
K čemu se manifest používá
- Načtení pluginu UI. Runtime plugin UI vůbec nespustí,
pokud manifest neukazuje přítomnost obou
runtime.mjsiindex.mjs; poté naimportujeindex.mjskvůliproperties, vyhodnotí hodnotu každé vlastnosti (včetně vazeb výrazůxu-exp:) proti atributům prvku, naimportujeruntime.mjsa zavoláfn. - Obrazovka souhlasu s instalací. Přítomnost v manifestu se přímo mění ve věty, které
uživatel čte před instalací: dodání
server.mjsříká „Spouští vlastní kód na serverech Xuda, uvnitř vašeho projektu“; dodáníruntime.mjsříká „Spouští vlastní kód uvnitř vaší publikované aplikace, v prohlížeči každého, kdo ji používá“;studio.mjsasetup.mjsmají také vlastní řádky. - Tlačítko Nastavení v nástěnce. Obrazovka nastavení pluginu se zobrazí jen tehdy, když
manifest['index.mjs'].existje pravda a tento modul není prázdný, nebo má plugin závislost s vlastním nastavením.