GoTestDox 使用教程
1. 项目的目录结构及介绍
GoTestDox 是一个用于将 Go 测试结果格式化为可读文档的命令行工具。以下是项目的目录结构及其介绍:
gotestdox/
├── cmd/
│ └── gotestdox/
│ └── main.go # 主程序入口
├── img/
│ └── ... # 图片资源
├── testdata/
│ └── ... # 测试数据
├── .gitattributes # Git 属性配置
├── .gitignore # Git 忽略文件配置
├── LICENSE # 许可证文件
├── README.md # 项目说明文档
├── demo_tape.go # 示例代码
├── fuzz_test.go # 模糊测试代码
├── go.mod # Go 模块文件
├── go.sum # Go 模块校验和
├── gotestdox.go # 主逻辑代码
├── gotestdox_test.go # 测试代码
├── prettifier.go # 格式化工具代码
└── prettifier_test.go # 格式化工具测试代码
2. 项目的启动文件介绍
项目的启动文件位于 cmd/gotestdox/main.go
。该文件是 GoTestDox 的主程序入口,负责初始化和启动整个应用程序。
package main
import (
"os"
"github.com/bitfield/gotestdox/cmd/gotestdox"
)
func main() {
os.Exit(gotestdox.Run())
}
3. 项目的配置文件介绍
GoTestDox 项目没有传统的配置文件,其行为主要通过命令行参数和环境变量来控制。以下是一些常用的命令行参数:
go test -json | gotestdox
:将go test -json
的输出通过管道传递给gotestdox
进行处理。gotestdox
:直接运行测试并格式化输出。
此外,GoTestDox 还支持一些高级用法,例如:
- Exit Status:如果有测试失败,
gotestdox
会打印失败测试的输出信息并返回状态码 1。 - Colour:使用彩色输出,通过 ✔ 和 x 分别表示通过和失败的测试。
通过这些命令行参数和高级用法,用户可以灵活地使用 GoTestDox 来格式化 Go 测试结果。