Gå til indhold
Bekræftet

Plugin-manifestet

Seks filer, et plugin kan levere, hver et forskelligt indgangspunkt, og manifestet, der registrerer, hvilke af dem der findes.

Et plugins manifest er ikke en fil, du skriver. Det beregnes af platformen i det øjeblik, et plugin uploades: validate_plugin() leder på disken efter præcis seks filnavne, registrerer, hvilke der findes (og om hver blev fundet i pakkens rod eller under dist/), og gemmer resultatet som doc.manifest på plugin'ets katalogdokument. Alt nedstrøms, runtimens loader, installationens samtykkeskærm og dashboardets opsætningsknap, læser det manifest i stedet for selv at undersøge pakken.

De seks filer

Et plugin leverer de af disse, dets type har brug for. plugins/@xuda.io/xuda-ui-plugin-moment/src har kun index.mjs og runtime.mjs; plugins/@xuda.io/xuda-library-plugin-xlsx har index.mjs og server.mjs; plugins/@xuda.io/xuda-dbs-plugin-couchdb har index.mjs og server.mjs.

Rod eller dist/

validate_plugin() leder efter hver fil først i pakkens rod og derefter i dist/<file>. Begge placeringer opfylder manifestet, så et plugin bygget med Vite (de fleste under plugins/@xuda.io/) leverer kildekode under src/ og lader sit build skrive manifestfilerne ind i dist/.

CSS indlæses kun fra dist

runtime.css (og enhver anden CSS i manifestet) opfanges kun, når den tilhørende .mjs blev fundet under dist/, aldrig fra pakkens rod. Runtime tjekker manifest[resource].dist && manifest[resource].css, før den henter typografiarket, så et plugin med en runtime.mjs i roden og en style.css i roden består valideringen (exist: true på begge), men runtime indlæser aldrig CSS'en. Lever via dist/, hvis plugin'et skal have sit typografiark indlæst.

Hvad manifestet bruges til

  • Indlæsning af et UI-plugin. Runtime nægter overhovedet at køre et UI-plugin, medmindre manifestet viser, at både runtime.mjs og index.mjs findes; derefter importerer den index.mjs for properties, finder hver egenskabs værdi (inklusive xu-exp:-udtryksbindinger) ud fra elementets attributter, importerer runtime.mjs og kalder fn.
  • Samtykkeskærmen ved installation. Manifestets indhold bliver direkte til de sætninger, en bruger læser, før der installeres: at levere server.mjs giver "Kører sin egen kode på Xuda-servere, inde i dit projekt"; at levere runtime.mjs giver "Kører sin egen kode inde i din udgivne app, i browseren hos alle, der bruger den"; studio.mjs og setup.mjs får også deres egne linjer.
  • Dashboardets opsætningsknap. Et plugins opsætningsskærm vises kun, når manifest['index.mjs'].exist er sand, og modulet ikke er tomt, eller plugin'et har en afhængighed med sin egen opsætning.