这个项目能做什么
LiveDoc是一个活文档平台,允许团队在现有测试框架内直接使用Gherkin风格的Given/When/Then语法编写可执行规范。无需维护单独的特性文件,规范直接存在于测试代码中,并兼作文档。
它提供的内容包括:
- 通过@swedevtools/livedoc-vitest为Vitest(TypeScript/JavaScript)提供Gherkin语法支持,并通过SweDevTools.LiveDoc.xUnit为xUnit(.NET)提供支持。
- 一个实时网页UI查看器(@swedevtools/livedoc-viewer),在测试运行时显示测试结果,README中链接了一个已发布的实时示例。
- 一个VS Code扩展(livedoc-vscode),为BDD语法提供代码片段和格式化功能。
- 支持数据表格和场景大纲,用于数据驱动测试。
- 标签过滤功能,可按标签包含或排除测试。
- 格式化、带颜色的终端输出,用于显示测试结果。
设置路径:
- TypeScript:将vitest和@swedevtools/livedoc-vitest安装为开发依赖,然后导入feature、scenario、given、when和then辅助函数来组织测试。
- C#:添加SweDevTools.LiveDoc.xUnit包,并从FeatureTest派生测试类,使用[Feature]和[Scenario]属性以及Given/When/Then方法。
- README还描述了一种AI辅助设置流程,编码助手读取托管的设置指南并配置仓库,在做出更改前逐个询问配置问题。
两个工作区包,@swedevtools/livedoc-schema和@swedevtools/livedoc-server,是私有的,嵌入在查看器分发版中,而非独立发布。该项目采用MIT许可证,分别需要Node.js 18+和.NET 8.0。
评论
0 评分人数达到10人后显示
登录后参与讨论。