Draft 项目教程

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

Draft 项目的目录结构如下：

draft/
├── assets/
├── cmd/
├── examples/
├── pkg/
├── statik/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── cli-output.png
├── config.go
├── config_test.go
├── draft.go
├── draft_test.go
├── go.mod
├── icon.go
├── icon_test.go
├── impl.go
├── impl_test.go
├── kinds.go
├── kinds_test.go

目录介绍：

• assets/: 存放项目所需的静态资源文件。
• cmd/: 包含项目的命令行工具的源代码。
• examples/: 包含项目的示例文件，展示了如何使用 Draft 生成云架构图。
• pkg/: 存放项目的包文件，通常包含项目的核心功能实现。
• statik/: 存放静态文件的生成代码。
• .gitignore: Git 忽略文件列表。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• cli-output.png: 命令行工具的输出示例图片。
• config.go: 配置文件的 Go 源代码。
• config_test.go: 配置文件的测试代码。
• draft.go: Draft 工具的核心功能实现。
• draft_test.go: Draft 工具的测试代码。
• go.mod: Go 模块文件，定义了项目的依赖关系。
• icon.go: 图标相关的 Go 源代码。
• icon_test.go: 图标相关的测试代码。
• impl.go: 实现相关的 Go 源代码。
• impl_test.go: 实现相关的测试代码。
• kinds.go: 组件类型相关的 Go 源代码。
• kinds_test.go: 组件类型相关的测试代码。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/ 目录下。主要的启动文件是 draft.go，它包含了 Draft 工具的入口函数 main()。

启动文件介绍：

• draft.go: 这是 Draft 工具的入口文件，包含了 main() 函数，负责初始化并启动 Draft 工具。

package main

import (
    "os"
    "github.com/lucasepe/draft/cmd"
)

func main() {
    if err := cmd.Execute(); err != nil {
        os.Exit(1)
    }
}

3. 项目的配置文件介绍

Draft 项目的配置文件是通过 YAML 文件来定义的。用户可以通过编写 YAML 文件来描述云架构图的结构和组件。

配置文件示例：

components:
  - name: Web Application
    kind: service
    provider: aws
    label: "Web App"
    outline: frontend
  - name: Database
    kind: database
    provider: aws
    label: "RDS"
    outline: backend

connections:
  - origin: Web Application
    targets:
      - id: Database
        label: "Read/Write"

配置文件介绍：

• components: 定义云架构图中的各个组件，包括组件的名称、类型、提供商、标签等信息。
• connections: 定义组件之间的连接关系，包括源组件和目标组件的 ID、标签、颜色等信息。

通过编写这样的 YAML 配置文件，用户可以生成高层次的云架构图。