使用 insidieux/inizio 生成 Golang 项目布局

insidieux/inizio 是一个用于生成标准 Golang 项目布局的 CLI 工具，它可以帮助开发者快速初始化符合最佳实践的项目结构。

安装 inizio

可以通过以下方式安装 inizio：

# 使用 go install
go install github.com/insidieux/inizio@latest

# 或者下载预编译二进制
# 从 GitHub 发布页面下载适合你系统的版本

基本使用

1. 初始化新项目

inizio init --module github.com/yourname/projectname

这会创建一个标准的 Go 项目布局，包含以下目录结构：

.
├── cmd/
│   └── projectname/
│       └── main.go
├── internal/
│   └── app/
│       └── projectname/
│           └── run.go
├── pkg/
├── go.mod
├── Makefile
└── README.md

2. 自定义选项

inizio 提供了多个选项来自定义生成的项目结构：

inizio init \
  --module github.com/yourname/projectname \
  --with-docker \          # 添加 Docker 支持
  --with-gitlab-ci \       # 添加 GitLab CI 配置
  --with-github-actions \  # 添加 GitHub Actions 配置
  --with-logger \         # 添加日志支持
  --with-migrations \     # 添加数据库迁移支持
  --with-tracing \        # 添加分布式追踪支持
  --output ./myproject    # 指定输出目录

3. 添加子命令

对于 CLI 应用程序，可以添加子命令：

inizio add:command --name mycommand

这会在 cmd 目录下创建一个新的子命令。

高级用法

1. 使用配置文件

可以创建一个配置文件来保存常用配置：

# inizio.yaml
module: github.com/yourname/projectname
with:
  - docker
  - github-actions
  - logger
output: ./myproject

然后使用配置文件初始化项目：

inizio init --config inizio.yaml

2. 自定义模板

inizio 支持自定义模板。你可以创建自己的模板目录结构，然后使用：

inizio init --module github.com/yourname/projectname --template ./my-templates

示例代码

以下是一个使用 inizio 生成的典型 main.go 文件：

package main

import (
	"context"
	"os"
	"os/signal"
	"syscall"

	"github.com/yourname/projectname/internal/app/projectname"
	"github.com/sirupsen/logrus"
)

func main() {
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	logger := logrus.New()
	logger.SetFormatter(&logrus.JSONFormatter{})
	logger.SetOutput(os.Stdout)

	app, err := projectname.New(
		projectname.WithLogger(logger),
	)
	if err != nil {
		logger.WithError(err).Fatal("failed to initialize application")
	}

	go func() {
		sig := make(chan os.Signal, 1)
		signal.Notify(sig, syscall.SIGINT, syscall.SIGTERM)
		<-sig
		cancel()
	}()

	if err := app.Run(ctx); err != nil {
		logger.WithError(err).Fatal("application run failed")
	}
}

最佳实践

1. 保持简洁：开始时只添加你真正需要的组件
2. 逐步扩展：随着项目增长，可以添加更多功能
3. 版本控制：初始化后立即创建 git 仓库
4. 文档：更新生成的 README.md 以反映你的项目细节

inizio 是一个强大的工具，可以帮助你快速启动符合 Go 社区最佳实践的项目，同时保持灵活性以适应不同的项目需求。