Przejdź do treści
Zweryfikowano

Manifest wtyczki

Sześć plików, które może dostarczyć wtyczka, każdy to inny punkt wejścia, oraz manifest zapisujący, które z nich istnieją.

Manifest wtyczki nie jest plikiem, który piszesz. Platforma oblicza go w chwili przesłania wtyczki: validate_plugin() szuka na dysku dokładnie sześciu nazw plików, zapisuje, które istnieją (i czy każdy znaleziono w katalogu głównym pakietu, czy w dist/), a wynik zapisuje jako doc.manifest w dokumencie katalogu wtyczki. Wszystko dalej, loader środowiska uruchomieniowego, ekran zgody na instalację, przycisk konfiguracji w pulpicie, czyta ten manifest, zamiast samemu sondować pakiet.

Sześć plików

Wtyczka dostarcza te z nich, których potrzebuje jej rodzaj. plugins/@xuda.io/xuda-ui-plugin-moment/src ma tylko index.mjs i runtime.mjs; plugins/@xuda.io/xuda-library-plugin-xlsx ma index.mjs i server.mjs; plugins/@xuda.io/xuda-dbs-plugin-couchdb ma index.mjs i server.mjs.

Katalog główny lub dist/

validate_plugin() szuka każdego pliku najpierw w katalogu głównym pakietu, potem w dist/<file>. Każde z tych miejsc spełnia manifest, więc wtyczka zbudowana Vite (większość tych w plugins/@xuda.io/) dostarcza źródło w src/ i pozwala, żeby jej build zapisał pliki manifestu w dist/.

CSS ładuje się tylko z dist

runtime.css (i każdy inny CSS manifestu) jest pobierany tylko wtedy, gdy jego pasujący .mjs znaleziono w dist/, nigdy z katalogu głównego pakietu. Środowisko uruchomieniowe sprawdza manifest[resource].dist && manifest[resource].css, zanim pobierze arkusz stylów, więc wtyczka z runtime.mjs i style.css w katalogu głównym przechodzi walidację (exist: true dla obu), ale środowisko nigdy nie ładuje CSS. Dostarczaj przez dist/, jeśli wtyczka potrzebuje, żeby jej arkusz stylów faktycznie się załadował.

Do czego służy manifest

  • Ładowanie wtyczki UI. Środowisko uruchomieniowe w ogóle odmawia uruchomienia wtyczki UI, chyba że manifest pokazuje obecne zarówno runtime.mjs, jak i index.mjs; wtedy importuje index.mjs po properties, rozwiązuje wartość każdej właściwości (w tym powiązania wyrażeń xu-exp:) względem atrybutów elementu, importuje runtime.mjs i wywołuje fn.
  • Ekran zgody na instalację. Obecność w manifeście zamienia się wprost w zdania, które użytkownik czyta przed instalacją: dostarczenie server.mjs daje „Uruchamia własny kod na serwerach Xuda, w Twoim projekcie"; dostarczenie runtime.mjs daje „Uruchamia własny kod w Twojej opublikowanej aplikacji, w przeglądarce każdego, kto z niej korzysta"; studio.mjs i setup.mjs też dostają własne wiersze.
  • Przycisk Konfiguracja w pulpicie. Ekran konfiguracji wtyczki pokazuje się tylko wtedy, gdy manifest['index.mjs'].exist jest prawdziwe, a ten moduł nie jest pusty, albo wtyczka ma zależność z własną konfiguracją.