pre-commit 钩子工具技术文档

安装指南

安装 gem

首先，你需要安装 pre-commit gem。可以通过以下命令进行安装：

$ gem install pre-commit

使用 Bundler

如果你使用 Bundler 来管理依赖，可以在 Gemfile 中添加以下内容：

group :development do
  gem "pre-commit", require: false
  gem "rubocop", require: false
end

然后，运行以下命令来配置 pre-commit 使用 Bundler：

$ git config pre-commit.ruby "bundle exec ruby"

使用 RVM

如果你使用 RVM，需要将 pre-commit 安装到 default gemset 中：

$ rvm default do gem install pre-commit

或者，你可以配置 pre-commit 使用当前的 RVM gemset：

$ git config pre-commit.ruby "rvm `rvm current` do ruby"

项目使用说明

生成 pre-commit 钩子

在 Git 仓库中，运行以下命令生成一个 pre-commit 钩子：

$ pre-commit install

这将在 .git/hooks/pre-commit 中创建一个脚本，该脚本会检查你的 Git 配置并运行启用的检查。

运行检查

你可以手动运行检查，有以下几种方式：

• 运行所有已添加到索引的文件：

  $ pre-commit run
  

• 运行当前目录下的所有文件：

  $ pre-commit run all
  

• 运行所有 Git 跟踪的文件：

  $ pre-commit run git
  

• 运行指定文件列表：

  $ pre-commit run <file-list>
  

项目 API 使用文档

启用/禁用检查

你可以通过 Git 配置或 CLI 来启用或禁用检查。

Git 配置

通过以下命令启用或禁用检查：

$ git config pre-commit.checks "[whitespace, jshint, debugger]"

CLI 配置

通过 CLI 启用或禁用检查：

$ pre-commit <enable|disable> <git|yaml> <checks|warnings> check1 [check2...]

例如，将 jshint 从 checks 移动到 warnings：

$ pre-commit disable yaml checks jshint
$ pre-commit enable yaml warnings jshint

配置文件

pre-commit 支持多种配置文件，包括：

• default：基本设置，只读。
• git：从 git config pre-commit.* 读取配置，允许本地更新。
• yaml：从 /etc/pre_commit.yml、$HOME/.pre_commit.yml 和 config/pre_commit.yml 读取配置，允许更新 config/pre_commit.yml。
• env：从环境变量读取配置。

排除文件

你可以通过以下方式排除文件：

1. .gitignore：Git 支持的文件，适用于所有检出。
2. .git/info/exclude：Git 支持的文件，仅适用于当前检出。
3. .pre_commit.ignore：pre-commit 特定的列表，可以共享。

项目安装方式

直接安装

通过以下命令直接安装 pre-commit：

$ gem install pre-commit

使用 Bundler

在 Gemfile 中添加以下内容：

group :development do
  gem "pre-commit", require: false
  gem "rubocop", require: false
end

然后运行：

$ bundle install

使用 RVM

将 pre-commit 安装到 default gemset 中：

$ rvm default do gem install pre-commit

或者配置 pre-commit 使用当前的 RVM gemset：

$ git config pre-commit.ruby "rvm `rvm current` do ruby"

通过以上步骤，你可以成功安装并使用 pre-commit 钩子工具。