Código abierto
Testdocs
Extrae bloques de código TypeScript de Markdown y los ejecuta como pruebas, manteniendo los ejemplos sincronizados con el código.
capturatestdocs.dev
Testdocsejemplos de documentación ejecutables
Qué es
Un banco de pruebas para la documentación. Extrae bloques de código TypeScript de archivos Markdown y los ejecuta como pruebas reales en Vitest o Jest, de modo que los ejemplos de un README pasan a formar parte de la suite de pruebas sin duplicar nada entre ambas.
Por qué existe
Los ejemplos de la documentación se pudren en silencio. Una API cambia, las pruebas se actualizan, y el README sigue enseñando la firma antigua hasta que alguien la copia y abre un bug. Ejecutar los ejemplos es la única forma de saber que siguen funcionando.
Nuestro papel
Lo mantenemos, y funciona sobre nuestra propia documentación — que es como los ejemplos de las otras páginas de proyecto se mantienen honestos.
Sobre qué lo construimos
Sitios estáticos y renderizados en el servidor funcionando cerca del usuario, y baratos de mantener.
Pruebas unitarias rápidas, HTTP grabado y documentación que hace fallar la compilación cuando se queda obsoleta.
Una sola cadena de herramientas en todos los repositorios, para que moverse entre ellos no cueste nada.
Ponerse en contacto
Cuéntenos qué necesita construir.
Somos un equipo pequeño en Portugal, en horario de Londres. Un sitio, una aplicación, una herramienta interna, o la plataforma que hay detrás — empiece por una frase sobre el problema y nosotros seguimos desde ahí.