Sari la conținut
Verificat

Manifestul pluginului

Șase fișiere pe care le poate livra un plugin, fiecare un alt punct de intrare, și manifestul care înregistrează care dintre ele există.

Manifestul unui plugin nu este un fișier pe care îl scrii tu. Este calculat de platformă în momentul în care un plugin este încărcat: validate_plugin() caută pe disc exact șase nume de fișiere, înregistrează care dintre ele există (și dacă fiecare a fost găsit în rădăcina pachetului sau sub dist/) și salvează rezultatul ca doc.manifest în documentul din catalog al pluginului. Tot ce urmează, încărcătorul din runtime, ecranul de consimțământ la instalare, butonul de configurare din tabloul de bord, citește acel manifest în loc să cerceteze pachetul însuși.

Cele șase fișiere

Un plugin livrează oricare dintre acestea de care are nevoie tipul lui. plugins/@xuda.io/xuda-ui-plugin-moment/src are doar index.mjs și runtime.mjs; plugins/@xuda.io/xuda-library-plugin-xlsx are index.mjs și server.mjs; plugins/@xuda.io/xuda-dbs-plugin-couchdb are index.mjs și server.mjs.

Rădăcină sau dist/

validate_plugin() caută fiecare fișier mai întâi în rădăcina pachetului, apoi la dist/<file>. Oricare locație satisface manifestul, așa că un plugin construit cu Vite (majoritatea celor din plugins/@xuda.io/) livrează sursa sub src/ și lasă build-ul să scrie fișierele de manifest în dist/.

CSS se încarcă doar din dist

runtime.css (și orice alt CSS din manifest) este preluat doar când .mjs-ul lui corespunzător a fost găsit sub dist/, niciodată din rădăcina pachetului. Runtime-ul verifică manifest[resource].dist && manifest[resource].css înainte să preia foaia de stil, așa că un plugin cu un runtime.mjs și un style.css în rădăcină trece validarea (exist: true la ambele), dar runtime-ul nu încarcă niciodată CSS-ul. Livrează prin dist/ dacă pluginul are nevoie ca foaia lui de stil să se încarce efectiv.

La ce se folosește manifestul

  • Încărcarea unui plugin de UI. Runtime-ul refuză să ruleze deloc un plugin de UI, dacă manifestul nu arată prezente atât runtime.mjs, cât și index.mjs; apoi importă index.mjs pentru properties, rezolvă valoarea fiecărei proprietăți (inclusiv legăturile de expresie xu-exp:) față de atributele elementului, importă runtime.mjs și apelează fn.
  • Ecranul de consimțământ la instalare. Prezența în manifest se transformă direct în propozițiile pe care le citește un utilizator înainte să instaleze: livrarea server.mjs spune „Rulează propriul cod pe serverele Xuda, în interiorul proiectului tău”; livrarea runtime.mjs spune „Rulează propriul cod în aplicația ta publicată, în browserul tuturor celor care o folosesc”; studio.mjs și setup.mjs primesc și ele propriile rânduri.
  • Butonul Setup din tabloul de bord. Ecranul de configurare al unui plugin apare doar când manifest['index.mjs'].exist este adevărat și modulul nu este gol, sau când pluginul are o dependență cu propria configurare.