Skip to content
OpenAgentSkill
Browsing is open · Catalog captured 2026-11-21 · Automatic updates and account services are paused.
Design & UI

fluig-best-practices

Revisa a aderência de código de customização Fluig às boas práticas oficiais da plataforma (convenções de widget com SuperWidget, Custom Elements, i18n, uso do Style Guide, chamadas REST internas e ES6+) e produz achados classificados por severidade, cada um referenciando a regra do arquivo de contexto. Use quando o desenvolvedor pedir uma revisão de conformidade com os padrões Fluig de um trecho ou arquivo antes de merge, sem reescrever o código.

totvs · Static checks on file

Installation

Read the source and dependencies before running a command. Copying does not install or execute anything.

npx skills add totvs/fluig-agent-skills --skill fluig-best-practices

About this skill


name: fluig-best-practices description: Revisa a aderência de código de customização Fluig às boas práticas oficiais da plataforma (convenções de widget com SuperWidget, Custom Elements, i18n, uso do Style Guide, chamadas REST internas e ES6+) e produz achados classificados por severidade, cada um referenciando a regra do arquivo de contexto. Use quando o desenvolvedor pedir uma revisão de conformidade com os padrões Fluig de um trecho ou arquivo antes de merge, sem reescrever o código. argument-hint: o código/arquivo Fluig alvo da revisão de boas práticas (trecho ou arquivo selecionado), idealmente com o tipo de artefato

Revisão de Aderência às Boas Práticas do Fluig

Esta skill revisa a aderência do código às boas práticas oficiais do Fluig e emite achados por severidade; ela não duplica convenções — o arquivo de context/ é a fonte de verdade, referenciada abaixo. A skill não reescreve o código.

Objetivo

Revisar, com responsabilidade única, a aderência de código de customização Fluig às boas práticas oficiais da plataforma — convenções de widget, Custom Elements, i18n, uso do Style Guide, chamadas REST internas e ES6+ — produzindo um relatório de achados classificados por severidade, cada um vinculado à regra correspondente do arquivo de contexto.

Quando Usar

  • Antes de um merge, para verificar conformidade com os padrões oficiais do Fluig.
  • Quando há dúvida se o código segue as convenções de widget/Custom Element da plataforma.
  • Quando se quer garantir compatibilidade e manutenibilidade alinhadas ao padrão Fluig.
  • Como complemento às revisões especializadas (fluig-review-performance, fluig-review-security, fluig-review-accessibility).

Entradas Esperadas

EntradaDescriçãoObrigatória
Código alvoTrecho ou arquivo de customização a revisar (widget, Custom Element, .ftl, CSS)sim
Tipo de artefatoTipo em que o código roda (widget, layout, form)não
Foco solicitadoConvenções prioritárias da revisão, se houvernão

Contexto de Referência (Fonte de Verdade)

Leia antes de executar — não reproduza o conteúdo aqui:

  • conventions.md — ES6+, nomenclatura, convenções de widget (fluig-style-guide na raiz, instanceId só em id com _, instance() sem instanceId, bindings), Custom Elements, comunicação por eventos, i18n, segurança via APIs públicas, chamadas REST internas e CSS.
  • style-guide.md — componentes, grid, classes helper fs-* e variáveis CSS de tema (var(--fs-color-*), dark mode).

Regras Aplicáveis (Resumo Executivo)

Somente o mínimo para orientar a revisão; o detalhe está no contexto. Cada achado deve citar a regra de origem.

  • ES6+ para código novo: const/let, arrow functions, template literals, async/await; sem misturar jQuery e ES6+ no mesmo arquivo → ver conventions.md.
  • Convenções de widget: raiz com fluig-style-guide; instanceId apenas em id com _; instance() sem instanceId; bindings com chave sem o prefixo data- → ver conventions.md.
  • Custom Elements: nome de arquivo [name].[category].js; classe PascalCase; sem Shadow DOM; topo do arquivo só com import → ver conventions.md.
  • i18n: texto visível via ${i18n.getTranslation('chave')}; nunca acessar i18n como objeto JS → ver conventions.md.
  • Style Guide: reutilizar componentes/helpers/grid antes de criar CSS próprio; var(--fs-color-*) para cores de tema → ver conventions.md e style-guide.md.
  • REST interna: chamadas via WCMAPI/FLUIGC.ajax (nunca fetch/$.ajax direto) → ver conventions.md.
  • Nomenclatura: nomes descritivos em Inglês; booleanos com is/has/can/should → ver conventions.md.

Tabela de Anti-padrões de Widget

Instrumento rápido de revisão: identifique o anti-padrão no código e aplique a alternativa recomendada. A tabela não duplica a regra — cada item aponta para a regra-fonte completa em context/, que permanece a fonte de verdade.

❌ Anti-padrão✅ AlternativaRegra-fonte
Widget monolítico com responsabilidades misturadasModularizar em métodos/funções menores, com responsabilidade única; init() delega a métodos clarosconventions.md › JavaScript Moderno (ES6+)
Nomes vagos ou abreviações obscurasNomenclatura descritiva e consistente, em Inglês; booleanos com is/has/can/shouldconventions.md › Nomenclatura
Strings fixas sem i18n quando há chave disponívelResolver o texto via ${i18n.getTranslation('chave')} (e variantes getTranslationP1/getJSTranslation)conventions.md › Internacionalização (i18n)
Customização inline em HTML (style inline)Classe dedicada no CSS, escopada à raiz do widgetconventions.md › CSS
Seletor frágil com id, cadeia longa e !importantEscopo por classe da widget, com especificidade controladaconventions.md › CSS
Variáveis globais ou window.* para comunicação entre artefatosEventos: CustomEvent/dispatchEvent (Web Components) ou WCMAPI.fireEvent/addListener (widgets)conventions.md › Comunicação entre artefatos (eventos)
fetch()/$.ajax() direto a endpoint internoCliente público: FLUIGC.ajax (ES6+) ou WCMAPI.Read/Create/Update/Delete (legado)conventions.md › Chamadas REST internas
CSS customizado onde já existe helper/componente do Style GuideReutilizar componentes/helpers fs-*; cores de tema via var(--fs-color-*)style-guide.md › Classes helper fs-*

Escala de Severidade

Classifique cada achado em um destes níveis:

| Severidade | Critério | Exemplos típicos | |------

Read the complete source ↗