Hoppa till innehållet
Verifierad

Pluginens manifest

Sex filer som en plugin kan leverera, var och en en egen ingångspunkt, och manifestet som anger vilka av dem som finns.

En plugins manifest är inte en fil du skriver. Det beräknas av plattformen i samma ögonblick som en plugin laddas upp: validate_plugin() letar på disk efter exakt sex filnamn, registrerar vilka som finns (och om var och en hittades i paketets rot eller under dist/), och sparar resultatet som doc.manifest på pluginens katalogdokument. Allt nedströms, körmiljöns laddare, skärmen för godkännande vid installation och instrumentpanelens inställningsknapp, läser det manifestet i stället för att själva undersöka paketet.

De sex filerna

En plugin levererar de av de här som dess typ behöver. plugins/@xuda.io/xuda-ui-plugin-moment/src har bara index.mjs och runtime.mjs; plugins/@xuda.io/xuda-library-plugin-xlsx har index.mjs och server.mjs; plugins/@xuda.io/xuda-dbs-plugin-couchdb har index.mjs och server.mjs.

Roten eller dist/

validate_plugin() letar efter varje fil först i paketets rot, sedan i dist/<file>. Båda platserna uppfyller manifestet, så en plugin som byggs med Vite (de flesta under plugins/@xuda.io/) levererar källkod under src/ och låter bygget skriva manifestfilerna till dist/.

CSS laddas bara från dist

runtime.css (och all annan CSS i manifestet) plockas bara upp när dess .mjs hittades under dist/, aldrig från paketets rot. Körmiljön kontrollerar manifest[resource].dist && manifest[resource].css innan den hämtar stilmallen, så en plugin med en runtime.mjs i roten och en style.css i roten klarar valideringen (exist: true på båda) men körmiljön laddar aldrig CSS:en. Leverera via dist/ om pluginen behöver att stilmallen faktiskt laddas.

Vad manifestet används till

  • Att ladda en UI-plugin. Körmiljön vägrar köra en UI-plugin över huvud taget om inte manifestet visar att både runtime.mjs och index.mjs finns; sedan importerar den index.mjs för properties, löser upp varje egenskaps värde (inklusive uttrycksbindningar med xu-exp:) mot elementets attribut, importerar runtime.mjs och anropar fn.
  • Skärmen för godkännande vid installation. Det som finns i manifestet blir direkt de meningar en användare läser innan installation: att leverera server.mjs ger "Kör sin egen kod på Xuda-servrar, inuti ditt projekt"; att leverera runtime.mjs ger "Kör sin egen kod inuti din publicerade app, i webbläsaren hos alla som använder den"; studio.mjs och setup.mjs får också sina egna rader.
  • Instrumentpanelens knapp Setup. En plugins inställningsskärm visas bara när manifest['index.mjs'].exist är sant och den modulen inte är tom, eller när pluginen har ett beroende med en egen inställning.