Vai al contenuto
Verificata

Sviluppare e testare in locale

Una sandbox con anteprima live per i plugin UI e uno schema di test offline per i plugin library e dbs, entrambi eseguiti dalla cartella del plugin stesso.

Ogni cartella di plugin sotto plugins/@xuda.io/ si compila con Vite (npm run dev / npm run build dentro la directory del plugin stesso), e ogni tipo ha il proprio schema per provare il plugin prima di caricarlo da qualche parte.

Plugin UI: l'anteprima live di plugin-sandbox

@xuda.io/plugin-sandbox è un piccolo pacchetto che mostra un configuratore live per un plugin UI: un menu a tendina per ogni proprietà e un riquadro di anteprima che si aggiorna mentre le modifichi. Il file tests/index.html di un plugin UI lo collega direttamente al sorgente del plugin, senza alcun passaggio di build:

tests/index.html
import * as plugin from "../src/runtime.mjs";
import { properties } from "../src/index.mjs";
import { initializeUiPlugin } from "@xuda.io/plugin-sandbox";

initializeUiPlugin($("body")[0], plugin, properties, `<div>12 27 2024 8:30</div>`)

initializeUiPlugin(el, plugin, properties, previewHtml) accetta il modulo runtime, lo schema delle proprietà e l'HTML su cui provare in anteprima il plugin. Esegui npm run dev nella cartella del plugin (Vite serve tests/ come radice, secondo il vite.config.js del plugin) per aprirlo.

Plugin library e dbs: uno script di test offline

Un plugin il cui lavoro avviene in server.mjs si testa con un semplice script Node invece che con una sandbox nel browser. xuda-library-plugin-xlsx è lo schema da seguire: server.mjs esporta un oggetto internals con le sue funzioni pure (normalize_book, render_book, load_workbook, apply_operations, cell_value_of, ...), e tests/local.mjs importa { internals } e le esercita direttamente, senza drive, senza AI e senza connessione alla piattaforma:

run it
npm run test:local

che esegue node ./tests/local.mjs (vedi scripts.test:local nel package.json del plugin). Scrivere la logica da esercitare come export con nome in internals è ciò che lo rende possibile; un server.mjs che tiene tutto in funzioni locali non esportate non offre nulla che uno script di test possa chiamare.

plugin_tester/

plugin_tester/ nella radice del repository è un tester più vecchio: index.html avvia una pagina completa xuda-runtime-slim.js con markup _default/xu-single-page, e index.js è un runner di plugin basato su jQuery (func.UI.widgets, $(el), fields_ret = get_fields_data(...)) che chiama un'API di plugin ppi.xuda.io. La sua forma (jQuery, xu-single-page, un endpoint ppi.xuda.io, che cerca runtime/index.js invece di runtime.mjs) non corrisponde al manifest, ai tipi e alla firma runtime fn(plugin_name, element, properties) documentati nelle altre pagine di questa sezione, e nessuno dei plugin sotto plugins/@xuda.io/ lo richiama. Sembra precedere l'attuale flusso di plugin-sandbox, non essere il modo mantenuto per testare un plugin in locale.