Gommit 项目使用教程

1. 项目目录结构及介绍

Gommit 项目的目录结构如下：

gommit/
├── cmd/
│   └── gommit/
│       └── main.go
├── features/
│   └── ...
├── reference/
│   └── ...
├── .gitignore
├── .golangci.yaml
├── .gommit.toml
├── .goreleaser.yaml
├── LICENSE
├── README.md
├── go.mod
├── go.sum
└── main.go

目录结构介绍

• cmd/: 包含 Gommit 的主要命令行工具的入口文件。
• features/: 包含项目的功能实现代码。
• reference/: 包含项目的参考文档或示例代码。
• .gitignore: Git 忽略文件配置。
• .golangci.yaml: GolangCI-Lint 配置文件。
• .gommit.toml: Gommit 的配置文件。
• .goreleaser.yaml: Goreleaser 配置文件，用于发布项目。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• go.mod: Go 模块依赖管理文件。
• go.sum: Go 模块依赖的校验和文件。
• main.go: 项目的启动文件。

2. 项目启动文件介绍

Gommit 项目的启动文件是 main.go，位于 cmd/gommit/main.go 和根目录下的 main.go。

cmd/gommit/main.go

这是 Gommit 命令行工具的入口文件，负责初始化命令行参数和启动 Gommit 的主要功能。

main.go

这是项目的根目录下的启动文件，通常用于项目的初始化和全局配置。

3. 项目配置文件介绍

Gommit 项目的主要配置文件是 .gommit.toml，位于项目的根目录下。

.gommit.toml

该文件定义了 Gommit 的配置选项，包括 Git 提交消息的格式检查规则、错误处理方式等。以下是一个示例配置文件：

# Gommit 配置文件示例
[commit]
pattern = "^(feat|fix|docs|style|refactor|perf|test|chore)(\\(.*\\))?: .+$"

配置文件介绍

• pattern: 定义了 Git 提交消息的正则表达式模式，用于检查提交消息是否符合规范。

通过以上配置，Gommit 可以确保每次提交的 Git 消息都符合预定义的格式要求。