CaptainHook 项目教程

CaptainHook 项目教程

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

CaptainHook 项目的目录结构如下：

CaptainHook/
├── bin/
│   └── captainhook
├── src/
│   ├── App/
│   │   ├── Hook/
│   │   │   ├── Commit/
│   │   │   ├── Message/
│   │   │   └── ...
│   │   └── ...
│   └── ...
├── vendor/
│   └── ...
├── .gitignore
├── captainhook.json
├── composer.json
├── LICENSE
└── README.md

目录结构介绍

• bin/: 包含可执行文件 captainhook，用于管理 Git 钩子。
• src/: 项目的源代码目录，包含各种钩子处理逻辑。
  • App/Hook/: 包含不同类型的钩子处理逻辑，如 Commit、Message 等。
• vendor/: 第三方依赖库目录，由 Composer 管理。
• .gitignore: Git 忽略文件配置。
• captainhook.json: CaptainHook 的配置文件，定义了各种钩子的行为。
• composer.json: Composer 的配置文件，定义了项目的依赖关系。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档。

2. 项目的启动文件介绍

CaptainHook 项目的启动文件是 bin/captainhook。这个文件是一个可执行脚本，用于管理和执行 Git 钩子。

启动文件介绍

• bin/captainhook: 这是一个 PHP 脚本，用于启动 CaptainHook 的管理工具。它负责读取 captainhook.json 配置文件，并根据配置执行相应的钩子操作。

3. 项目的配置文件介绍

CaptainHook 的配置文件是 captainhook.json。这个文件定义了各种 Git 钩子的行为和操作。

配置文件介绍

{
  "commit-msg": {
    "enabled": true,
    "actions": [
      {
        "action": "\\CaptainHook\\App\\Hook\\Message\\Action\\Beams"
      }
    ]
  },
  "pre-commit": {
    "enabled": true,
    "actions": [
      {
        "action": "phpunit"
      },
      {
        "action": "phpcs --standard=psr2 src"
      }
    ]
  },
  "pre-push": {
    "enabled": false,
    "actions": []
  }
}

配置文件说明

• commit-msg: 定义了 commit-msg 钩子的行为。
  • enabled: 是否启用该钩子。
  • actions: 钩子执行的操作列表。
• pre-commit: 定义了 pre-commit 钩子的行为。
  • enabled: 是否启用该钩子。
  • actions: 钩子执行的操作列表。
• pre-push: 定义了 pre-push 钩子的行为。
  • enabled: 是否启用该钩子。
  • actions: 钩子执行的操作列表。

通过这个配置文件，开发者可以灵活地定义和管理 Git 钩子的行为，确保代码质量和提交规范。