Aller au contenu
Vérifié

Construire et tester en local

Un bac à sable d'aperçu en direct pour les plugins d'interface, et un modèle de test hors ligne pour les plugins library et dbs, tous deux lancés depuis le dossier du plugin.

Chaque dossier de plugin sous plugins/@xuda.io/ se construit avec Vite (npm run dev / npm run build dans le répertoire propre du plugin), et chaque type a son propre modèle pour essayer le plugin avant de l'envoyer où que ce soit.

Plugins d'interface : l'aperçu en direct du plugin-sandbox

@xuda.io/plugin-sandbox est un petit paquet qui affiche un configurateur en direct pour un plugin d'interface : une liste déroulante par propriété, et un panneau d'aperçu qui se redessine quand vous les modifiez. Le tests/index.html d'un plugin d'interface le branche directement sur la source du plugin lui-même, sans étape de construction :

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) prend le module runtime, le schéma de propriétés et le HTML sur lequel prévisualiser le plugin. Lancez npm run dev dans le dossier du plugin (Vite sert tests/ comme racine, selon le vite.config.js du plugin) pour l'ouvrir.

Plugins library et dbs : un script de test hors ligne

Un plugin dont le travail se fait dans server.mjs se teste avec un simple script Node plutôt qu'avec un bac à sable de navigateur. xuda-library-plugin-xlsx est le modèle à suivre : server.mjs exporte un objet internals avec ses fonctions pures (normalize_book, render_book, load_workbook, apply_operations, cell_value_of, ...), et tests/local.mjs importe { internals } et les exerce directement, sans Drive, sans IA, sans connexion à la plateforme :

run it
npm run test:local

ce qui exécute node ./tests/local.mjs (voir scripts.test:local dans le package.json du plugin). Écrire la logique exercée sous forme d'exports nommés sur internals est ce qui rend cela possible ; un server.mjs qui garde tout sous forme de fonctions locales non exportées n'offre rien qu'un script de test puisse appeler.

plugin_tester/

plugin_tester/ à la racine du dépôt est un ancien testeur : index.html démarre une page complète xuda-runtime-slim.js sur un balisage _default/xu-single-page, et index.js est un lanceur de plugin basé sur jQuery (func.UI.widgets, $(el), fields_ret = get_fields_data(...)) qui appelle une API de plugin ppi.xuda.io. Sa forme (jQuery, xu-single-page, un point d'accès ppi.xuda.io, la recherche de runtime/index.js plutôt que de runtime.mjs) ne correspond pas au manifeste, aux types ni à la signature runtime fn(plugin_name, element, properties) documentés sur les autres pages de cette section, et aucun des plugins sous plugins/@xuda.io/ n'y fait référence. Il semble antérieur au flux de travail actuel du plugin-sandbox plutôt que d'être la manière maintenue de tester un plugin en local.