Μετάβαση στο περιεχόμενο
Επαληθεύτηκε

Το manifest του πρόσθετου

Έξι αρχεία που μπορεί να περιλαμβάνει ένα πρόσθετο, το καθένα με διαφορετικό σημείο εισόδου, και το manifest που καταγράφει ποια από αυτά υπάρχουν.

Το manifest ενός πρόσθετου δεν είναι αρχείο που γράφετε. Υπολογίζεται από την πλατφόρμα τη στιγμή που μεταφορτώνεται ένα πρόσθετο: το validate_plugin() ψάχνει στον δίσκο για ακριβώς έξι ονόματα αρχείων, καταγράφει ποια υπάρχουν (και αν το καθένα βρέθηκε στη ρίζα του πακέτου ή κάτω από το dist/), και αποθηκεύει το αποτέλεσμα ως doc.manifest στο έγγραφο καταλόγου του πρόσθετου. Ό,τι έπεται, ο φορτωτής του runtime, η οθόνη συναίνεσης εγκατάστασης, το κουμπί ρύθμισης του πίνακα ελέγχου, διαβάζει αυτό το manifest αντί να ελέγχει το ίδιο το πακέτο.

Τα έξι αρχεία

Ένα πρόσθετο περιλαμβάνει όποια από αυτά χρειάζεται το είδος του. Το plugins/@xuda.io/xuda-ui-plugin-moment/src έχει μόνο index.mjs και runtime.mjs: το plugins/@xuda.io/xuda-library-plugin-xlsx έχει index.mjs και server.mjs: το plugins/@xuda.io/xuda-dbs-plugin-couchdb έχει index.mjs και server.mjs.

Ρίζα ή dist/

Το validate_plugin() ψάχνει για κάθε αρχείο πρώτα στη ρίζα του πακέτου, και μετά στο dist/<file>. Οποιαδήποτε από τις δύο θέσεις ικανοποιεί το manifest, οπότε ένα πρόσθετο που χτίζεται με Vite (τα περισσότερα κάτω από το plugins/@xuda.io/) περιλαμβάνει τον πηγαίο κώδικα κάτω από το src/ και αφήνει το build του να γράψει τα αρχεία του manifest στο dist/.

Το CSS φορτώνεται μόνο από το dist

Το runtime.css (και κάθε άλλο CSS του manifest) λαμβάνεται υπόψη μόνο όταν το αντίστοιχο .mjs βρέθηκε κάτω από το dist/, ποτέ από τη ρίζα του πακέτου. Το runtime ελέγχει το manifest[resource].dist && manifest[resource].css πριν ανακτήσει το φύλλο στυλ, οπότε ένα πρόσθετο με runtime.mjs και style.css στη ρίζα περνά την επικύρωση (exist: true και στα δύο) αλλά το runtime δεν φορτώνει ποτέ το CSS. Δημοσιεύστε μέσω του dist/ αν το πρόσθετο χρειάζεται το φύλλο στυλ του να φορτώνεται πραγματικά.

Σε τι χρησιμεύει το manifest

  • Φόρτωση ενός πρόσθετου UI. Το runtime αρνείται να εκτελέσει ένα πρόσθετο UI εκτός αν το manifest δείχνει ότι υπάρχουν και τα δύο runtime.mjs και index.mjs: τότε εισάγει το index.mjs για τα properties, επιλύει την τιμή κάθε ιδιότητας (συμπεριλαμβανομένων των δεσμεύσεων έκφρασης xu-exp:) με βάση τα χαρακτηριστικά του στοιχείου, εισάγει το runtime.mjs και καλεί το fn.
  • Η οθόνη συναίνεσης εγκατάστασης. Η παρουσία στο manifest μετατρέπεται απευθείας στις προτάσεις που διαβάζει ένας χρήστης πριν εγκαταστήσει: η ύπαρξη του server.mjs λέει "Runs its own code on Xuda servers, inside your project": η ύπαρξη του runtime.mjs λέει "Runs its own code inside your published app, in the browser of everyone who uses it": τα studio.mjs και setup.mjs παίρνουν επίσης τις δικές τους γραμμές.
  • Το κουμπί Εγκατάσταση του πίνακα ελέγχου. Η οθόνη ρύθμισης ενός πρόσθετου εμφανίζεται μόνο όταν το manifest['index.mjs'].exist είναι true και η ενότητα δεν είναι κενή, ή το πρόσθετο έχει εξάρτηση με δική της ρύθμιση.