使用golang-templates/seed快速创建GitHub项目模板

golang-templates/seed是一个用于快速生成Golang项目模板的工具，它可以帮助开发者快速初始化项目结构，遵循最佳实践。下面我将详细介绍如何使用这个工具。

安装

首先，你需要安装seed工具：

go install github.com/golang-templates/seed@latest

或者通过git克隆后编译：

git clone https://github.com/golang-templates/seed.git
cd seed
go build -o seed
mv seed /usr/local/bin/

基本使用

1. 创建新项目

seed new my-project

这将在当前目录下创建一个名为"my-project"的新项目，包含基本的Golang项目结构。

2. 项目结构

创建的项目通常包含以下结构：

my-project/
├── cmd/
│   └── main.go
├── internal/
│   └── app/
│       └── app.go
├── pkg/
├── go.mod
├── Makefile
├── README.md
└── .gitignore

3. 自定义模板

seed支持自定义模板。你可以创建一个模板目录，然后使用它：

seed new my-project --template=path/to/your/template

高级功能

1. 使用预定义模板

seed提供了一些预定义模板：

# 创建CLI应用模板
seed new my-cli --template=cli

# 创建Web服务模板
seed new my-web --template=web

# 创建微服务模板
seed new my-microservice --template=micro

2. 使用变量

你可以在模板中使用变量，创建时传入：

seed new my-project --author="Your Name" --email="your@email.com"

在模板文件中可以使用{{.Author}}和{{.Email}}引用这些变量。

示例代码

下面是一个简单的Golang程序，演示如何以编程方式使用seed库：

package main

import (
	"fmt"
	"log"

	"github.com/golang-templates/seed/pkg/generator"
)

func main() {
	// 初始化生成器配置
	config := generator.Config{
		ProjectName: "example-project",
		Template:    "web", // 使用web模板
		Variables: map[string]string{
			"Author":      "John Doe",
			"Email":       "john@example.com",
			"Description": "A sample web application",
		},
		OutputDir: "./output",
	}

	// 创建生成器实例
	gen, err := generator.New(config)
	if err != nil {
		log.Fatalf("Failed to create generator: %v", err)
	}

	// 生成项目
	if err := gen.Generate(); err != nil {
		log.Fatalf("Failed to generate project: %v", err)
	}

	fmt.Println("Project generated successfully at", config.OutputDir)
}

自定义模板开发

如果你想创建自己的模板，可以按照以下步骤：

1. 创建一个模板目录结构
2. 在模板文件中使用Go模板语法
3. 使用.seedignore文件指定哪些文件不需要处理

示例模板结构：

my-template/
├── {{.ProjectName}}.go
├── README.md.tmpl
└── .seedignore

在模板文件中可以使用以下变量：

• {{.ProjectName}} - 项目名称
• {{.Author}} - 作者名
• {{.Email}} - 作者邮箱
• {{.Description}} - 项目描述

集成到CI/CD

你可以在CI/CD流程中使用seed来初始化项目：

# GitHub Actions 示例
name: Initialize Project

on: [push]

jobs:
  init:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Install seed
      run: go install github.com/golang-templates/seed@latest
    - name: Initialize project
      run: seed new my-service --template=web

总结

golang-templates/seed是一个强大的工具，可以帮助你快速启动Golang项目，保持一致的代码结构和最佳实践。通过自定义模板，你可以为团队创建标准化项目结构，大大提高开发效率。