Adicionando um módulo
As etapas são as mesmas para a plataforma base e para uma camada de produto.
- Crie o diretório por convenção:
para um serviço,modules/microservices/<domain>/ms-<name>para uma tela,modules/surfaces/<domain>/sf-<name>para um processo.modules/workflows/wf-<name> - Declare o contrato em
e gere os clientes commodules/types/<domain>/. O cliente aparece como um pacotebun run gen, utilizável no navegador, a partir de outro processo no barramento e de dentro de um fluxo de trabalho.g-<name> - Escreva o README com uma seção
e uma seção sobre o limite de responsabilidade. O primeiro parágrafo de cada uma acaba no registro do site — escreva para um leitor, não para você mesmo.## Purpose - Adicione o módulo a uma solução se ele não for distribuído sozinho: coloque seu nome curto em
e declare suas dependências.modules/solutions/solutions.json - Reconstrua a documentação:
na raiz do repositório. O módulo aparecerá no registro, e os contadores da página do ecossistema serão recalculados automaticamente.bun run build:doc
O que você não precisa fazer: editar listas de módulos nos dados do site, repetir a descrição na página inicial ou registrar o módulo em qualquer outro lugar. A geração ocorre em uma única direção — das fontes para os dados, nunca no sentido contrário. Tudo em é sobrescrito pela próxima compilação.data/
O que a revisão exige de um módulo: ele não acessa o armazenamento de outro módulo, não contorna o barramento com chamadas diretas, declara apenas as permissões que realmente utiliza e não amplia silenciosamente sua área de responsabilidade.