技术文档：Git Pre-Commit Hook 项目使用指南

1. 安装指南

本项目包含两个Git pre-commit钩子脚本的安装和使用方法。首先，请确保您的系统中已经安装了Git和Go语言环境。

1.1 单个仓库安装

1. 将fmt-check或fmt-fix脚本复制到您的Git仓库的.git/hooks/pre-commit目录下。

2. 为复制的脚本文件添加执行权限：

   chmod +x .git/hooks/pre-commit
   

1.2 创建全局Git别名

您可以通过以下命令创建一个全局的Git别名gofmt，以便格式化所有修改过的.go文件：

git config --global alias.gofmt '!echo $(git diff --cached --name-only --diff-filter=ACM | grep '.go$') | xargs gofmt -w -l | xargs git add'

之后，您可以通过运行以下命令来格式化所有修改过的.go文件：

git gofmt

2. 项目的使用说明

本项目提供了两个脚本，fmt-check和fmt-fix，用于在提交前检查和自动格式化Go文件。

2.1 fmt-check 脚本

fmt-check脚本会检查所有修改过的.go文件，如果需要运行gofmt进行格式化，则会阻止提交。

2.2 fmt-fix 脚本

fmt-fix脚本会在提交前自动运行gofmt格式化所有修改过的.go文件。

请注意，这两个脚本不应同时使用。您应选择其中一个来满足您的需求。

3. 项目API使用文档

本项目不直接提供API，因为它是作为Git钩子脚本来使用的。但是，以下是脚本内部的一些关键函数和操作：

• git diff --cached：检查暂存的变更。
• grep '.go$'：筛选出所有.go文件。
• xargs gofmt -w -l：对筛选出的文件执行gofmt格式化，并显示格式化后的文件列表。
• xargs git add：将格式化后的文件添加回暂存区。

4. 项目安装方式

请参考上述“安装指南”部分的内容，按照步骤进行安装。

通过以上文档，用户可以详细了解如何安装和使用本项目提供的Git pre-commit钩子脚本，以确保Go文件的格式化符合规范。