fluig-scaffolding-widget
Gera o esqueleto de um Widget WCM do Fluig usando SuperWidget.extend (view FreeMarker + JS com init() e bindings), aplicando as convenções oficiais de customização. Use quando o desenvolvedor pedir para criar/iniciar um novo widget client-side do Fluig a partir de um nome ou descrição de propósito.
totvs · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add totvs/fluig-agent-skills --skill fluig-scaffolding-widget技能说明
name: fluig-scaffolding-widget description: Gera o esqueleto de um Widget WCM do Fluig usando SuperWidget.extend (view FreeMarker + JS com init() e bindings), aplicando as convenções oficiais de customização. Use quando o desenvolvedor pedir para criar/iniciar um novo widget client-side do Fluig a partir de um nome ou descrição de propósito. argument-hint: 'nome e/ou propósito do widget a ser gerado (ex.: "widget de notificações")'
Scaffolding de Widget (SuperWidget)
Esta skill gera o esqueleto de um Widget WCM do Fluig; ela não duplica convenções — os arquivos de context/ são a fonte de verdade, referenciada abaixo.
Objetivo
Produzir, com responsabilidade única, o esqueleto de um Widget WCM do Fluig na estrutura oficial de pastas/arquivos: o descritor application.info, a view FreeMarker (view.ftl) com o elemento raiz correto, os arquivos .properties de i18n e o arquivo JavaScript com SuperWidget.extend, init() e bindings, já em conformidade com as convenções públicas e o Style Guide.
Quando Usar
- Ao criar um novo widget client-side do Fluig a partir do zero.
- Quando o desenvolvedor fornece um nome/propósito e quer um ponto de partida correto (view + JS) seguindo as convenções oficiais.
- Quando é preciso garantir, desde o início,
fluig-style-guidena raiz, uso correto deinstanceIde bindings declarativos.
Entradas Esperadas
| Entrada | Descrição | Obrigatória |
|---|---|---|
| Nome do widget | Identificador em Inglês (PascalCase) usado na classe e no id (ex.: Notifications) | sim |
| Propósito | O que o widget faz (orienta init, bindings e textos i18n) | não |
| Chaves i18n | Chaves de tradução para os textos visíveis | não |
Contexto de Referência (Fonte de Verdade)
Leia antes de executar — não reproduza o conteúdo aqui:
- conventions.md — convenções de Widget (
fluig-style-guide,instanceId,.instance(), bindings local/global), i18n, segurança, CSS escopado e ES6+. Inclui também as convenções de Custom Elements (arquivos[name].[category].js, membros privados#, topo do módulo só comimport, CSS escopado/agrupado por tag e variáveis CSS para números mágicos), aplicáveis quando o widget incorpora Web Components. - style-guide.md — componentes/helpers (
FLUIGC), grid e variáveis CSS de tema (var(--fs-color-*)) para o markup e o estilo do widget. - architecture.md — modelo conceitual do Widget, seu ciclo de vida (
init(),.instance(), bindings) e a estrutura oficial de pastas/arquivos do widget (descritorapplication.info,view.ftl,.propertiesde i18n, JS/CSS).
Estrutura de Saída
O widget gerado segue a estrutura oficial (fonte de verdade em architecture.md).
O descritor application.info é obrigatório — sem ele a plataforma não
reconhece o widget. Use <code> como o código do widget (minúsculo).
<widget>/
├── pom.xml # quando o projeto usa Maven ou sob pedido
└── src/main/
├── resources/
│ ├── application.info # descritor (application.type=widget)
│ ├── <code>.properties # i18n base (chaves de getTranslation)
│ ├── <code>_pt_BR.properties # i18n pt-BR
│ ├── <code>_en_US.properties # i18n en-US
│ ├── <code>_es.properties # i18n es
│ ├── view.ftl # view principal (elemento raiz)
│ └── edit.ftl # view de edição (pode ser vazia, mas é obrigatória)
└── webapp/
├── WEB-INF/{web.xml, jboss-web.xml}
└── resources/
├── css/<code>.css # CSS escopado (opcional)
├── images/icon.png # ícone
└── js/<code>.js # SuperWidget.extend
A
view.ftle aedit.ftlficam emsrc/main/resources/; o<code>.jse o<code>.cssemsrc/main/webapp/resources/. Opom.xmlsó é gerado quando o projeto usa Maven ou sob pedido. Ponto de partida público: archetype Mavenwidget-wcm.Em um projeto Fluig Studio, o widget fica em
wcm/widget/<nome>(ver a seção "Estrutura de um Projeto Fluig Studio" emarchitecture.md).
pom.xml (quando o projeto usa Maven ou sob pedido)
Quando for necessário gerar o pom.xml, use a estrutura abaixo como ponto de
partida — ajustando groupId/artifactId/version/name/description ao
artefato. O empacotamento é war e o finalName usa ${project.artifactId}. A
referência canônica completa está em architecture.md.
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.fluig</groupId>
<version>1.0.0</version>
<artifactId>widget-<code></artifactId>
<packaging>war</packaging>
<name>Widget <Nome></name>
<description>Widget <Nome></description>
<build>
<finalName>${project.artifactId}</finalName>
</build>
</project>
Dentro de um projeto existente, inspecione o
pom.xmldo módulo pai para obter as coordenadas reais (parentgroupId/artifactId); nunca invente coordenadas.
Regras Aplicáveis (Resumo Executivo)
Somente o mínimo para orientar a geração; o detalhe está no contexto:
application.codedeve ser igual alocale.file.base.name— divergência quebra a i18n (regra crítica) → verarchitecture.md.- Elemento raiz deve conter as 3 classes obrigatórias fixas:
fluig-style-guide,super-widgetewcm-widget-class, além da classe específica do widget → verconventions.md. instanceIdsó em atributosid, com exatamente um_como separador; nadivraiz, a parte antes do_em **camelC