Hopp til innholdet
Bekreftet

Plugin-manifestet

Seks filer en plugin kan levere, hver med et ulikt inngangspunkt, og manifestet som registrerer hvilke av dem som finnes.

En plugins manifest er ikke en fil du skriver. Det beregnes av plattformen i det øyeblikket en plugin lastes opp: validate_plugin() ser på disk etter nøyaktig seks filnavn, registrerer hvilke som finnes (og om hver ble funnet i pakkens rot eller under dist/), og lagrer resultatet som doc.manifest på pluginens katalogdokument. Alt nedstrøms, kjøretidens laster, samtykkeskjermen ved installasjon, oppsettknappen i oversiktspanelet, leser det manifestet i stedet for å undersøke selve pakken.

De seks filene

En plugin leverer de av disse filene som typen dens trenger. plugins/@xuda.io/xuda-ui-plugin-moment/src har bare index.mjs og runtime.mjs, plugins/@xuda.io/xuda-library-plugin-xlsx har index.mjs og server.mjs, og plugins/@xuda.io/xuda-dbs-plugin-couchdb har index.mjs og server.mjs.

Rot eller dist/

validate_plugin() leter etter hver fil først i pakkens rot, og deretter i dist/<file>. Begge stedene oppfyller manifestet, så en plugin bygd med Vite (de fleste under plugins/@xuda.io/) leverer kilden under src/ og lar bygget skrive manifestfilene inn i dist/.

CSS lastes bare fra dist

runtime.css (og annen manifest-CSS) hentes bare når den tilhørende .mjs-en ble funnet under dist/, aldri fra pakkens rot. Kjøretiden sjekker manifest[resource].dist && manifest[resource].css før den henter stilarket, så en plugin med en runtime.mjs i roten og en style.css i roten består valideringen (exist: true på begge), men kjøretiden laster aldri CSS-en. Lever via dist/ hvis pluginen trenger at stilarket faktisk lastes.

Hva manifestet brukes til

  • Laste en UI-plugin. Kjøretiden nekter å kjøre en UI-plugin i det hele tatt med mindre manifestet viser at både runtime.mjs og index.mjs finnes. Deretter importerer den index.mjs for properties, løser opp verdien til hver egenskap (også xu-exp:-uttrykksbindinger) mot elementets attributter, importerer runtime.mjs og kaller fn.
  • Samtykkeskjermen ved installasjon. At noe finnes i manifestet blir direkte til setningene en bruker leser før installasjon: å levere server.mjs gir «Kjører sin egen kode på Xuda-servere, inni prosjektet ditt», å levere runtime.mjs gir «Kjører sin egen kode inni den publiserte appen din, i nettleseren til alle som bruker den», og studio.mjs og setup.mjs får sine egne linjer også.
  • Oppsett-knappen i oversiktspanelet. En plugins oppsettskjerm vises bare når manifest['index.mjs'].exist er sann og den modulen ikke er tom, eller pluginen har en avhengighet med eget oppsett.