Sobre o projeto
LiveDoc é uma plataforma de documentação viva que permite às equipes escrever especificações executáveis usando sintaxe Gherkin estilo Dado/Quando/Então diretamente dentro de seus frameworks de teste existentes. Em vez de manter arquivos de feature separados, as especificações vivem no código de teste e funcionam como documentação.
O que oferece:
- Suporte a sintaxe Gherkin para Vitest (TypeScript/JavaScript) via @swedevtools/livedoc-vitest, e para xUnit (.NET) via SweDevTools.LiveDoc.xUnit.
- Um visualizador web em tempo real (@swedevtools/livedoc-viewer) que exibe resultados de testes conforme são executados, com um exemplo ao vivo publicado vinculado ao README.
- Uma extensão VS Code (livedoc-vscode) oferecendo snippets e formatação para a sintaxe BDD.
- Tabelas de dados e esboços de cenários para testes orientados a dados.
- Filtragem por tags para incluir ou excluir testes por tag.
- Saída de terminal formatada e colorida para resultados de testes.
Caminhos de configuração:
- TypeScript: instale vitest e @swedevtools/livedoc-vitest como dependências de desenvolvimento, depois importe os helpers feature, scenario, given, when e then para estruturar testes.
- C#: adicione o pacote SweDevTools.LiveDoc.xUnit e derive classes de teste de FeatureTest, usando atributos [Feature] e [Scenario] além de métodos Given/When/Then.
- O README também descreve um fluxo de configuração assistido por IA onde um assistente de codificação lê um guia de configuração hospedado e configura o repositório, fazendo perguntas de configuração uma de cada vez antes de fazer alterações.
Dois pacotes de workspace, @swedevtools/livedoc-schema e @swedevtools/livedoc-server, são privados e incorporados na distribuição do visualizador em vez de publicados independentemente. O projeto é licenciado sob MIT e requer Node.js 18+ e .NET 8.0 para as respectivas pilhas.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.