Archify

Crie um diagrama HTML interativo a partir de JSON digitado.

Execute comandos a partir do seu diretório de trabalho. A menos que o usuário nomeie outro local, dê a cada nova solicitação de diagrama sua própria pasta .archify/<type>-<slug>-<YYYYMMDD-HHMMSS>/ lá (hora local, escolhida uma vez quando a solicitação começa): mantenha candidate.json e <slug>.html nela, defina meta.output para esse caminho HTML relativo ao diretório de trabalho e reutilize a pasta para todas as reexecuções de reparo. Uma solicitação posterior recebe uma nova pasta, para que as versões anteriores permaneçam intactas. Substitua bin/archify.mjs nos comandos abaixo pelo caminho absoluto do pacote instalado ou seu caminho relativo ao seu diretório de trabalho; os caminhos de entrada e saída são resolvidos a partir desse diretório de trabalho.

Para uma base de código real, leia Autoria de Repositório enquanto rastreia o comportamento solicitado. Uma descrição do sistema usa as etapas abaixo; um JSON existente usa o caminho de entrega.

Entrega de candidato existente

Quando o usuário fornecer um candidato congelado, execute finalize primeiro como uma única invocação de CLI. Seu recibo de aprovação completa os portões automatizados; siga qualquer recomendação de revisão visual sob Entrega antes de reivindicar a qualidade visual. Para reparo, siga a etapa 5.

finalize inclui uma verificação de atualização limitada em seu recibo de entrega; veja Consciência de atualização.

Caminho de autoria rápida

Use este caminho para geração comum. Leia as referências de branch apenas quando o gatilho declarado se aplicar.

1. Escolha architecture, workflow, sequence, dataflow, lifecycle, erd, class, tree, timeline ou waterfall da pergunta.
2. Use o esquema exato e os caminhos de exemplo no roteador de tipos sem listar seus diretórios. Leia Padrões de Autoria e o exemplo do modo em um lote limitado separado dos documentos do projeto e esquemas completos para que nenhum seja truncado; recupere qualquer seção ausente antes de escrever. Para Arquitetura, use o exemplo de showcase correspondente. Para todos os modos, exceto Arquitetura, leia também os esquemas do modo e comuns. Leia a definição de esquema relevante antes de escolher qualquer novo campo, enum ou texto restrito, especialmente tipos de limite. Exemplos ensinam forma, não fatos. Use IDs, redação e layout novos. Vá diretamente para o candidato sem ajuda preliminar, médico, validação inicial, diagramas temporários ou listagem de caminhos de saída. Consulte as marcas apenas para um símbolo explicitamente solicitado; leia Marcas de Marca para uma marca desconhecida com um URL fornecido pelo usuário.

…