Composer怎么安装Captain Hook_Composer如何引入captainhook管理Git钩子配置【教程】

胖涛吖_6275

胖涛吖_6275

2026-04-07

897人浏览

原创

Composer 仅用于安装 captainhook/captainhook 包,CaptainHook 需手动初始化配置、启用钩子、配置 Git hooks 脚本并验证执行;默认配置全禁用,须编辑 captainhook.json 启用如 pre-commit 并确保 .git/hooks/ 下脚本存在且可执行。

composer怎么安装captain hook_composer如何引入captainhook管理git钩子配置【教程】

Composer 本身不提供 CaptainHook,它只是用来安装和管理 PHP 包的工具;CaptainHook 是一个独立的 Git 钩子管理器,需通过 Composer 安装其 PHP 包,并配合本地 Git 配置才能生效。

用 Composer 安装 captainhook/captainhook

直接运行以下命令即可把 captainhook/captainhook 作为开发依赖加入项目:

composer require --dev captainhook/captainhook

注意两点:

  • --dev 是必须的,因为 Git 钩子只在开发环境运行,不应进入生产依赖
  • 安装后,二进制文件会出现在 vendor/bin/captainhook,不是全局命令,不能直接敲 captainhook —— 后续要用相对路径或配置 $PATH
  • 如果项目已禁用脚本执行(如 composer.json 中 "scripts": {} 为空或被清空),captainhook 的自动初始化可能跳过,需手动触发

初始化 captainhook 配置文件(captainhook.json)

安装完不等于能用,必须生成配置文件。运行:

vendor/bin/captainhook init

它会创建默认的 captainhook.json,但这个默认配置是“全关闭”状态:所有钩子都设为 "enabled": false。常见误操作是以为装完就能拦截 commit,结果毫无反应——其实是没启用任何 hook。

你需要手动编辑 captainhook.json,例如启用 pre-commit 并绑定一个 PHP 脚本:

{
  "hooks": {
    "pre-commit": {
      "enabled": true,
      "commands": [
        {
          "command": "php ./scripts/check-staged.php"
        }
      ]
    }
  }
}

注意:

Workflow Decomposer
Workflow Decomposer

工作流任务拆解与模型编排技能。使用场景:(1) 收到复杂工作任务需要拆解为可执行步骤,(2) 需要为不同步骤选择最合适的模型,(3) 需要跟踪工作流进度和模型使用情况,(4) 长时间任务卡住需要问题诊断和解决方案。

下载
  • commands 数组里每个 command 字段是 shell 命令字符串,不是函数调用,路径必须可被 Git 进程访问(推荐用相对项目根目录的路径)
  • 不要写成 php scripts/check-staged.php(缺 ./),否则在某些 Git 环境下会找不到文件
  • 配置文件必须放在项目根目录,且文件名严格为 captainhook.json(大小写敏感)

让 Git 知道该用 captainhook 处理钩子

CaptainHook 不会自动改写 .git/hooks/ 下的脚本,它靠 Composer 脚本 + Git 模板机制联动。最可靠的方式是:在 composer.json 的 scripts 中注册 post-install-cmd 和 post-update-cmd:

"scripts": {
  "post-install-cmd": ["CaptainHook\Composer\Installer::createHooks"],
  "post-update-cmd": ["CaptainHook\Composer\Installer::createHooks"]
}

这样每次 composer install 或 update,都会自动在 .git/hooks/ 下生成对应 shell 包装器(如 pre-commit 文件),内容是调用 vendor/bin/captainhook 并传入当前钩子名。

容易忽略的点:

  • 如果之前手动写过 .git/hooks/pre-commit,它会被 CaptainHook 的 installer 覆盖——这是设计行为,不是 bug
  • Windows 用户要注意:Git for Windows 默认用 MSYS2 shell,而 captainhook 生成的 hook 脚本是 bash 风格,一般能跑;但如果启用了 Windows Subsystem for Linux(WSL),Git CLI 可能走不同环境,导致 hook 不触发
  • CI 环境(如 GitHub Actions)通常不执行 Git 钩子,所以 pre-commit 类钩子在那里不会运行,别指望它替代 CI 检查

验证 hook 是否真在工作

光看配置和文件存在不够,得实测。最简单的验证方式:

  • 临时在 captainhook.json 的 pre-commit 下加一条 echo 命令:"command": "echo 'HOOK FIRED!'; exit 1"
  • 然后执行 git add . && git commit -m "test"
  • 如果看到 HOOK FIRED! 并且提交被中止(因为 exit 1),说明链路通了

如果没反应,优先检查三处:

  • .git/hooks/pre-commit 文件是否存在、是否可执行(chmod +x)
  • 该文件内容第一行是不是 #!/usr/bin/env php 或类似 shell shebang(正常应是 #!/bin/sh 开头)
  • 运行 git config core.hooksPath,确认没指向其他自定义钩子路径,否则 .git/hooks/ 被忽略

配置生效后,captainhook 的实际执行逻辑藏在 vendor/bin/captainhook 里,它会读取 captainhook.json、解析当前 Git 事件、按顺序执行 commands。整个过程不依赖全局安装,但极度依赖项目级路径和权限设置——这也是多人协作时最容易出问题的地方。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

composer

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.12.25

344

5

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

2026.04.10

603

36

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

2026.04.10

347

29

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

2026.04.10

369

15

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

2026.04.13

320

21

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

2026.04.13

503

14

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

2026.04.14

311

24

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

2026.04.14

370

18

Composer 私有仓库搭建与企业级管理
Composer 私有仓库搭建与企业级管理

面向团队与企业开发场景,讲解如何使用 Satis 搭建轻量级静态私有仓库、通过 Toran Proxy / Private Packagist 构建功能完善的企业级私有包管理平台,涵盖 Git/SVN 仓库类型接入、Token 鉴权与访问权限控制、Webhook 自动触发包更新、内网部署方案以及与 GitLab CI/CD 流水线的集成配置,帮助企业安全高效地管理内部 PHP 组件资产。

2026.04.14

420

26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习