Об этом проекте

LiveDoc — это платформа живой документации, которая позволяет командам писать исполняемые спецификации, используя синтаксис Gherkin в стиле Given/When/Then, непосредственно в существующих тестовых фреймворках. Вместо ведения отдельных файлов с функциями, спецификации хранятся в тестовом коде и служат одновременно документацией. Что она предоставляет: - Поддержку синтаксиса Gherkin для Vitest (TypeScript/JavaScript) через @swedevtools/livedoc-vitest и для xUnit (.NET) через SweDevTools.LiveDoc.xUnit. - Веб-просмотрщик в реальном времени (@swedevtools/livedoc-viewer), отображающий результаты тестов по мере их выполнения, с опубликованным живым примером, ссылка на который есть в README. - Расширение для VS Code (livedoc-vscode), предлагающее сниппеты и форматирование для BDD-синтаксиса. - Таблицы данных и сценарии с примерами для тестирования на основе данных. - Фильтрацию по тегам для включения или исключения тестов по тегам. - Форматированный, цветной вывод в терминале для результатов тестов. Пути настройки: - TypeScript: установите vitest и @swedevtools/livedoc-vitest как dev-зависимости, затем импортируйте хелперы feature, scenario, given, when и then для структурирования тестов. - C#: добавьте пакет SweDevTools.LiveDoc.xUnit и наследуйте тестовые классы от FeatureTest, используя атрибуты [Feature] и [Scenario], а также методы Given/When/Then. - В README также описан процесс настройки с помощью ИИ, где ассистент по кодированию читает размещённое руководство по настройке и конфигурирует репозиторий, задавая вопросы о конфигурации по одному перед внесением изменений. Два рабочих пакета, @swedevtools/livedoc-schema и @swedevtools/livedoc-server, являются приватными и встроены в дистрибутив просмотрщика, а не публикуются отдельно. Проект лицензирован под MIT и требует Node.js 18+ и .NET 8.0 для соответствующих стеков.