embedded-struct-visualizer 使用教程

1. 项目的目录结构及介绍

embedded-struct-visualizer 是一个用于可视化 Go 项目中嵌入结构体关系的工具。以下是该项目的目录结构：

embedded-struct-visualizer/
├── README.md
├── go.mod
├── go.sum
├── main.go
├── options.go
├── parser.go
├── visualizer.go
└── ...

• README.md: 项目说明文档。
• go.mod 和 go.sum: Go 模块文件，用于管理依赖。
• main.go: 主程序入口文件。
• options.go: 命令行选项处理文件。
• parser.go: 解析 Go 代码文件。
• visualizer.go: 生成可视化图形的文件。

2. 项目的启动文件介绍

项目的启动文件是 main.go，它包含了程序的入口点。以下是 main.go 的主要内容：

package main

import (
    "flag"
    "log"
    "os"
    "github.com/davidschlachter/embedded-struct-visualizer/parser"
    "github.com/davidschlachter/embedded-struct-visualizer/visualizer"
)

func main() {
    var outputFile string
    var verbose bool
    flag.StringVar(&outputFile, "out", "", "path to output file (default: write to stdout)")
    flag.BoolVar(&verbose, "v", false, "verbose logging")
    flag.Parse()

    dirToScan := flag.Arg(0)
    if dirToScan == "" {
        dirToScan = "/"
    }

    log.Printf("Scanning directory: %s", dirToScan)
    parsedData, err := parser.ParseDirectory(dirToScan)
    if err != nil {
        log.Fatalf("Error parsing directory: %v", err)
    }

    err = visualizer.Visualize(parsedData, outputFile, verbose)
    if err != nil {
        log.Fatalf("Error visualizing data: %v", err)
    }
}

• main 函数是程序的入口点。
• 使用 flag 包处理命令行参数。
• 调用 parser.ParseDirectory 解析指定目录中的 Go 代码。
• 调用 visualizer.Visualize 生成可视化图形。

3. 项目的配置文件介绍

embedded-struct-visualizer 没有传统的配置文件，它主要通过命令行参数进行配置。以下是常用的命令行参数：

• -out <file>: 指定输出文件的路径（默认输出到标准输出）。
• -v: 启用详细日志记录。

例如，要扫描当前目录并生成可视化图形到 output.dot 文件，可以使用以下命令：

$ embedded-struct-visualizer -out output.dot .

这样，工具会扫描当前目录中的 Go 代码，并将生成的 DOT 文件输出到 output.dot。

---

以上是 embedded-struct-visualizer 项目的使用教程，包括项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该工具。