Preskočiť na obsah
Overené

Manifest pluginu

Šesť súborov, ktoré plugin môže dodať, každý je iný vstupný bod, a manifest, ktorý zaznamenáva, ktoré z nich existujú.

Manifest pluginu nie je súbor, ktorý píšete. Platforma ho vypočíta v okamihu nahratia pluginu: validate_plugin() hľadá na disku presne šesť názvov súborov, zaznamená, ktoré existujú (a či sa každý našiel v koreni balíka, alebo pod dist/), a výsledok uloží ako doc.manifest do katalógového dokumentu pluginu. Všetko ďalej, zavádzač runtime, obrazovka so súhlasom pri inštalácii, tlačidlo nastavenia v dashboarde, číta tento manifest a nesníma samotný balík.

The six files

Plugin dodáva ktorékoľvek z nich, ktoré jeho druh potrebuje. plugins/@xuda.io/xuda-ui-plugin-moment/src má len 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.

Root or dist/

validate_plugin() hľadá každý súbor najprv v koreni balíka, potom v dist/<file>. Obe miesta manifest uspokoja, takže plugin zostavený cez Vite (väčšina tých pod plugins/@xuda.io/) dodáva zdroj pod src/ a nechá svoje zostavenie zapísať súbory manifestu do dist/.

CSS sa načíta len z dist

runtime.css (a akékoľvek iné CSS manifestu) sa zoberie len vtedy, keď sa jeho zodpovedajúci .mjs našiel pod dist/, nikdy nie z koreňa balíka. Runtime skontroluje manifest[resource].dist && manifest[resource].css, skôr než štýl stiahne, takže plugin s runtime.mjs a style.css v koreni prejde overením (exist: true pri oboch), ale runtime CSS nikdy nenačíta. Ak plugin potrebuje, aby sa jeho štýl skutočne načítal, dodajte ho cez dist/.

What the manifest is used for

  • Načítanie pluginu UI. Runtime plugin UI vôbec odmietne spustiť, pokiaľ manifest neukazuje prítomné runtime.mjs aj index.mjs; potom importuje index.mjs kvôli properties, určí hodnotu každej vlastnosti (vrátane väzieb výrazov xu-exp:) voči atribútom prvku, importuje runtime.mjs a zavolá fn.
  • Obrazovka so súhlasom pri inštalácii. Prítomnosť v manifeste sa priamo mení na vety, ktoré používateľ číta pred inštaláciou: dodanie server.mjs hovorí „Runs its own code on Xuda servers, inside your project“; dodanie runtime.mjs hovorí „Runs its own code inside your published app, in the browser of everyone who uses it“; studio.mjs a setup.mjs dostanú tiež vlastné riadky.
  • Tlačidlo Setup v dashboarde. Obrazovka nastavenia pluginu sa zobrazí len vtedy, keď je manifest['index.mjs'].exist pravdivé a tento modul nie je prázdny, alebo má plugin závislosť s vlastným nastavením.