Il manifest del plugin
Sei file che un plugin può includere, ciascuno un diverso punto di ingresso, e il manifest che registra quali esistono.
Il manifest di un plugin non è un file che scrivi tu. Viene calcolato dalla piattaforma nel momento
in cui un plugin viene caricato: validate_plugin() cerca su disco esattamente sei nomi di file,
registra quali esistono (e se ciascuno è stato trovato nella radice del pacchetto o sotto dist/) e
salva il risultato come doc.manifest nel documento di catalogo del plugin. Tutto ciò che viene a
valle, il loader del runtime, la schermata di consenso all'installazione, il pulsante di
configurazione della dashboard, legge quel manifest invece di esaminare direttamente il pacchetto.
I sei file
Un plugin include quanti di questi file servono al suo tipo. plugins/@xuda.io/xuda-ui-plugin-moment/src ha
solo index.mjs e runtime.mjs; plugins/@xuda.io/xuda-library-plugin-xlsx ha index.mjs e
server.mjs; plugins/@xuda.io/xuda-dbs-plugin-couchdb ha index.mjs e server.mjs.
Radice o dist/
validate_plugin() cerca ogni file prima nella radice del pacchetto, poi in dist/<file>. Entrambe
le posizioni soddisfano il manifest, quindi un plugin compilato con Vite (la maggior parte di quelli
in plugins/@xuda.io/) include il sorgente in src/ e lascia che la propria build scriva i file
del manifest in dist/.
runtime.css (e qualsiasi altro CSS del manifest) viene preso in considerazione solo quando il
suo .mjs corrispondente è stato trovato sotto dist/, mai dalla radice del pacchetto. Il runtime
controlla manifest[resource].dist && manifest[resource].css prima di scaricare il foglio di stile,
quindi un plugin con un runtime.mjs e uno style.css nella radice supera la validazione (exist: true
su entrambi) ma il runtime non carica mai il CSS. Se il plugin ha bisogno che il suo foglio di stile
venga davvero caricato, pubblicalo tramite dist/.
A cosa serve il manifest
- Caricare un plugin UI. Il runtime si rifiuta di eseguire un plugin UI, a meno che il manifest
non mostri sia
runtime.mjssiaindex.mjs; poi importaindex.mjsper ottenereproperties, risolve il valore di ogni proprietà (comprese le associazioni di espressionixu-exp:) rispetto agli attributi dell'elemento, importaruntime.mjse chiamafn. - La schermata di consenso all'installazione. La presenza nel manifest diventa direttamente le
frasi che un utente legge prima di installare: includere
server.mjsdice "Runs its own code on Xuda servers, inside your project"; includereruntime.mjsdice "Runs its own code inside your published app, in the browser of everyone who uses it"; anchestudio.mjsesetup.mjshanno la propria riga. - Il pulsante Configurazione della dashboard. La schermata di configurazione di un plugin compare
solo se
manifest['index.mjs'].existè vero e quel modulo non è vuoto, oppure se il plugin ha una dipendenza con una propria configurazione.