Orbit - Golang模板化命令执行与文件生成库

Orbit 是一个用于基于模板运行命令和生成文件的 Go 库，它提供了一种灵活的方式来执行模板化的命令操作和文件生成。下面我将介绍 Orbit 的基本用法和示例代码。

安装 Orbit

go get github.com/gsoc2/orbit

基本概念

Orbit 主要提供两种功能：

1. 基于模板执行命令
2. 基于模板生成文件

示例代码

1. 基于模板执行命令

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/gsoc2/orbit"
)

func main() {
	// 创建新的 Orbit 实例
	o := orbit.New()

	// 定义模板数据
	data := map[string]interface{}{
		"Name":   "Alice",
		"Age":    30,
		"Action": "greet",
	}

	// 定义命令模板
	command := `echo "Hello {{.Name}}, you are {{.Age}} years old. This is a {{.Action}}."`

	// 执行模板化命令
	output, err := o.ExecuteCommand(command, data)
	if err != nil {
		log.Fatalf("Failed to execute command: %v", err)
	}

	fmt.Println("Command output:", output)
}

2. 基于模板生成文件

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/gsoc2/orbit"
)

func main() {
	// 创建新的 Orbit 实例
	o := orbit.New()

	// 定义模板数据
	data := map[string]interface{}{
		"Name":    "Bob",
		"Version": "1.0.0",
	}

	// 定义文件模板
	fileTemplate := `# Welcome to {{.Name}}'s Project

Version: {{.Version}}

This file was generated automatically by Orbit.
`

	// 生成文件
	err := o.GenerateFile("welcome.md", fileTemplate, data, 0644)
	if err != nil {
		log.Fatalf("Failed to generate file: %v", err)
	}

	fmt.Println("File generated successfully!")
}

3. 从文件加载模板

package main

import (
	"fmt"
	"log"

	"github.com/gsoc2/orbit"
)

func main() {
	o := orbit.New()

	data := map[string]interface{}{
		"ProjectName": "Orbit Demo",
		"Author":      "John Doe",
	}

	// 从文件加载模板并执行命令
	output, err := o.ExecuteCommandFromFile("command.tmpl", data)
	if err != nil {
		log.Fatalf("Error executing command from template: %v", err)
	}

	fmt.Println("Command output:", output)

	// 从文件加载模板并生成文件
	err = o.GenerateFileFromTemplate("output.txt", "template.tmpl", data, 0644)
	if err != nil {
		log.Fatalf("Error generating file from template: %v", err)
	}

	fmt.Println("File generated from template successfully!")
}

高级功能

自定义模板函数

package main

import (
	"fmt"
	"log"
	"strings"

	"github.com/gsoc2/orbit"
)

func main() {
	o := orbit.New()

	// 添加自定义模板函数
	o.AddTemplateFunc("toUpper", strings.ToUpper)
	o.AddTemplateFunc("toLower", strings.ToLower)

	data := map[string]interface{}{
		"Message": "Hello World",
	}

	command := `echo "{{toUpper .Message}} and {{toLower .Message}}"`

	output, err := o.ExecuteCommand(command, data)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(output)
}

批量处理

package main

import (
	"fmt"
	"log"

	"github.com/gsoc2/orbit"
)

func main() {
	o := orbit.New()

	items := []map[string]interface{}{
		{"Name": "Item1", "Value": 100},
		{"Name": "Item2", "Value": 200},
		{"Name": "Item3", "Value": 300},
	}

	for _, item := range items {
		output, err := o.ExecuteCommand(`echo "Processing {{.Name}} with value {{.Value}}"`, item)
		if err != nil {
			log.Printf("Error processing %s: %v", item["Name"], err)
			continue
		}
		fmt.Println(output)
	}
}

最佳实践

1. 模板管理：将常用模板存储在文件中，便于维护和重用
2. 错误处理：始终检查命令执行和文件生成的错误
3. 安全考虑：当处理用户提供的模板数据时，注意防范注入攻击
4. 日志记录：记录重要的模板渲染和命令执行操作

Orbit 提供了一种简洁的方式来处理模板化的命令执行和文件生成，特别适合需要动态生成配置或执行命令的自动化工具开发。