使用gtree库通过Markdown生成目录树

gtree是一个Go语言库，用于根据Markdown格式的文本生成目录树结构并创建对应的文件和目录。下面我将详细介绍如何使用这个库。

基本概念

gtree的工作原理是解析Markdown格式的文本，将其中的层级结构转换为实际的目录和文件结构。Markdown中的列表项(-或*)会被解析为目录或文件。

安装gtree

首先安装gtree库：

go get github.com/ddddddO/gtree

基本用法

1. 从Markdown生成目录树

package main

import (
	"fmt"
	"strings"

	"github.com/ddddddO/gtree"
)

func main() {
	markdown := `
- root/
  - dir1/
    - file1.txt
    - file2.txt
  - dir2/
    - subdir/
      - file3.txt
    - file4.txt
  - README.md
`

	// 创建解析器
	parser := gtree.NewParser(strings.NewReader(markdown))
	
	// 生成目录树
	root, err := parser.Parse()
	if err != nil {
		panic(err)
	}

	// 打印目录树结构
	fmt.Println("Directory Tree:")
	gtree.ExecuteProgrammably(root, gtree.NewDebugger())
}

2. 实际创建目录和文件

func createDirectories() {
	markdown := `
- project/
  - src/
    - main.go
    - utils/
      - helper.go
  - pkg/
    - types.go
  - go.mod
  - README.md
`

	parser := gtree.NewParser(strings.NewReader(markdown))
	root, err := parser.Parse()
	if err != nil {
		panic(err)
	}

	// 在当前目录下创建目录结构
	creator := gtree.NewCreator(gtree.WithTargetRoot("."))
	if err := creator.Create(root); err != nil {
		panic(err)
	}
	
	fmt.Println("Directory structure created successfully!")
}

高级功能

1. 自定义文件内容

func createWithContent() {
	markdown := `
- app/
  - main.go // package main\n\nfunc main() {\n\tprintln("Hello, gtree!")\n}
  - config/
    - config.yaml // app:\n  name: gtree-demo\n  version: 1.0.0
`

	parser := gtree.NewParser(strings.NewReader(markdown))
	root, err := parser.Parse()
	if err != nil {
		panic(err)
	}

	creator := gtree.NewCreator(gtree.WithTargetRoot("."))
	if err := creator.Create(root); err != nil {
		panic(err)
	}
}

2. 从文件读取Markdown

func createFromFile() {
	file, err := os.Open("structure.md")
	if err != nil {
		panic(err)
	}
	defer file.Close()

	parser := gtree.NewParser(file)
	root, err := parser.Parse()
	if err != nil {
		panic(err)
	}

	creator := gtree.NewCreator(gtree.WithTargetRoot("project"))
	if err := creator.Create(root); err != nil {
		panic(err)
	}
}

3. 验证目录结构

func validateStructure() {
	markdown := `
- docs/
  - api.md
  - design.md
`

	parser := gtree.NewParser(strings.NewReader(markdown))
	root, err := parser.Parse()
	if err != nil {
		panic(err)
	}

	validator := gtree.NewValidator(gtree.WithTargetRoot("."))
	if err := validator.Validate(root); err != nil {
		fmt.Printf("Validation failed: %v\n", err)
	} else {
		fmt.Println("Directory structure is valid")
	}
}

实际应用示例

下面是一个完整的示例，演示如何创建一个Go项目结构：

package main

import (
	"os"
	"strings"

	"github.com/ddddddO/gtree"
)

func main() {
	projectStructure := `
- myapp/
  - cmd/
    - myapp/
      - main.go // package main\n\nimport "fmt"\n\nfunc main() {\n\tfmt.Println("Hello from gtree!")\n}
  - internal/
    - app/
      - app.go // package app\n\nfunc Run() {\n\tprintln("App is running")\n}
    - config/
      - config.go // package config
  - pkg/
    - utils/
      - helper.go // package utils
  - go.mod // module github.com/user/myapp\n\ngo 1.19
  - README.md // # MyApp\n\nA project created with gtree
`

	// 解析Markdown
	parser := gtree.NewParser(strings.NewReader(projectStructure))
	root, err := parser.Parse()
	if err != nil {
		panic(err)
	}

	// 创建项目目录
	creator := gtree.NewCreator(gtree.WithTargetRoot("."))
	if err := creator.Create(root); err != nil {
		panic(err)
	}

	// 验证创建结果
	validator := gtree.NewValidator(gtree.WithTargetRoot("myapp"))
	if err := validator.Validate(root); err != nil {
		panic(err)
	}

	println("Project structure created and validated successfully!")
}

总结

gtree库提供了一种便捷的方式来通过Markdown定义和生成目录结构，特别适合以下场景：

1. 快速创建项目脚手架
2. 自动化测试中的临时目录创建
3. 文档与实际目录结构的同步
4. 教学示例中的目录结构生成

通过Markdown定义目录结构既直观又可版本控制，gtree则将其转化为实际的目录和文件，大大提高了开发效率。