Sobre el proyecto
LiveDoc es una plataforma de documentación viva que permite a los equipos escribir especificaciones ejecutables usando sintaxis Given/When/Then estilo Gherkin directamente dentro de sus frameworks de pruebas existentes. En lugar de mantener archivos de características separados, las especificaciones residen en el código de pruebas y sirven como documentación.
Qué proporciona:
- Soporte de sintaxis Gherkin para Vitest (TypeScript/JavaScript) mediante @swedevtools/livedoc-vitest, y para xUnit (.NET) mediante SweDevTools.LiveDoc.xUnit.
- Una interfaz de usuario web en tiempo real (@swedevtools/livedoc-viewer) que muestra los resultados de las pruebas a medida que se ejecutan, con un ejemplo en vivo publicado enlazado desde el README.
- Una extensión de VS Code (livedoc-vscode) que ofrece fragmentos de código y formato para la sintaxis BDD.
- Tablas de datos y esquemas de escenarios para pruebas basadas en datos.
- Filtrado por etiquetas para incluir o excluir pruebas según la etiqueta.
- Salida de terminal formateada y coloreada para los resultados de las pruebas.
Rutas de configuración:
- TypeScript: instale vitest y @swedevtools/livedoc-vitest como dependencias de desarrollo, luego importe los helpers feature, scenario, given, when y then para estructurar las pruebas.
- C#: agregue el paquete SweDevTools.LiveDoc.xUnit y derive las clases de prueba de FeatureTest, usando atributos [Feature] y [Scenario] además de métodos Given/When/Then.
- El README también describe un flujo de configuración asistida por IA donde un asistente de codificación lee una guía de configuración alojada y configura el repositorio, haciendo preguntas de configuración una a la vez antes de realizar cambios.
Dos paquetes de workspace, @swedevtools/livedoc-schema y @swedevtools/livedoc-server, son privados y están incrustados en la distribución del visor en lugar de publicarse de forma independiente. El proyecto tiene licencia MIT y requiere Node.js 18+ y .NET 8.0 para las pilas respectivas.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.