À propos du projet

LiveDoc est une plateforme de documentation vivante qui permet aux équipes d'écrire des spécifications exécutables en utilisant directement la syntaxe Given/When/Then de style Gherkin dans leurs frameworks de tests existants. Plutôt que de maintenir des fichiers de fonctionnalités séparés, les spécifications résident dans le code de test et servent également de documentation. Ce qu'elle fournit : - Prise en charge de la syntaxe Gherkin pour Vitest (TypeScript/JavaScript) via @swedevtools/livedoc-vitest, et pour xUnit (.NET) via SweDevTools.LiveDoc.xUnit. - Une visionneuse d'interface utilisateur web en temps réel (@swedevtools/livedoc-viewer) qui affiche les résultats des tests au fur et à mesure de leur exécution, avec un exemple en direct publié lié depuis le README. - Une extension VS Code (livedoc-vscode) offrant des extraits de code et une mise en forme pour la syntaxe BDD. - Tables de données et plans de scénarios pour les tests pilotés par les données. - Filtrage par tags pour inclure ou exclure des tests par tag. - Sortie de terminal formatée et colorée pour les résultats des tests. Parcours de configuration : - TypeScript : installez vitest et @swedevtools/livedoc-vitest comme dépendances de développement, puis importez les helpers feature, scenario, given, when et then pour structurer les tests. - C# : ajoutez le package SweDevTools.LiveDoc.xUnit et dérivez les classes de test de FeatureTest, en utilisant les attributs [Feature] et [Scenario] ainsi que les méthodes Given/When/Then. - Le README décrit également un flux de configuration assisté par IA où un assistant de codage lit un guide de configuration hébergé et configure le dépôt, posant des questions de configuration une par une avant d'apporter des modifications. Deux packages d'espace de travail, @swedevtools/livedoc-schema et @swedevtools/livedoc-server, sont privés et intégrés dans la distribution de la visionneuse plutôt que publiés indépendamment. Le projet est sous licence MIT et nécessite Node.js 18+ et .NET 8.0 pour les piles respectives.