Código aberto
Testdocs
Extrai blocos de código TypeScript de ficheiros Markdown e executa-os como testes, mantendo os exemplos sincronizados com o código.
capturatestdocs.dev
Testdocsexemplos de documentação executáveis
O que é
Um mecanismo de testes para documentação. Extrai blocos de código TypeScript de ficheiros Markdown e corre-os como testes reais em Vitest ou Jest, para que os exemplos de um README passem a fazer parte da suíte de testes sem duplicação entre as duas.
Por que existe
Os exemplos da documentação apodrecem em silêncio. Uma API muda, os testes são atualizados, e o README continua a demonstrar a assinatura antiga até alguém a copiar e abrir um bug. Correr os exemplos é a única forma de saber que ainda funcionam.
O nosso papel
Mantemo-lo, e ele corre sobre a nossa própria documentação — é assim que os exemplos nas outras páginas de projeto se mantêm honestos.
Em que o construímos
Sites estáticos e renderizados no servidor a correr perto do utilizador, e baratos de manter.
Testes unitários rápidos, HTTP gravado, e documentação que faz falhar a compilação quando fica desatualizada.
Uma só cadeia de ferramentas em todos os repositórios, para que mudar entre eles não custe nada.
Entre em contacto
Diga-nos o que precisa de construir.
Somos uma equipa pequena em Portugal, a trabalhar no horário de Londres. Um site, uma aplicação, uma ferramenta interna, ou a plataforma por trás deles — comece por uma frase sobre o problema e nós tratamos do resto.