Comet 项目启动与配置教程

1. 项目的目录结构及介绍

Comet 项目是一个简单的命令行工具，用于帮助用户使用约定式提交（Conventional Commits）与 Git 进行交互。项目的目录结构如下：

• .github/：存放与 GitHub 仓库相关的配置文件，如工作流（Workflows）等。
• .gitignore：定义 Git 忽略的文件和目录。
• .goreleaser.yml：GoReleaser 的配置文件，用于自动化发布版本。
• LICENSE：项目的许可文件，本项目采用 MIT 许可。
• README.md：项目的说明文件，包含项目的基本信息和使用方法。
• config.go：包含项目配置相关代码。
• demo.png：示例图片文件。
• git.go：包含与 Git 交互相关的代码。
• go.mod 和 go.sum：Go 项目的依赖管理文件。
• gui.go：图形用户界面相关的代码（如果有的话）。
• main.go：项目的入口文件，包含程序的主要逻辑。

2. 项目的启动文件介绍

main.go 是项目的启动文件，它包含了程序的入口点 main 函数。在这个文件中，定义了如何接收命令行参数，以及如何与 Git 交互来实现约定式提交。以下是 main.go 的主要功能：

• 解析命令行参数。
• 检查和加载配置文件。
• 与 Git 仓库交互，生成和提交符合约定式提交规范的 Commit。

3. 项目的配置文件介绍

项目的配置文件是 .comet.json，它允许用户自定义提交信息的选项。配置文件应该放在项目的根目录或者用户的家目录中。如果存在根目录下的配置文件，它将优先于家目录下的配置文件。

.comet.json 的内容格式如下：

{
  "signOffCommits": false,
  "prefixes": [
    {
      "title": "feat",
      "description": "一个新的特性"
    },
    {
      "title": "fix",
      "description": "一个 bug 修复"
    },
    {
      "title": "bug",
      "description": "引入一个 bug"
    }
  ]
}

在这个配置文件中：

• signOffCommits：布尔值，用于控制是否在提交信息中包含签名。
• prefixes：数组，定义了可用的前缀和对应的描述，这些前缀用于在提交信息中分类不同的提交类型。