Saltar para o conteúdo
Verificado

Criar e testar localmente

Uma sandbox de pré-visualização em direto para plugins de interface e um padrão de teste offline para plugins de biblioteca e dbs, ambos executados a partir da pasta do próprio plugin.

Todas as pastas de plugins em plugins/@xuda.io/ são construídas com o Vite (npm run dev / npm run build dentro do diretório do próprio plugin), e cada tipo tem o seu próprio padrão para experimentar o plugin antes de ser carregado seja onde for.

Plugins de interface: a pré-visualização em direto do plugin-sandbox

@xuda.io/plugin-sandbox é um pequeno pacote que apresenta um configurador em direto para um plugin de interface: um menu pendente por propriedade e um painel de pré-visualização que se volta a desenhar à medida que as altera. O tests/index.html de um plugin de interface liga-o diretamente ao código-fonte do próprio plugin, sem passo de compilação:

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) recebe o módulo de runtime, o esquema de propriedades e o HTML contra o qual pré-visualizar o plugin. Execute npm run dev na pasta do plugin (o Vite serve tests/ como raiz, conforme o vite.config.js do plugin) para o abrir.

Plugins de biblioteca e dbs: um script de teste offline

Um plugin cujo trabalho acontece em server.mjs testa-se a si próprio com um simples script Node e não com uma sandbox de navegador. xuda-library-plugin-xlsx é o padrão a seguir: server.mjs exporta um objeto internals com as suas funções puras (normalize_book, render_book, load_workbook, apply_operations, cell_value_of, ...), e tests/local.mjs importa { internals } e exercita-as diretamente, sem drive, sem IA, sem ligação à plataforma:

run it
npm run test:local

o que executa node ./tests/local.mjs (ver scripts.test:local no package.json do plugin). Escrever a lógica exercitada como exportações com nome em internals é o que torna isto possível; um server.mjs que mantém tudo como funções locais não exportadas não tem nada que um script de teste possa chamar.

plugin_tester/

plugin_tester/ na raiz do repositório é um testador mais antigo: index.html arranca uma página completa xuda-runtime-slim.js com marcação _default/xu-single-page, e index.js é um executor de plugins baseado em jQuery (func.UI.widgets, $(el), fields_ret = get_fields_data(...)) que chama uma API de plugins ppi.xuda.io. A sua forma (jQuery, xu-single-page, um endpoint ppi.xuda.io, a procurar runtime/index.js em vez de runtime.mjs) não corresponde ao manifesto, aos tipos e à assinatura de runtime fn(plugin_name, element, properties) documentados nas outras páginas desta secção, e nenhum dos plugins em plugins/@xuda.io/ o referencia. Parece anterior ao fluxo atual do plugin-sandbox em vez de ser a forma mantida de testar um plugin localmente.